Skip to content

Commit 0a2c029

Browse files
magento-engcom-teammagento-engcom-team
committed
ENGCOM-6670: Fix #25761: Site map doesn't include home page #26445
- Merge Pull Request #26445 from deepaksnair/magento2:fix-25761 - Merged commits: 1. 3bffb4c 2. 57b8f53 3. f165a53 4. 8f5b2c7 5. d93fe31 6. dec8972
2 parents 06a0dd0 + dec8972 commit 0a2c029

File tree

7 files changed

+219
-3
lines changed

7 files changed

+219
-3
lines changed

‎app/code/Magento/Sitemap/Model/ItemProvider/StoreUrl.php

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
namespace Magento\Sitemap\Model\ItemProvider;
8+
9+
use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
10+
11+
/**
12+
* Class for adding Store Url in sitemap
13+
*/
14+
class StoreUrl implements ItemProviderInterface
15+
{
16+
/**
17+
* Sitemap item factory
18+
*
19+
* @var SitemapItemInterfaceFactory
20+
*/
21+
private $itemFactory;
22+
23+
/**
24+
* Config reader
25+
*
26+
* @var ConfigReaderInterface
27+
*/
28+
private $configReader;
29+
30+
/**
31+
* StoreUrlSitemapItemResolver constructor.
32+
*
33+
* @param ConfigReaderInterface $configReader
34+
* @param SitemapItemInterfaceFactory $itemFactory
35+
*/
36+
public function __construct(
37+
ConfigReaderInterface $configReader,
38+
SitemapItemInterfaceFactory $itemFactory
39+
) {
40+
$this->itemFactory = $itemFactory;
41+
$this->configReader = $configReader;
42+
}
43+
44+
/**
45+
* @inheritdoc
46+
*/
47+
public function getItems($storeId)
48+
{
49+
$items[] = $this->itemFactory->create([
50+
'url' => '',
51+
'priority' => $this->configReader->getPriority($storeId),
52+
'changeFrequency' => $this->configReader->getChangeFrequency($storeId),
53+
]);
54+
55+
return $items;
56+
}
57+
}

‎app/code/Magento/Sitemap/Model/ItemProvider/StoreUrlConfigReader.php

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
namespace Magento\Sitemap\Model\ItemProvider;
8+
9+
use Magento\Framework\App\Config\ScopeConfigInterface;
10+
use Magento\Store\Model\ScopeInterface;
11+
12+
/**
13+
* Class for getting configuration for Store Url
14+
*/
15+
class StoreUrlConfigReader implements ConfigReaderInterface
16+
{
17+
/**#@+
18+
* Xpath config settings
19+
*/
20+
const XML_PATH_CHANGE_FREQUENCY = 'sitemap/store/changefreq';
21+
const XML_PATH_PRIORITY = 'sitemap/store/priority';
22+
/**#@-*/
23+
24+
/**
25+
* Scope config
26+
*
27+
* @var ScopeConfigInterface
28+
*/
29+
private $scopeConfig;
30+
31+
/**
32+
* CategoryItemResolverConfigReader constructor.
33+
*
34+
* @param ScopeConfigInterface $scopeConfig
35+
*/
36+
public function __construct(ScopeConfigInterface $scopeConfig)
37+
{
38+
$this->scopeConfig = $scopeConfig;
39+
}
40+
41+
/**
42+
* @inheritdoc
43+
*/
44+
public function getPriority($storeId)
45+
{
46+
return (string)$this->scopeConfig->getValue(
47+
self::XML_PATH_PRIORITY,
48+
ScopeInterface::SCOPE_STORE,
49+
$storeId
50+
);
51+
}
52+
53+
/**
54+
* @inheritdoc
55+
*/
56+
public function getChangeFrequency($storeId)
57+
{
58+
return (string)$this->scopeConfig->getValue(
59+
self::XML_PATH_CHANGE_FREQUENCY,
60+
ScopeInterface::SCOPE_STORE,
61+
$storeId
62+
);
63+
}
64+
}

