Initial commit

modules/ps_mbo/src/RecommendedLink/RecommendedLink.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * 2007-2020 PrestaShop and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShop\Module\Mbo\RecommendedLink;
+
+class RecommendedLink implements RecommendedLinkInterface
+{
+    /**
+     * @var string
+     */
+    private $id;
+
+    /**
+     * @var string
+     */
+    private $url;
+
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * RecommendedLink constructor.
+     *
+     * @param string $id
+     * @param string $url
+     * @param string $name
+     */
+    public function __construct($id, $url, $name)
+    {
+        $this->id = $id;
+        $this->url = $url;
+        $this->name = $name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUrl()
+    {
+        return $this->url;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+}

modules/ps_mbo/src/RecommendedLink/RecommendedLinkInterface.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * 2007-2020 PrestaShop and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShop\Module\Mbo\RecommendedLink;
+
+interface RecommendedLinkInterface
+{
+    /**
+     * Get the identifier of the recommended link.
+     *
+     * @return string
+     */
+    public function getId();
+
+    /**
+     * Get the url of the recommended module.
+     *
+     * @return string
+     */
+    public function getUrl();
+
+    /**
+     * Get the display name of the recommended module.
+     *
+     * @return string
+     */
+    public function getName();
+}

modules/ps_mbo/src/RecommendedLink/RecommendedLinkProvider.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * 2007-2020 PrestaShop and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShop\Module\Mbo\RecommendedLink;
+
+use PrestaShop\PrestaShop\Adapter\LegacyContext;
+use Symfony\Component\Serializer\SerializerInterface;
+
+class RecommendedLinkProvider
+{
+    /**
+     * @var LegacyContext
+     */
+    private $context;
+
+    /**
+     * @var SerializerInterface
+     */
+    private $serializer;
+
+    /**
+     * Constructor.
+     *
+     * @param SerializerInterface $serializer
+     * @param LegacyContext $context
+     */
+    public function __construct(
+        LegacyContext $context,
+        SerializerInterface $serializer
+    ) {
+        $this->context = $context;
+        $this->serializer = $serializer;
+    }
+
+    /**
+     * @return RecommendedLink[]
+     */
+    public function getRecommendedLinks()
+    {
+        $recommendedLinks = [];
+        $cacheFile = $this->getCacheFile();
+
+        if ($cacheFile) {
+            $recommendedLinks = $this->serializer->deserialize(
+                file_get_contents($cacheFile),
+                sprintf('%s[]', RecommendedLink::class),
+                'json'
+            );
+        }
+
+        return $recommendedLinks;
+    }
+
+    /**
+     * Search a cache associated to context language or try to fallback to default locale
+     *
+     * @return string
+     */
+    private function getCacheFile()
+    {
+        $cacheFile = _PS_MODULE_DIR_
+            . 'ps_mbo/cache/recommended-links-'
+            . strtolower($this->context->getContext()->language->iso_code)
+            . '.json'
+        ;
+
+        if (file_exists($cacheFile)) {
+            return $cacheFile;
+        }
+
+        $cacheFile = _PS_MODULE_DIR_
+            . 'ps_mbo/cache/recommended-links-en.json'
+        ;
+
+        if (file_exists($cacheFile)) {
+            return $cacheFile;
+        }
+
+        return '';
+    }
+}