NotificationRenderer.php 5.8 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\ReleaseNotification\Ui\Renderer;

use Magento\Framework\Escaper;

/**
 * Builds the HTML for the release notification modals
 */
class NotificationRenderer
{
    /**
     * @var Escaper
     */
    private $escaper;

    /**
     * @param Escaper $escaper
     */
    public function __construct(
        Escaper $escaper
    ) {
        $this->escaper = $escaper;
    }

    /**
     * Returns the HTML for notification's title to the ui component
     *
     * @param array $page
     * @return string
     */
    public function getNotificationTitle(array $page)
    {
        $title = $this->escaper->escapeHtml($page['mainContent']['title']);
        $imageUrl = $this->escaper->escapeUrl($page['mainContent']['imageUrl']);
        $content = "";

        if (!empty($imageUrl)) {
            $content .= "<div class='release-notification-title-with-image' style='background-image: url(\"" . $imageUrl
                . "\")'>";
            $content .= $title;
            $content .= "</div>";
        } else {
            $content = $title;
        }

        return $content;
    }

    /**
     * Returns the HTML for the content in the notification ui component
     *
     * @param array $page
     * @return string
     */
    public function getNotificationContent(array $page)
    {
        $content = $this->buildMainContent($page['mainContent']);
        $content .= $this->buildSubHeadings($page['subHeading']);
        $content .= $this->buildFooter($page['footer']);

        return $content;
    }

    /**
     * Builds the HTML for the main content in the notification ui component
     *
     * @param array $mainContent
     * @return string
     */
    private function buildMainContent(array $mainContent)
    {
        $content = $this->buildContentTextAreas($mainContent['content']);
        $content .= $this->buildLists($mainContent['lists']);

        return $this->formatContentWithLinks($content);
    }

    /**
     * Builds the HTML for the main text areas in the notification ui component
     *
     * @param array $contentAreas
     * @return string
     */
    private function buildContentTextAreas(array $contentAreas)
    {
        $content = "";
        $lastContentArea = end($contentAreas);

        foreach ($contentAreas as $contentArea) {
            $content .= "<p>";
            $content .= $this->escaper->escapeHtml($contentArea['text']);
            $content .= "</p>";
            if ($contentArea != $lastContentArea) {
                $content .= "<br />";
            }
        }

        return $content;
    }

    /**
     * Builds the HTML for the bullet list content in the notification ui component
     *
     * @param array $lists
     * @return string
     */
    private function buildLists(array $lists)
    {
        $content = "<ul>";

        foreach ($lists as $listItem) {
            $content .= "<li><span>";
            $content .= $this->escaper->escapeHtml($listItem['text']);
            $content .= "</span></li>";
        }

        $content .= "</ul>";

        return $content;
    }

    /**
     * Builds the HTML for the highlighted sub heads for the overview page in the notification ui component
     *
     * @param array $subHeadings
     * @return string
     */
    private function buildSubHeadings(array $subHeadings)
    {
        $content = "";

        foreach ($subHeadings as $subHeading) {
            if (!empty($subHeading['imageUrl'])) {
                $content .= "<div class='highlight-item' style='background-image: url(\""
                    . $this->escaper->escapeUrl($subHeading['imageUrl']) . "\")'>";
            } else {
                $content .= "<div class='highlight-item-no-image'>";
            }

            $content .= "<h3>";
            $content .= $this->escaper->escapeHtml($subHeading['title']);
            $content .= "</h3>";
            $content .= "<p>";
            $content .= $this->formatContentWithLinks($subHeading['content']);
            $content .= "</p>";
            $content .= "</div>";
        }

        return $content;
    }

    /**
     * Builds the HTML for the footer content in the notification ui component
     *
     * @param array $footer
     * @return string
     */
    private function buildFooter(array $footer)
    {
        $content = "<p>";
        $content .= $this->escaper->escapeHtml($footer['content']);
        $content .= "</p>";

        return $this->formatContentWithLinks($content);
    }

    /**
     * Searches a given string for a URL, formats it to an HTML anchor tag, and returns the original string in the
     * correct HTML format.
     *
     * @param string $content
     * @return string
     */
    private function formatContentWithLinks($content)
    {
        $urlRegex = '#\bhttps?://[^,\s()<>]+(?:\([\w\d]+\)|([^,[:punct:]\s]|/))#';
        $urlTextRegex = '/\[(.*?)\]/';

        preg_match_all($urlRegex, $content, $urlMatches);
        preg_match_all($urlTextRegex, $content, $urlTextMatches);

        foreach ($urlMatches[0] as $key => $urlMatch) {
            if (!empty($urlTextMatches[0])) {
                $linkMatch = $urlMatch . " " . $urlTextMatches[0][$key];
                $content = str_replace(
                    $linkMatch,
                    "<a target='_blank' href='{$this->escaper->escapeUrl($urlMatch)}'>
                        {$this->escaper->escapeHtml($urlTextMatches[1][$key])}</a>",
                    $content
                );
            } else {
                $content = str_replace(
                    $urlMatch,
                    "<a target='_blank' href='{$this->escaper->escapeUrl($urlMatch)}'>
                        {$this->escaper->escapeUrl($urlMatch)}</a>",
                    $content
                );
            }
        }

        return $content;
    }
}