‎app/code/Magento/Sitemap/Test/Unit/Model/ItemProvider/StoreUrlTest.php

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
namespace Magento\Sitemap\Test\Unit\Model\ItemProvider;
8+
9+
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
10+
use Magento\Sitemap\Model\ItemProvider\ConfigReaderInterface;
11+
use Magento\Sitemap\Model\ItemProvider\StoreUrl as StoreUrlItemResolver;
12+
use Magento\Sitemap\Model\SitemapItem;
13+
use Magento\Sitemap\Model\SitemapItemInterfaceFactory;
14+
use PHPUnit\Framework\MockObject\MockObject;
15+
use PHPUnit\Framework\TestCase;
16+
17+
class StoreUrlTest extends TestCase
18+
{
19+
/**
20+
* test for getItems method
21+
*/
22+
public function testGetItems()
23+
{
24+
$configReaderMock = $this->getConfigReaderMock();
25+
$itemFactoryMock = $this->getItemFactoryMock();
26+
$resolver = new StoreUrlItemResolver($configReaderMock, $itemFactoryMock);
27+
$items = $resolver->getItems(1);
28+
29+
$this->assertCount(1, $items);
30+
foreach ($items as $item) {
31+
$this->assertSame('daily', $item->getChangeFrequency());
32+
$this->assertSame('1.0', $item->getPriority());
33+
}
34+
}
35+
36+
/**
37+
* @return SitemapItemInterfaceFactory|MockObject
38+
*/
39+
private function getItemFactoryMock()
40+
{
41+
$itemFactoryMock = $this->getMockBuilder(SitemapItemInterfaceFactory::class)
42+
->setMethods(['create'])
43+
->disableOriginalConstructor()
44+
->getMock();
45+
46+
$itemFactoryMock->expects($this->any())
47+
->method('create')
48+
->willReturnCallback(function ($data) {
49+
$helper = new ObjectManager($this);
50+
51+
return $helper->getObject(SitemapItem::class, $data);
52+
});
53+
54+
return $itemFactoryMock;
55+
}
56+
57+
/**
58+
* @return ConfigReaderInterface|MockObject
59+
*/
60+
private function getConfigReaderMock()
61+
{
62+
$configReaderMock = $this->getMockForAbstractClass(ConfigReaderInterface::class);
63+
$configReaderMock->expects($this->any())
64+
->method('getPriority')
65+
->willReturn('1.0');
66+
$configReaderMock->expects($this->any())
67+
->method('getChangeFrequency')
68+
->willReturn('daily');
69+
70+
return $configReaderMock;
71+
}
72+
}

‎app/code/Magento/Sitemap/etc/adminhtml/system.xml

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,19 @@
5151
<comment>Valid values range from 0.0 to 1.0.</comment>
5252
</field>
5353
</group>
54-
<group id="generate" translate="label" type="text" sortOrder="4" showInDefault="1">
54+
<group id="store" translate="label" type="text" sortOrder="4" showInDefault="1" showInWebsite="1" showInStore="1">
55+
<label>Store Url Options</label>
56+
<field id="changefreq" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
57+
<label>Frequency</label>
58+
<source_model>Magento\Sitemap\Model\Config\Source\Frequency</source_model>
59+
</field>
60+
<field id="priority" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
61+
<label>Priority</label>
62+
<backend_model>Magento\Sitemap\Model\Config\Backend\Priority</backend_model>
63+
<comment>Valid values range from 0.0 to 1.0.</comment>
64+
</field>
65+
</group>
66+
<group id="generate" translate="label" type="text" sortOrder="5" showInDefault="1">
5567
<label>Generation Settings</label>
5668
<field id="enabled" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
5769
<label>Enabled</label>
@@ -94,7 +106,7 @@
94106
</depends>
95107
</field>
96108
</group>
97-
<group id="limit" translate="label" type="text" sortOrder="5" showInDefault="1" showInWebsite="1" showInStore="1">
109+
<group id="limit" translate="label" type="text" sortOrder="6" showInDefault="1" showInWebsite="1" showInStore="1">
98110
<label>Sitemap File Limits</label>
99111
<field id="max_lines" translate="label" type="text" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
100112
<label>Maximum No of URLs Per File</label>
@@ -106,7 +118,7 @@
106118
<validate>validate-number validate-greater-than-zero</validate>
107119
</field>
108120
</group>
109-
<group id="search_engines" translate="label" type="text" sortOrder="6" showInDefault="1" showInWebsite="1" showInStore="1">
121+
<group id="search_engines" translate="label" type="text" sortOrder="7" showInDefault="1" showInWebsite="1" showInStore="1">
110122
<label>Search Engine Submission Settings</label>
111123
<field id="submission_robots" translate="label" type="select" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
112124
<label>Enable Submission to Robots.txt</label>

‎app/code/Magento/Sitemap/etc/config.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
<changefreq>daily</changefreq>
2626
<image_include>all</image_include>
2727
</product>
28+
<store>
29+
<priority>1</priority>
30+
<changefreq>daily</changefreq>
31+
</store>
2832
<generate>
2933
<enabled>0</enabled>
3034
<error_email />

‎app/code/Magento/Sitemap/etc/di.xml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,18 @@
2525
<type name="Magento\Sitemap\Model\ItemProvider\Composite">
2626
<arguments>
2727
<argument name="itemProviders" xsi:type="array">
28+
<item name="storeUrlProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\StoreUrl</item>
2829
<item name="categoryProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\Category</item>
2930
<item name="cmsPageProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\CmsPage</item>
3031
<item name="productProvider" xsi:type="object">Magento\Sitemap\Model\ItemProvider\Product</item>
3132
</argument>
3233
</arguments>
3334
</type>
35+
<type name="Magento\Sitemap\Model\ItemProvider\StoreUrl">
36+
<arguments>
37+
<argument name="configReader" xsi:type="object">Magento\Sitemap\Model\ItemProvider\StoreUrlConfigReader</argument>
38+
</arguments>
39+
</type>
3440
<type name="Magento\Sitemap\Model\ItemProvider\Category">
3541
<arguments>
3642
<argument name="configReader" xsi:type="object">Magento\Sitemap\Model\ItemProvider\CategoryConfigReader</argument>

‎app/code/Magento/Sitemap/i18n/en_US.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,4 @@ ID,ID
6464
"Link for Google","Link for Google"
6565
"Last Generated","Last Generated"
6666
Action,Action
67+
"Store Url Options","Store Url Options"

0 commit comments

Comments
 (0)