├── .gitattributes
├── Api
    ├── CategoryUrlRetrieverInterface.php
    ├── CmsPageUrlRetrieverInterface.php
    ├── ProductUrlRetrieverInterface.php
    └── UrlRetrieverInterface.php
├── Block
    └── HrefLang.php
├── CHANGELOG.md
├── LICENSE
├── Model
    ├── Adapter.php
    ├── Adapter
    │   ├── Category.php
    │   ├── Page.php
    │   └── Product.php
    ├── AdapterInterface.php
    ├── BlockParser.php
    ├── Config.php
    ├── Property.php
    └── PropertyInterface.php
├── README.md
├── Service
    └── HrefLang
    │   ├── AlternativeUrlService.php
    │   ├── CategoryUrlRetriever.php
    │   ├── CmsPageUrlRetriever.php
    │   └── ProductUrlRetriever.php
├── composer.json
├── etc
    ├── di.xml
    └── module.xml
├── registration.php
└── view
    └── frontend
        ├── layout
            └── default.xml
        └── templates
            └── hreflang.phtml


/.gitattributes:
--------------------------------------------------------------------------------
1 | # Auto detect text files and perform LF normalization
2 | * text=auto
3 | 


--------------------------------------------------------------------------------
/Api/CategoryUrlRetrieverInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace BrunoCanada\HrefLang\Api;
3 | 
4 | interface CategoryUrlRetrieverInterface extends UrlRetrieverInterface
5 | {
6 | }
7 | 


--------------------------------------------------------------------------------
/Api/CmsPageUrlRetrieverInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace BrunoCanada\HrefLang\Api;
3 | 
4 | interface CmsPageUrlRetrieverInterface extends UrlRetrieverInterface
5 | {
6 | }
7 | 


--------------------------------------------------------------------------------
/Api/ProductUrlRetrieverInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | namespace BrunoCanada\HrefLang\Api;
3 | 
4 | interface ProductUrlRetrieverInterface extends UrlRetrieverInterface
5 | {
6 | }
7 | 


--------------------------------------------------------------------------------
/Api/UrlRetrieverInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace BrunoCanada\HrefLang\Api;
 3 | 
 4 | use Magento\Store\Model\Store;
 5 | 
 6 | interface UrlRetrieverInterface
 7 | {
 8 |     /**
 9 |      * @param string|int $identifier
10 |      * @param Store $store
11 |      * @return string
12 |      */
13 |     public function getUrl($identifier, $store);
14 | }
15 | 


--------------------------------------------------------------------------------
/Block/HrefLang.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace BrunoCanada\HrefLang\Block;
  4 | 
  5 | use Magento\Framework\View\Element\Template;
  6 | use Magento\Store\Api\Data\StoreInterface;
  7 | use Magento\Store\Model\Group;
  8 | use Magento\Store\Model\Store;
  9 | use Magento\Store\Model\Website;
 10 | 
 11 | class HrefLang extends Template
 12 | {
 13 |     /**
 14 |      * @var \BrunoCanada\HrefLang\Service\HrefLang\AlternativeUrlService
 15 |      */
 16 |     private $alternativeUrlService;
 17 | 
 18 |     public function __construct(
 19 |         \Magento\Framework\View\Element\Template\Context $context,
 20 |         \BrunoCanada\HrefLang\Service\HrefLang\AlternativeUrlService $alternativeUrlService,
 21 |         array $data = []
 22 |     ) {
 23 |         parent::__construct($context, $data);
 24 |         $this->alternativeUrlService = $alternativeUrlService;
 25 |     }
 26 | 
 27 |     /**
 28 |      * @return array in format [en_us => $url] or [en => $url]
 29 |      */
 30 |     public function getAlternatives()
 31 |     {
 32 |         $data = [];
 33 |         foreach ($this->getStores() as $store) {
 34 |             $url = $this->getStoreUrl($store);
 35 |             if ($url) {
 36 |                 $data[$this->getLocaleCode($store)] = $url;
 37 |             }
 38 |         }
 39 |         return $data;
 40 |     }
 41 | 
 42 |     /**
 43 |      * @param Store $store
 44 |      * @return string
 45 |      */
 46 |     private function getStoreUrl($store)
 47 |     {
 48 |         return $this->alternativeUrlService->getAlternativeUrl($store);
 49 |     }
 50 | 
 51 |     /**
 52 |      * @param StoreInterface $store
 53 |      * @return bool
 54 |      */
 55 |     private function isCurrentStore($store)
 56 |     {
 57 |         return $store->getId() == $this->_storeManager->getStore()->getId();
 58 |     }
 59 | 
 60 |     /**
 61 |      * @param StoreInterface $store
 62 |      * @return string
 63 |      */
 64 |     private function getLocaleCode($store)
 65 |     {
 66 | 		
 67 |         $localeCode = $this->_scopeConfig->getValue('general/locale/code', 'stores', $store->getId());
 68 |         return str_replace('_', '-', strtolower($localeCode));
 69 |     }
 70 | 
 71 |     /**
 72 |      * @return Store[]
 73 |      */
 74 |     private function getStores()
 75 |     {
 76 |         $config = $this->_scopeConfig->getValue('seo/hreflang/same_website_only');
 77 |         if ($config === null || $config === '1') {
 78 |             	return $this->getSameWebsiteStores();
 79 |         }
 80 | 	else{
 81 | 		return $this->_storeManager->getStores();
 82 | 	}
 83 |     }
 84 | 
 85 |     /**
 86 |      * @return Store[]
 87 |      */
 88 |     private function getSameWebsiteStores()
 89 |     {
 90 |         $stores = [];
 91 |         /** @var Website $website */
 92 |         $website = $this->_storeManager->getWebsite();
 93 |         foreach ($website->getGroups() as $group) {
 94 |             /** @var Group $group */
 95 |             foreach ($group->getStores() as $store) {
 96 |                 $stores[] = $store;
 97 |             }
 98 |         }
 99 |         return $stores;
100 |     }
101 | }
102 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Magento 2 HREF LANG SEO with Multi Store Support Changelog
 2 | 
 3 | ## 1.1.1 - 2021-02-09
 4 | - Fix Composer and README, add CHANGELOG file #3
 5 | 
 6 | ## 1.1.0 - 2021-02-09
 7 | - Update README and License files #2
 8 | 
 9 | ## 1.0.0 - 2021-02-09
10 | - Make the module usable with Composer install #1
11 | 
12 | ## 0.1.0 - 2019-12-08
13 | - Initial release


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright 202021 BRUNO BUENO
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 6 | 
 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 8 | The main author's name and GitHub repository link should be mentioned and proper credits given.
 9 | 
10 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/Model/Adapter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace BrunoCanada\HrefLang\Model;
 5 | 
 6 | class Adapter implements AdapterInterface
 7 | {
 8 |     /**
 9 |      * @var array
10 |      */
11 |     private $adapters;
12 |     /**
13 |      * @var PropertyInterface
14 |      */
15 |     private $property;
16 | 
17 |     public function __construct(
18 |         PropertyInterface $property,
19 |         array $adapters
20 |     ) {
21 |         $this->adapters = $adapters;
22 |         $this->property = $property;
23 |     }
24 | 
25 |     public function getProperty() : PropertyInterface
26 |     {
27 |         foreach ($this->adapters as $item) {
28 |             /** @var AdapterInterface $item */
29 |             $property = $item->getProperty();
30 |             if ($property->hasData()) {
31 |                 return $property;
32 |             }
33 |         }
34 |         return $this->property;
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/Model/Adapter/Category.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace BrunoCanada\HrefLang\Model\Adapter;
 5 | 
 6 | use BrunoCanada\HrefLang\Model\AdapterInterface;
 7 | use \Magento\Framework\Registry;
 8 | use BrunoCanada\HrefLang\Model\BlockParser;
 9 | use BrunoCanada\HrefLang\Model\Property;
10 | use BrunoCanada\HrefLang\Model\PropertyInterface;
11 | 
12 | class Category implements AdapterInterface
13 | {
14 |     /**
15 |      * @var array
16 |      */
17 |     private $messageAttributes = [
18 |         'meta_description',
19 |         'description'
20 |     ];
21 |     /**
22 |      * @var Registry
23 |      */
24 |     private $registry;
25 |     /**
26 |      * @var PropertyInterface
27 |      */
28 |     private $property;
29 |     /**
30 |      * @var BlockParser
31 |      */
32 |     private $blockParser;
33 | 
34 |     public function __construct(
35 |         PropertyInterface $property,
36 |         BlockParser $blockParser,
37 |         Registry $registry
38 |     ) {
39 |         $this->registry = $registry;
40 |         $this->property = $property;
41 |         $this->blockParser = $blockParser;
42 |     }
43 | 
44 |     public function getProperty() : PropertyInterface
45 |     {
46 |         /**
47 |          * @var $category \Magento\Catalog\Model\Category
48 |          */
49 |         $category = $this->registry->registry('current_category');
50 |         if ($category) {
51 |             $this->property->setTitle((string) $category->getName());
52 |             $this->property->setUrl((string) $category->getUrl());
53 | 
54 |             foreach ($this->messageAttributes as $messageAttribute) {
55 |                 if ($category->getData($messageAttribute)) {
56 |                     $this->property->setDescription($category->getData($messageAttribute));
57 |                 }
58 |             }
59 | 
60 |             if ($category->hasLandingPage() && !$this->property->getProperty('description')) {
61 |                 $this->property->setDescription(
62 |                     $this->blockParser->getBlockContentById(
63 |                         (int) $category->getLandingPage()
64 |                     )
65 |                 );
66 |             }
67 | 
68 |             if ($category->getImageUrl()) {
69 |                 $this->property->setImage((string) $category->getImageUrl());
70 |             }
71 |             $this->property->addProperty('item', $category->getData(), Property::META_DATA_GROUP);
72 |         }
73 |         return $this->property;
74 |     }
75 | }
76 | 


--------------------------------------------------------------------------------
/Model/Adapter/Page.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace BrunoCanada\HrefLang\Model\Adapter;
 5 | 
 6 | use Magento\Cms\Model\Page as CmsPage;
 7 | use Magento\Cms\Model\Template\FilterProvider;
 8 | use Magento\Framework\UrlInterface;
 9 | use BrunoCanada\HrefLang\Model\AdapterInterface;
10 | use BrunoCanada\HrefLang\Model\Property;
11 | use BrunoCanada\HrefLang\Model\PropertyInterface;
12 | 
13 | class Page implements AdapterInterface
14 | {
15 |     /**
16 |      * @var PropertyInterface
17 |      */
18 |     private $property;
19 |     /**
20 |      * @var CmsPage
21 |      */
22 |     private $page;
23 |     /**
24 |      * @var UrlInterface
25 |      */
26 |     private $url;
27 |     /**
28 |      * @var FilterProvider
29 |      */
30 |     private $filterProvider;
31 | 
32 |     public function __construct(
33 |         CmsPage $page,
34 |         UrlInterface $url,
35 |         FilterProvider $filterProvider,
36 |         PropertyInterface $property
37 |     ) {
38 |         $this->property = $property;
39 |         $this->page = $page;
40 |         $this->url = $url;
41 |         $this->filterProvider = $filterProvider;
42 |     }
43 | 
44 |     public function getProperty() : PropertyInterface
45 |     {
46 |         if ($this->page->getId()) {
47 |             $this->property->setTitle((string) $this->page->getTitle());
48 |             $this->property->setDescription(
49 |                 (string) $this->filterProvider->getBlockFilter()->filter($this->page->getContent())
50 |             );
51 |             $this->property->setUrl((string) $this->url->getUrl($this->page->getIdentifier()));
52 |             $this->property->addProperty('item', $this->page->getData(), Property::META_DATA_GROUP);
53 |         }
54 |         return $this->property;
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/Model/Adapter/Product.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace BrunoCanada\HrefLang\Model\Adapter;
 5 | 
 6 | use Magento\Catalog\Block\Product\ImageBuilder;
 7 | use Magento\Catalog\Block\Product\Image;
 8 | use BrunoCanada\HrefLang\Model\AdapterInterface;
 9 | use BrunoCanada\HrefLang\Model\Property;
10 | use BrunoCanada\HrefLang\Model\PropertyInterface;
11 | use \Magento\Framework\Registry;
12 | 
13 | class Product implements AdapterInterface
14 | {
15 |     /**
16 |      * @var array
17 |      */
18 |     private $messageAttributes = [
19 |         'meta_description',
20 |         'short_description',
21 |         'description'
22 |     ];
23 |     /**
24 |      * @var PropertyInterface
25 |      */
26 |     private $property;
27 |     /**
28 |      * @var Registry
29 |      */
30 |     private $registry;
31 |     /**
32 |      * @var ImageBuilder
33 |      */
34 |     private $imageBuilder;
35 | 
36 |     public function __construct(
37 |         PropertyInterface $property,
38 |         ImageBuilder $imageBuilder,
39 |         Registry $registry
40 |     ) {
41 |         $this->property = $property;
42 |         $this->registry = $registry;
43 |         $this->imageBuilder = $imageBuilder;
44 |     }
45 | 
46 |     public function getProperty() : PropertyInterface
47 |     {
48 |         $product = $this->registry->registry('current_product');
49 |         if ($product) {
50 |             $this->property->addProperty('og:type', 'og:product', 'product');
51 |             $this->property->setTitle((string) $product->getName());
52 | 
53 |             foreach ($this->messageAttributes as $messageAttribute) {
54 |                 if ($product->getData($messageAttribute)) {
55 |                     $this->property->setDescription((string) $product->getData($messageAttribute));
56 |                 }
57 |             }
58 | 
59 |             if ($product->getImage()) {
60 |                 $this->property->setImage((string) $this->getImage($product, 'product_base_image')->getImageUrl());
61 |             }
62 | 
63 |             $this->property->setUrl($product->getProductUrl());
64 |             $this->property->addProperty('product:price:amount', (string) $product->getFinalPrice(), 'product');
65 |             $this->property->addProperty('item', $product->getData(), Property::META_DATA_GROUP);
66 |         }
67 |         return $this->property;
68 |     }
69 | 
70 |     private function getImage(\Magento\Catalog\Model\Product $product, string $imageId, array $attributes = []) : Image
71 |     {
72 |         return $this->imageBuilder->setProduct($product)
73 |             ->setImageId($imageId)
74 |             ->setAttributes($attributes)
75 |             ->create();
76 |     }
77 | }
78 | 


--------------------------------------------------------------------------------
/Model/AdapterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace BrunoCanada\HrefLang\Model;
 5 | 
 6 | interface AdapterInterface
 7 | {
 8 |     /**
 9 |      * @return \BrunoCanada\HrefLang\Model\Property
10 |      */
11 |     public function getProperty();
12 | }
13 | 


--------------------------------------------------------------------------------
/Model/BlockParser.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BrunoCanada\HrefLang\Model;
 4 | 
 5 | use Magento\Cms\Api\BlockRepositoryInterface;
 6 | 
 7 | class BlockParser
 8 | {
 9 |     /**
10 |      * @var BlockRepositoryInterface
11 |      */
12 |     private $blockRepository;
13 | 
14 |     public function __construct(
15 |         BlockRepositoryInterface $blockRepository
16 |     ) {
17 |         $this->blockRepository = $blockRepository;
18 |     }
19 | 
20 |     public function getBlockContentById(int $blockId) : string
21 |     {
22 |         try {
23 |             $cmsBlock = $this->blockRepository->getById($blockId);
24 |             return html_entity_decode($cmsBlock->getData('content')) ?? ''; //@codingStandardsIgnoreLine
25 |         } catch (\Exception $e) {
26 |             return '';
27 |         }
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/Model/Config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace BrunoCanada\HrefLang\Model;
 5 | 
 6 | use Magento\Framework\App\Config\ScopeConfigInterface;
 7 | use Magento\Store\Model\ScopeInterface;
 8 | 
 9 | /**
10 |  * Class Config
11 |  * @package BrunoCanada\HrefLang\Model
12 |  */
13 | class Config
14 | {
15 |     /**
16 |      * @var ScopeConfigInterface
17 |      */
18 |     private $scopeConfig;
19 | 
20 |     /**
21 |      * Config constructor.
22 |      * @param ScopeConfigInterface $scopeConfig
23 |      */
24 |     public function __construct(
25 |         ScopeConfigInterface $scopeConfig
26 |     ) {
27 |         $this->scopeConfig = $scopeConfig;
28 |     }
29 | 
30 |     public function isActive(string $configPath): bool
31 |     {
32 |         return $this->scopeConfig->isSetFlag(
33 |             $configPath,
34 |             ScopeInterface::SCOPE_STORE
35 |         );
36 |     }
37 | 
38 |     private function getConfigValue(string $configPath) : string
39 |     {
40 |         $result = $this->scopeConfig->getValue(
41 |             $configPath,
42 |             ScopeInterface::SCOPE_STORE
43 |         );
44 |         return $result ?? '';
45 |     }
46 | }
47 | 


--------------------------------------------------------------------------------
/Model/Property.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | 
  4 | namespace BrunoCanada\HrefLang\Model;
  5 | 
  6 | final class Property implements PropertyInterface
  7 | {
  8 |     const META_DATA_GROUP = '_data';
  9 |     const DEFAULT_GROUP = 'default';
 10 |     const DEFAULT_PROPERTIES = [];
 11 |     const DEFAULT_PREFIX = '';
 12 |     const DEFAULT_ATTRIBUTE_NAME = 'name';
 13 |     const MAX_DESCRIPTION_LENGTH = 200;
 14 | 
 15 |     /**
 16 |      * @var array
 17 |      */
 18 |     private $properties = self::DEFAULT_PROPERTIES;
 19 |     /**
 20 |      * @var string
 21 |      */
 22 |     private $prefix = self::DEFAULT_PREFIX;
 23 |     /**
 24 |      * @var string
 25 |      */
 26 |     private $attributeName = self::DEFAULT_ATTRIBUTE_NAME;
 27 |     /**
 28 |      * @var array
 29 |      */
 30 |     private $validImageFormats = [
 31 |         'jpg',
 32 |         'jpeg',
 33 |         'webp',
 34 |         'gif',
 35 |         'png'
 36 |     ];
 37 | 
 38 |     /**
 39 |      * @param string $prefix
 40 |      * @return $this
 41 |      */
 42 |     public function setPrefix(string $prefix)
 43 |     {
 44 |         $this->prefix = $prefix;
 45 |         return $this;
 46 |     }
 47 | 
 48 |     /**
 49 |      * @param string $attributeName
 50 |      * @return $this
 51 |      */
 52 |     public function setMetaAttributeName(string $attributeName)
 53 |     {
 54 |         $this->attributeName = $attributeName;
 55 |         return $this;
 56 |     }
 57 | 
 58 |     /**
 59 |      * @param string $title
 60 |      * @return $this
 61 |      */
 62 |     public function setTitle(string $title)
 63 |     {
 64 |         return $this->addProperty('title', $this->getFilteredInput($title));
 65 |     }
 66 | 
 67 |     /**
 68 |      * @param string $description
 69 |      * @return $this
 70 |      */
 71 |     public function setDescription(string $description)
 72 |     {
 73 |         $description = $this->getFilteredInput($description);
 74 |         if (strlen($description) >= self::MAX_DESCRIPTION_LENGTH) {
 75 |             $description = substr($description, 0, (self::MAX_DESCRIPTION_LENGTH - 4)) . ' ...';
 76 |         }
 77 |         return $this->addProperty(
 78 |             'description',
 79 |             $description
 80 |         );
 81 |     }
 82 | 
 83 |     /**
 84 |      * @param string $url
 85 |      * @return $this
 86 |      */
 87 |     public function setUrl(string $url)
 88 |     {
 89 |         if (filter_var($url, FILTER_VALIDATE_URL) !== false) {
 90 |             return $this->addProperty('url', $url);
 91 |         }
 92 |         throw new \LogicException(
 93 |             sprintf(
 94 |                 'Not a valid URL: [%s]',
 95 |                 $url
 96 |             )
 97 |         );
 98 |     }
 99 | 
100 |     /**
101 |      * @param string $image
102 |      * @return $this
103 |      */
104 |     public function setImage(string $image)
105 |     {
106 |         $extension = strtolower(pathinfo($image, PATHINFO_EXTENSION)); //@codingStandardsIgnoreLine
107 |         if (in_array($extension, $this->validImageFormats)) {
108 |             return $this->addProperty('image', $image);
109 |         }
110 |         throw new \LogicException(
111 |             sprintf(
112 |                 'Invalid image format provided: [%s], please use on of these [%s]',
113 |                 $extension,
114 |                 implode(
115 |                     ',',
116 |                     $this->validImageFormats
117 |                 )
118 |             )
119 |         );
120 |     }
121 | 
122 |     /**
123 |      * @param string $imageAlt
124 |      * @return $this
125 |      */
126 |     public function setImageAlt(string $imageAlt)
127 |     {
128 |         return $this->addProperty('image:alt', htmlentities(strip_tags($imageAlt)));
129 |     }
130 | 
131 |     /**
132 |      * @param string $key
133 |      * @param string|array $value
134 |      * @param string $group
135 |      * @return string
136 |      */
137 |     public function addProperty(string $key, $value, string $group = self::DEFAULT_GROUP)
138 |     {
139 |         $this->properties[$group][$key] = $value;
140 |         return $this;
141 |     }
142 | 
143 |     public function getProperty(string $key, string $group = self::DEFAULT_GROUP)
144 |     {
145 |         return $this->properties[$group][$key] ?? '';
146 |     }
147 | 
148 |     public function removeProperty(string $key, string $group = self::DEFAULT_GROUP)
149 |     {
150 |         unset($this->properties[$group][$key]);
151 |         return $this;
152 |     }
153 | 
154 |     public function toHtml(string $group = self::DEFAULT_GROUP) : string
155 |     {
156 |         $html = $this->renderProperties($this->properties, $group);
157 |         $this->resetValues($group);
158 |         return $html;
159 |     }
160 | 
161 |     public function hasData(string $group = self::DEFAULT_GROUP) : bool
162 |     {
163 |         if ($this->properties[$group] ?? false) {
164 |             return true;
165 |         }
166 |         return false;
167 |     }
168 | 
169 |     private function renderProperties(array $properties, string $group = self::DEFAULT_GROUP) : string
170 |     {
171 |         $html = [];
172 | 
173 |         if (isset($properties[$group])) {
174 |             $properties = $properties[$group];
175 |         }
176 | 
177 |         foreach ($properties as $property => $value) {
178 |             if ($property === self::META_DATA_GROUP) {
179 |                 continue;
180 |             }
181 |             if (is_array($value)) {
182 |                 $subList = $this->renderProperties($value);
183 |                 $html[] = $subList;
184 |             } else {
185 |                 if (empty($value)) {
186 |                     continue;
187 |                 }
188 |                 $html[] = $this->getMetaTag($property, $value);
189 |             }
190 |         }
191 |         return implode($html);
192 |     }
193 | 
194 |     private function getMetaTag(string $key, string $value) : string
195 |     {
196 |         return sprintf(
197 |             '<meta %s="%s%s" content="%s" />%s',
198 |             $this->attributeName,
199 |             $this->prefix,
200 |             strip_tags($key),
201 |             strip_tags($value),
202 |             PHP_EOL
203 |         );
204 |     }
205 | 
206 |     private function getFilteredInput(string $input) : string
207 |     {
208 |         $input = trim(strip_tags(str_replace(["\r\n", "\r", "\n"], "", $input)));
209 |         $input = preg_replace('/\s+/', ' ', $input);
210 |         return htmlentities($input);
211 |     }
212 | 
213 |     private function resetValues(string $group = self::DEFAULT_GROUP)
214 |     {
215 |         $this->properties[$group] = self::DEFAULT_PROPERTIES;
216 |         $this->prefix = self::DEFAULT_PREFIX;
217 |         $this->attributeName = self::DEFAULT_ATTRIBUTE_NAME;
218 |     }
219 | }
220 | 


--------------------------------------------------------------------------------
/Model/PropertyInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace BrunoCanada\HrefLang\Model;
 5 | 
 6 | /**
 7 |  * Interface PropertyInterface
 8 |  * @package BrunoCanada\HrefLang\Api\Data
 9 |  * @api
10 |  */
11 | interface PropertyInterface
12 | {
13 |     /**
14 |      * @param string $prefix
15 |      * @return $this
16 |      */
17 |     public function setPrefix(string $prefix);
18 | 
19 |     /**
20 |      * @param string $attributeName
21 |      * @return $this
22 |      */
23 |     public function setMetaAttributeName(string $attributeName);
24 | 
25 |     /**
26 |      * @param string $title
27 |      * @return $this
28 |      */
29 |     public function setTitle(string $title);
30 | 
31 |     /**
32 |      * @param string $description
33 |      * @return $this
34 |      */
35 |     public function setDescription(string $description);
36 | 
37 |     /**
38 |      * @param string $url
39 |      * @return $this
40 |      */
41 |     public function setUrl(string $url);
42 | 
43 |     /**
44 |      * @param string $image
45 |      * @return $this
46 |      */
47 |     public function setImage(string $image);
48 | 
49 |     /**
50 |      * @param string $imageAlt
51 |      * @return $this
52 |      */
53 |     public function setImageAlt(string $imageAlt);
54 | 
55 |     /**
56 |      * @param string $key
57 |      * @param string|array $value
58 |      * @param string $group
59 |      * @return string
60 |      */
61 |     public function addProperty(string $key, $value, string $group = Property::DEFAULT_GROUP);
62 | 
63 |     /**
64 |      * @param string $key
65 |      * @param string $group
66 |      * @return string
67 |      */
68 |     public function getProperty(string $key, string $group = Property::DEFAULT_GROUP);
69 | 
70 |     /**
71 |      * @param string $key
72 |      * @param string $group
73 |      * @return $this
74 |      */
75 |     public function removeProperty(string $key, string $group = Property::DEFAULT_GROUP);
76 | 
77 |     /**
78 |      * @param string $group
79 |      * @return string
80 |      */
81 |     public function toHtml(string $group = Property::DEFAULT_GROUP);
82 | 
83 |     /**
84 |      * @param string $group
85 |      * @return bool
86 |      */
87 |     public function hasData(string $group = Property::DEFAULT_GROUP);
88 | }
89 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Magento 2 HREF LANG SEO with Multi Store Support
 2 | 
 3 | <div align="center">
 4 | 
 5 | [![GitHub release](https://img.shields.io/github/v/release/bruno-canada/magento2-hrefLang)](https://GitHub.com/bruno-canada/magento2-hrefLang/releases/) [![GitHub license](https://img.shields.io/github/license/bruno-canada/magento2-hrefLang)](https://github.com/bruno-canada/magento2-hrefLang/blob/master/LICENSE) [![Github all releases](https://img.shields.io/github/downloads/bruno-canada/magento2-hrefLang/total)](https://github.com/bruno-canada/magento2-hrefLang/releases/) [![GitHub forks](https://img.shields.io/github/forks/bruno-canada/magento2-hrefLang.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/bruno-canada/magento2-hrefLang/network)
 6 | 
 7 | </div>
 8 | 
 9 | ---
10 | 
11 | <p align="center"> This Magento 2 multi store extension adds the alternate hreflang tag for: Pages, Product and Category.
12 |     <br>
13 | </p>
14 | 
15 | # Table of Contents
16 | 
17 | - [About](#about)
18 | - [Getting Started](#getting_started)
19 |     - [Prerequisites](#prerequisites)
20 |     - [Installing via Composer](#viacomposer)
21 |     - [Manual Instalation](#manualinstallation)
22 |     - [Module Management](#modulemanagement)
23 | 
24 | # About <a name = "about"></a>
25 | 
26 | <p>This extension solves a SEO specific problem of content duplication for Google and other search engines.</p>
27 | 
28 | <p>It automatically adds the HREFLANG tag to pages, product and category of Magento considering your multi store structure.</p>
29 | 
30 | <p>Google Hreflang reference: https://support.google.com/webmasters/answer/189077?hl=en</p>
31 | <p>MOZ Hreflang reference: https://moz.com/learn/seo/hreflang-tag</p>
32 | 
33 | # Getting Started <a name = "getting_started"></a>
34 | 
35 | ## Prerequisites <a name = "prerequisites"></a>
36 | 
37 | ```
38 | PHP 7+
39 | Magento 2
40 | Zend Framework
41 | Composer 1.10.16
42 | ```
43 | 
44 | ## Installing via Composer <a name = "viacomposer"></a>
45 | 
46 | 1. Access your Magento 2 root directory
47 | 2. Run `composer require brunocanada/hreflang`
48 | 3. Double-check if it is installed and enabled, run `bin/magento module:status BrunoCanada_HrefLang`
49 | 
50 | ## Manual Instalation <a name = "manualinstallation"></a>
51 | 
52 | 1) Download this package;
53 | 
54 | 2) Create the following folder inside your Magento 2 installation
55 | 
56 | ```
57 | app/code/BrunoCanada/HrefLang
58 | ```
59 | 
60 | 3) Paste the files of this package inside the created folder (step 2)
61 | 
62 | 4) Run the following command inside your Magento 2 installation:
63 | 
64 | ```
65 | $ bin/magento setup:upgrade
66 | ```
67 | 
68 | ## Module Management <a name = "modulemanagement"></a>
69 | 
70 | - Enable module: `bin/magento module:enable BrunoCanada_HrefLang`
71 | - Disable module: `bin/magento module:disable BrunoCanada_HrefLang`
72 | 


--------------------------------------------------------------------------------
/Service/HrefLang/AlternativeUrlService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BrunoCanada\HrefLang\Service\HrefLang;
 4 | 
 5 | use Magento\Framework\App\Request\Http as HttpRequest;
 6 | use Magento\Store\Model\Store;
 7 | use BrunoCanada\HrefLang\Api\CategoryUrlRetrieverInterface;
 8 | use BrunoCanada\HrefLang\Api\CmsPageUrlRetrieverInterface;
 9 | use BrunoCanada\HrefLang\Api\ProductUrlRetrieverInterface;
10 | 
11 | class AlternativeUrlService
12 | {
13 |     /**
14 |      * @var CmsPageUrlRetrieverInterface
15 |      */
16 |     private $cmsPageUrlRetriever;
17 |     /**
18 |      * @var CategoryUrlRetrieverInterface
19 |      */
20 |     private $categoryUrlRetriever;
21 |     /**
22 |      * @var ProductUrlRetrieverInterface
23 |      */
24 |     private $productUrlRetriever;
25 |     /**
26 |      * @var HttpRequest
27 |      */
28 |     private $request;
29 | 
30 |     public function __construct(
31 |         CmsPageUrlRetrieverInterface $cmsPageUrlRetriever,
32 |         CategoryUrlRetrieverInterface $categoryUrlRetriever,
33 |         ProductUrlRetrieverInterface $productUrlRetriever,
34 |         HttpRequest $request
35 |     ) {
36 |         $this->cmsPageUrlRetriever = $cmsPageUrlRetriever;
37 |         $this->categoryUrlRetriever = $categoryUrlRetriever;
38 |         $this->productUrlRetriever = $productUrlRetriever;
39 |         $this->request = $request;
40 |     }
41 | 
42 |     /**
43 |      * @param Store $store
44 |      * @return string
45 |      */
46 |     public function getAlternativeUrl($store)
47 |     {
48 |         switch ($this->request->getFullActionName()) {
49 |             case 'catalog_category_view':
50 |                 return $this->categoryUrlRetriever->getUrl($this->request->getParam('id'), $store);
51 |             case 'catalog_product_view':
52 |                 return $this->productUrlRetriever->getUrl($this->request->getParam('id'), $store);
53 |             case 'cms_page_view':
54 |                 return $this->cmsPageUrlRetriever->getUrl($this->request->getParam('page_id'), $store);
55 |             case 'cms_index_index':
56 |                 return $store->getBaseUrl();
57 |         }
58 |         return '';
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/Service/HrefLang/CategoryUrlRetriever.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BrunoCanada\HrefLang\Service\HrefLang;
 4 | 
 5 | use Magento\Catalog\Api\CategoryRepositoryInterface;
 6 | use Magento\Catalog\Model\Category;
 7 | use Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator;
 8 | use Magento\Store\Model\Store;
 9 | use BrunoCanada\HrefLang\Api\CategoryUrlRetrieverInterface;
10 | 
11 | class CategoryUrlRetriever implements CategoryUrlRetrieverInterface
12 | {
13 |     /**
14 |      * @var CategoryRepositoryInterface
15 |      */
16 |     private $categoryRepository;
17 |     /**
18 |      * @var CategoryUrlPathGenerator
19 |      */
20 |     private $categoryUrlPathGenerator;
21 |     /**
22 |      * @var \Magento\Framework\Registry
23 |      */
24 |     private $registry;
25 | 
26 |     public function __construct(
27 |         CategoryRepositoryInterface $categoryRepository,
28 |         CategoryUrlPathGenerator $categoryUrlPathGenerator,
29 |         \Magento\Framework\Registry $registry
30 |     ) {
31 |         $this->categoryRepository = $categoryRepository;
32 |         $this->categoryUrlPathGenerator = $categoryUrlPathGenerator;
33 |         $this->registry = $registry;
34 |     }
35 | 
36 |     /**
37 |      * @param int $identifier the category ID
38 |      * @param Store $store
39 |      * @return string
40 |      */
41 |     public function getUrl($identifier, $store)
42 |     {
43 |         /** @var Category $category */
44 |         $category = $this->registry->registry('category');
45 |         if(!$category) {
46 |             $category = $this->categoryRepository->get($identifier, $store->getId());
47 |         }
48 |         $path = $this->categoryUrlPathGenerator->getUrlPathWithSuffix($category);
49 |         return $store->getBaseUrl() . $path;
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/Service/HrefLang/CmsPageUrlRetriever.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BrunoCanada\HrefLang\Service\HrefLang;
 4 | 
 5 | use Magento\Cms\Api\PageRepositoryInterface;
 6 | use Magento\Cms\Model\ResourceModel\Page as PageResource;
 7 | use Magento\CmsUrlRewrite\Model\CmsPageUrlPathGenerator;
 8 | use Magento\Framework\Exception\LocalizedException;
 9 | use Magento\Store\Model\Store;
10 | use BrunoCanada\HrefLang\Api\CmsPageUrlRetrieverInterface;
11 | 
12 | class CmsPageUrlRetriever implements CmsPageUrlRetrieverInterface
13 | {
14 |     /**
15 |      * @var PageRepositoryInterface
16 |      */
17 |     private $pageRepository;
18 |     /**
19 |      * @var CmsPageUrlPathGenerator
20 |      */
21 |     private $cmsPageUrlPathGenerator;
22 |     /**
23 |      * @var PageResource
24 |      */
25 |     private $pageResource;
26 | 
27 |     public function __construct(
28 |         PageRepositoryInterface $pageRepository,
29 |         CmsPageUrlPathGenerator $cmsPageUrlPathGenerator,
30 |         PageResource $pageResource
31 |     ) {
32 |         $this->pageRepository = $pageRepository;
33 |         $this->cmsPageUrlPathGenerator = $cmsPageUrlPathGenerator;
34 |         $this->pageResource = $pageResource;
35 |     }
36 | 
37 |     /**
38 |      * @param int $identifier The page ID
39 |      * @param Store $store
40 |      * @return string
41 |      */
42 |     public function getUrl($identifier, $store)
43 |     {
44 |         try {
45 |             $page = $this->pageRepository->getById($identifier);
46 |             $pageId = $this->pageResource->checkIdentifier($page->getIdentifier(), $store->getId());
47 |             $storePage = $this->pageRepository->getById($pageId);
48 |             $path = $this->cmsPageUrlPathGenerator->getUrlPath($storePage);
49 |             return $store->getBaseUrl() . $path;
50 |         } catch (LocalizedException $e) {
51 |             return '';
52 |         }
53 |     }
54 | }
55 | 


--------------------------------------------------------------------------------
/Service/HrefLang/ProductUrlRetriever.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BrunoCanada\HrefLang\Service\HrefLang;
 4 | 
 5 | use Magento\Catalog\Api\ProductRepositoryInterface;
 6 | use Magento\Catalog\Model\Product;
 7 | use Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator;
 8 | use Magento\Store\Model\Store;
 9 | use BrunoCanada\HrefLang\Api\ProductUrlRetrieverInterface;
10 | 
11 | class ProductUrlRetriever implements ProductUrlRetrieverInterface
12 | {
13 |     /**
14 |      * @var ProductRepositoryInterface
15 |      */
16 |     private $productRepository;
17 |     /**
18 |      * @var ProductUrlPathGenerator
19 |      */
20 |     private $productUrlPathGenerator;
21 |     /**
22 |      * @var \Magento\Framework\Registry
23 |      */
24 |     private $registry;
25 | 
26 |     public function __construct(
27 |         ProductRepositoryInterface $productRepository,
28 |         ProductUrlPathGenerator $productUrlPathGenerator,
29 |         \Magento\Framework\Registry $registry
30 |     ) {
31 |         $this->productRepository = $productRepository;
32 |         $this->productUrlPathGenerator = $productUrlPathGenerator;
33 |         $this->registry = $registry;
34 |     }
35 | 
36 |     /**
37 |      * @param int $identifier the product ID
38 |      * @param Store $store
39 |      * @return string
40 |      */
41 |     public function getUrl($identifier, $store)
42 |     {
43 |         /** @var Product $product */
44 |         $product = $this->registry->registry('product');
45 |         //if (!$product) 
46 | 		{
47 |             $product = $this->productRepository->getById($identifier, false, $store->getId());
48 |         }
49 |         $path = $this->productUrlPathGenerator->getUrlPathWithSuffix($product, $store->getId());
50 |         return $store->getBaseUrl() . $path;
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "brunocanada/hreflang",
 3 |     "description": "This Magento 2 multi store extension adds the alternate hreflang tag for: Pages, Product and Category.",
 4 |     "homepage": "https://github.com/bruno-canada/magento2-hrefLang",
 5 |     "type": "magento2-module",
 6 |     "license": "MIT",
 7 |     "keywords": [
 8 |         "magento 2",
 9 |         "seo",
10 |         "magento 2 seo",
11 |         "href lang",
12 |         "magento 2 multi store"
13 |     ],
14 |     "authors": [
15 |         {
16 |             "name": "Bruno Bueno",
17 |             "homepage": "https://github.com/bruno-canada/magento2-hrefLang"
18 |         }
19 |     ],
20 |     "require": {},
21 |     "autoload": {
22 |         "files": [
23 |             "registration.php"
24 |         ],
25 |         "psr-4": {
26 |             "BrunoCanada\\HrefLang\\": ""
27 |         }
28 |     }
29 | }


--------------------------------------------------------------------------------
/etc/di.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | -->
 4 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
 5 |     <preference for="BrunoCanada\HrefLang\Model\PropertyInterface" type="BrunoCanada\HrefLang\Model\Property" />
 6 |     <preference for="BrunoCanada\HrefLang\Model\AdapterInterface" type="BrunoCanada\HrefLang\Model\Adapter" />
 7 |     <preference for="BrunoCanada\HrefLang\Api\CmsPageUrlRetrieverInterface" type="BrunoCanada\HrefLang\Service\HrefLang\CmsPageUrlRetriever" />
 8 |     <preference for="BrunoCanada\HrefLang\Api\CategoryUrlRetrieverInterface" type="BrunoCanada\HrefLang\Service\HrefLang\CategoryUrlRetriever" />
 9 |     <preference for="BrunoCanada\HrefLang\Api\ProductUrlRetrieverInterface" type="BrunoCanada\HrefLang\Service\HrefLang\ProductUrlRetriever" />
10 |     <type name="BrunoCanada\HrefLang\Model\Adapter">
11 |         <arguments>
12 |             <argument name="adapters" xsi:type="array">
13 |                 <item name="product_entity_container" xsi:type="object">\BrunoCanada\HrefLang\Model\Adapter\Product</item>
14 |                 <item name="category_entity_container" xsi:type="object">\BrunoCanada\HrefLang\Model\Adapter\Category</item>
15 |                 <item name="page_entity_container" xsi:type="object">\BrunoCanada\HrefLang\Model\Adapter\Page</item>
16 |             </argument>
17 |         </arguments>
18 |     </type>
19 | </config>


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | -->
 4 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
 5 |     <module name="BrunoCanada_HrefLang" setup_version="1.0.0">
 6 |         <sequence>
 7 |             <module name="Magento_Store" />
 8 |             <module name="Magento_Config" />
 9 |             <module name="Magento_Catalog" />
10 |             <module name="Magento_Cms" />
11 |             <module name="Magento_Theme" />
12 |         </sequence>
13 |     </module>
14 | </config>
15 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
1 | <?php
2 | \Magento\Framework\Component\ComponentRegistrar::register(
3 |     \Magento\Framework\Component\ComponentRegistrar::MODULE,
4 |     'BrunoCanada_HrefLang',
5 |     __DIR__
6 | );
7 | 


--------------------------------------------------------------------------------
/view/frontend/layout/default.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0"?>
2 | <!--
3 | -->
4 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
5 |     <referenceContainer name="head.additional">
6 |         <block class="BrunoCanada\HrefLang\Block\HrefLang" name="seo.href.lang" template="BrunoCanada_HrefLang::hreflang.phtml"/>
7 |     </referenceContainer>
8 | </page>


--------------------------------------------------------------------------------
/view/frontend/templates/hreflang.phtml:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /** @var $block BrunoCanada\HrefLang\Block\HrefLang */
 4 | $alternatives = $block->getAlternatives();
 5 | ?>
 6 | <?php if ($alternatives): ?>
 7 |     <?php foreach ($alternatives as $hrefLang => $url): ?>
 8 | <link rel="alternate" hreflang="<?php echo $hrefLang ?>" href="<?php echo $url ?>" />
 9 |     <?php endforeach; ?>
10 | <?php endif ?>
11 | 


--------------------------------------------------------------------------------