Inheritance diagram for Sitemap:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Escaper $escaper, \Magento\Sitemap\Helper\Data $sitemapData, \Magento\Framework\Filesystem $filesystem, \Magento\Sitemap\Model\ResourceModel\Catalog\CategoryFactory $categoryFactory, \Magento\Sitemap\Model\ResourceModel\Catalog\ProductFactory $productFactory, \Magento\Sitemap\Model\ResourceModel\Cms\PageFactory $cmsFactory, \Magento\Framework\Stdlib\DateTime\DateTime $modelDate, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\App\RequestInterface $request, \Magento\Framework\Stdlib\DateTime $dateTime, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], \Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot $documentRoot=null, ItemProviderInterface $itemProvider=null, SitemapConfigReaderInterface $configReader=null, \Magento\Sitemap\Model\SitemapItemInterfaceFactory $sitemapItemFactory=null)

	addSitemapItem (DataObject $sitemapItem)

	beforeSave ()

	getSitemapUrl ($sitemapPath, $sitemapFileName)

	getIdentities ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	OPEN_TAG_KEY = 'start'

const	CLOSE_TAG_KEY = 'end'

const	INDEX_FILE_PREFIX = 'sitemap'

const	TYPE_INDEX = 'sitemap'

const	TYPE_URL = 'url'

const	LAST_MOD_MIN_VAL = '0000-01-01 00:00:00'

Protected Member Functions
	_construct ()

	_getStream ()

	_initSitemapItems ()

	_createSitemapIndex ()

	_getCurrentDateTime ()

	_isSplitRequired ($row)

	_getSitemapRow ($url, $lastmod=null, $changefreq=null, $priority=null, $images=null)

	_getSitemapIndexRow ($sitemapFilename, $lastmod=null)

	_createSitemap ($fileName=null, $type=self::TYPE_URL)

	_writeSitemapRow ($row)

	_finalizeSitemap ($type=self::TYPE_URL)

	_getCurrentSitemapFilename ($index)

	_getBaseDir ()

	_getUrl ($url, $type=UrlInterface::URL_TYPE_LINK)

	_getMediaUrl ($url)

	_getFormattedLastmodDate ($date)

	_getDocumentRoot ()

	_getStoreBaseDomain ()

	_isEnabledSubmissionRobots ()

	_addSitemapToRobotsTxt ($sitemapFileName)

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_filePath

	$_sitemapItems = []

	$_sitemapIncrement = 0

	$_tags = []

	$_lineCount = 0

	$_fileSize = 0

	$_directory

	$_stream

	$_sitemapData

	$_escaper

	$_categoryFactory

	$_productFactory

	$_cmsFactory

	$_dateModel

	$_storeManager

	$_request

	$dateTime

	$_cacheTag = true

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@method string getSitemapType() @method \Magento\Sitemap\Model\Sitemap setSitemapType(string $value) @method string getSitemapFilename() @method \Magento\Sitemap\Model\Sitemap setSitemapFilename(string $value) @method string getSitemapPath() @method \Magento\Sitemap\Model\Sitemap setSitemapPath(string $value) @method string getSitemapTime() @method \Magento\Sitemap\Model\Sitemap setSitemapTime(string $value) @method int getStoreId() @method \Magento\Sitemap\Model\Sitemap setStoreId(int $value) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 33 of file Sitemap.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Escaper	$escaper,
		\Magento\Sitemap\Helper\Data	$sitemapData,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Sitemap\Model\ResourceModel\Catalog\CategoryFactory	$categoryFactory,
		\Magento\Sitemap\Model\ResourceModel\Catalog\ProductFactory	$productFactory,
		\Magento\Sitemap\Model\ResourceModel\Cms\PageFactory	$cmsFactory,
		\Magento\Framework\Stdlib\DateTime\DateTime	$modelDate,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\App\RequestInterface	$request,
		\Magento\Framework\Stdlib\DateTime	$dateTime,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		\Magento\Config\Model\Config\Reader\Source\Deployed\DocumentRoot	$documentRoot = `null`,
		ItemProviderInterface	$itemProvider = `null`,
		SitemapConfigReaderInterface	$configReader = `null`,
		\Magento\Sitemap\Model\SitemapItemInterfaceFactory	$sitemapItemFactory = `null`
	)

Initialize dependencies.

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Escaper	$escaper
\Magento\Sitemap\Helper\Data	$sitemapData
\Magento\Framework\Filesystem	$filesystem
ResourceModel\Catalog\CategoryFactory	$categoryFactory
ResourceModel\Catalog\ProductFactory	$productFactory
ResourceModel\Cms\PageFactory	$cmsFactory
\Magento\Framework\Stdlib\DateTime\DateTime	$modelDate
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\App\RequestInterface	$request
\Magento\Framework\Stdlib\DateTime	$dateTime
\Magento\Framework\Model\ResourceModel\AbstractResource \| null	$resource
\Magento\Framework\Data\Collection\AbstractDb \| null	$resourceCollection
array	$data
DocumentRoot \| null	$documentRoot
ItemProviderInterface \| null	$itemProvider
SitemapConfigReaderInterface \| null	$configReader
\Magento\Sitemap\Model\SitemapItemInterfaceFactory \| null	$sitemapItemFactory	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 216 of file Sitemap.php.

       {
         $this->_escaper = $escaper;
         $this->_sitemapData = $sitemapData;
         $documentRoot = $documentRoot ?: ObjectManager::getInstance()->get(DocumentRoot::class);
         $this->_directory = $filesystem->getDirectoryWrite($documentRoot->getPath());
         $this->_categoryFactory = $categoryFactory;
         $this->_productFactory = $productFactory;
         $this->_cmsFactory = $cmsFactory;
         $this->_dateModel = $modelDate;
         $this->_storeManager = $storeManager;
         $this->_request = $request;
         $this->dateTime = $dateTime;
         $this->itemProvider = $itemProvider ?: ObjectManager::getInstance()->get(ItemProviderInterface::class);
         $this->configReader = $configReader ?: ObjectManager::getInstance()->get(SitemapConfigReaderInterface::class);
         $this->sitemapItemFactory = $sitemapItemFactory ?: ObjectManager::getInstance()->get(
             \Magento\Sitemap\Model\SitemapItemInterfaceFactory::class
         );
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _addSitemapToRobotsTxt()

_addSitemapToRobotsTxt ( $sitemapFileName )

protected

Add sitemap file to robots.txt

Parameters

string $sitemapFileName

Returns: void

Deprecated:: Because the robots.txt file is not generated anymore, this method is not needed and will be removed in major release.

Definition at line 785 of file Sitemap.php.

     {
         $robotsSitemapLine = 'Sitemap: ' . $this->getSitemapUrl($this->getSitemapPath(), $sitemapFileName);
 
         $filename = 'robots.txt';
         $content = '';
         if ($this->_directory->isExist($filename)) {
             $content = $this->_directory->readFile($filename);
         }
 
         if (strpos($content, $robotsSitemapLine) === false) {
             if (!empty($content)) {
                 $content .= $this->_findNewLinesDelimiter($content);
             }
             $content .= $robotsSitemapLine;
         }
 
         $this->_directory->writeFile($filename, $content);
     }

◆ _construct()

_construct ( )

protected

Init model

Returns: void

Definition at line 261 of file Sitemap.php.

     {
         $this->_init(SitemapResource::class);
     }

◆ _createSitemap()

_createSitemap	(	$fileName = `null`,
		$type = `self::TYPE_URL`
	)

protected

Create new sitemap file

Parameters

null \| string	$fileName
string	$type

Returns: void

Exceptions

LocalizedException

Definition at line 597 of file Sitemap.php.

     {
         if (!$fileName) {
             $this->_sitemapIncrement++;
             $fileName = $this->_getCurrentSitemapFilename($this->_sitemapIncrement);
         }
 
         $path = rtrim($this->getSitemapPath(), '/') . '/' . $fileName;
         $this->_stream = $this->_directory->openFile($path);
 
         $fileHeader = sprintf($this->_tags[$type][self::OPEN_TAG_KEY], $type);
         $this->_stream->write($fileHeader);
         $this->_fileSize = strlen($fileHeader . sprintf($this->_tags[$type][self::CLOSE_TAG_KEY], $type));
     }

◆ _createSitemapIndex()

_createSitemapIndex ( )

protected

Generate sitemap index XML file

Returns: void

Definition at line 482 of file Sitemap.php.

     {
         $this->_createSitemap($this->getSitemapFilename(), self::TYPE_INDEX);
         for ($i = 1; $i <= $this->_sitemapIncrement; $i++) {
             $xml = $this->_getSitemapIndexRow($this->_getCurrentSitemapFilename($i), $this->_getCurrentDateTime());
             $this->_writeSitemapRow($xml);
         }
         $this->_finalizeSitemap(self::TYPE_INDEX);
     }

◆ _finalizeSitemap()

_finalizeSitemap ( $type = self::TYPE_URL )

protected

Write closing tag and close stream

Parameters

string $type

Returns: void

Definition at line 629 of file Sitemap.php.

     {
         if ($this->_stream) {
             $this->_stream->write(sprintf($this->_tags[$type][self::CLOSE_TAG_KEY], $type));
             $this->_stream->close();
         }
 
         // Reset all counters
         $this->_lineCount = 0;
         $this->_fileSize = 0;
     }

◆ _getBaseDir()

_getBaseDir ( )

protected

Get base dir

Returns: string

Definition at line 657 of file Sitemap.php.

     {
         return $this->_directory->getAbsolutePath();
     }

◆ _getCurrentDateTime()

_getCurrentDateTime ( )

protected

Get current date time

Returns: string

Definition at line 497 of file Sitemap.php.

     {
         return (new \DateTime())->format(\Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT);
     }

◆ _getCurrentSitemapFilename()

_getCurrentSitemapFilename ( $index )

protected

Get current sitemap filename

Parameters

int $index

Returns: string

Definition at line 647 of file Sitemap.php.

     {
         return str_replace('.xml', '', $this->getSitemapFilename()) . '-' . $this->getStoreId() . '-' . $index . '.xml';
     }

◆ _getDocumentRoot()

_getDocumentRoot ( )

protected

Get Document root of Magento instance

Returns: string

Definition at line 721 of file Sitemap.php.

     {
         return realpath($this->_request->getServer('DOCUMENT_ROOT'));
     }

◆ _getFormattedLastmodDate()

_getFormattedLastmodDate ( $date )

protected

Get date in correct format applicable for lastmod attribute

Parameters

string $date

Returns: string

Definition at line 707 of file Sitemap.php.

     {
         if ($this->lastModMinTsVal === null) {
             $this->lastModMinTsVal = strtotime(self::LAST_MOD_MIN_VAL);
         }
         $timestamp = max(strtotime($date), $this->lastModMinTsVal);
         return date('c', $timestamp);
     }

◆ _getMediaUrl()

_getMediaUrl ( $url )

protected

Get media url

Parameters

string $url

Returns: string

Deprecated:: No longer used, as we're generating product image URLs inside collection instead

See also: \Magento\Sitemap\Model\ResourceModel\Catalog\Product::_loadProductImages()

Definition at line 696 of file Sitemap.php.

     {
         return $this->_getUrl($url, UrlInterface::URL_TYPE_MEDIA);
     }

◆ _getSitemapIndexRow()

_getSitemapIndexRow	(	$sitemapFilename,
		$lastmod = `null`
	)

protected

Get sitemap index row

Parameters

string	$sitemapFilename
null \| string	$lastmod

Returns: string

Definition at line 578 of file Sitemap.php.

     {
         $url = $this->getSitemapUrl($this->getSitemapPath(), $sitemapFilename);
         $row = '<loc>' . htmlspecialchars($url) . '</loc>';
         if ($lastmod) {
             $row .= '<lastmod>' . $this->_getFormattedLastmodDate($lastmod) . '</lastmod>';
         }
 
         return '<sitemap>' . $row . '</sitemap>';
     }

◆ _getSitemapRow()

_getSitemapRow	(	$url,
		$lastmod = `null`,
		$changefreq = `null`,
		$priority = `null`,
		$images = `null`
	)

protected

Get sitemap row

Parameters

string	$url
null \| string	$lastmod
null \| string	$changefreq
null \| string	$priority
null \| array \| \Magento\Framework\DataObject	$images

Returns: string Sitemap images

See also: http://support.google.com/webmasters/bin/answer.py?hl=en&answer=178636

Sitemap PageMap

See also: http://support.google.com/customsearch/bin/answer.py?hl=en&answer=1628213

Definition at line 537 of file Sitemap.php.

     {
         $url = $this->_getUrl($url);
         $row = '<loc>' . htmlspecialchars($url) . '</loc>';
         if ($lastmod) {
             $row .= '<lastmod>' . $this->_getFormattedLastmodDate($lastmod) . '</lastmod>';
         }
         if ($changefreq) {
             $row .= '<changefreq>' . $changefreq . '</changefreq>';
         }
         if ($priority) {
             $row .= sprintf('<priority>%.1f</priority>', $priority);
         }
         if ($images) {
             // Add Images to sitemap
             foreach ($images->getCollection() as $image) {
                 $row .= '<image:image>';
                 $row .= '<image:loc>' . htmlspecialchars($image->getUrl()) . '</image:loc>';
                 $row .= '<image:title>' . htmlspecialchars($images->getTitle()) . '</image:title>';
                 if ($image->getCaption()) {
                     $row .= '<image:caption>' . htmlspecialchars($image->getCaption()) . '</image:caption>';
                 }
                 $row .= '</image:image>';
             }
             // Add PageMap image for Google web search
             $row .= '<PageMap xmlns="http://www.google.com/schemas/sitemap-pagemap/1.0"><DataObject type="thumbnail">';
             $row .= '<Attribute name="name" value="' . htmlspecialchars($images->getTitle()) . '"/>';
             $row .= '<Attribute name="src" value="' . htmlspecialchars($images->getThumbnail()) . '"/>';
             $row .= '</DataObject></PageMap>';
         }
 
         return '<url>' . $row . '</url>';
     }

◆ _getStoreBaseDomain()

_getStoreBaseDomain ( )

protected

Get domain from store base url

Returns: string

Definition at line 731 of file Sitemap.php.

     {
         $storeParsedUrl = parse_url($this->_getStoreBaseUrl());
         $url = $storeParsedUrl['scheme'] . '://' . $storeParsedUrl['host'];
 
         $documentRoot = trim(str_replace('\\', '/', $this->_getDocumentRoot()), '/');
         $baseDir = trim(str_replace('\\', '/', $this->_getBaseDir()), '/');
 
         if (strpos($baseDir, $documentRoot) === 0) {
             //case when basedir is in document root
             $installationFolder = trim(str_replace($documentRoot, '', $baseDir), '/');
             $storeDomain = rtrim($url . '/' . $installationFolder, '/');
         } else {
             //case when documentRoot contains symlink to basedir
             $url = $this->_getStoreBaseUrl(UrlInterface::URL_TYPE_WEB);
             $storeDomain = rtrim($url, '/');
         }
 
         return $storeDomain;
     }

◆ _getStream()

_getStream ( )

protected

Get file handler

Returns: \Magento\Framework\Filesystem\File\WriteInterface

Exceptions

LocalizedException

Definition at line 272 of file Sitemap.php.

     {
         if ($this->_stream) {
             return $this->_stream;
         } else {
             throw new LocalizedException(__('File handler unreachable'));
         }
     }

◆ _getUrl()

_getUrl	(	$url,
		$type = `UrlInterface::URL_TYPE_LINK`
	)

protected

Get url

Parameters

string	$url
string	$type

Returns: string

Definition at line 683 of file Sitemap.php.

     {
         return $this->_getStoreBaseUrl($type) . ltrim($url, '/');
     }

◆ _initSitemapItems()

_initSitemapItems ( )

protected

Initialize sitemap

Returns: void

Definition at line 339 of file Sitemap.php.

     {
         $sitemapItems = $this->itemProvider->getItems($this->getStoreId());
         $mappedItems = $this->mapToSitemapItem();
         $this->_sitemapItems = array_merge($sitemapItems, $mappedItems);
 
         $this->_tags = [
             self::TYPE_INDEX => [
                 self::OPEN_TAG_KEY => '<?xml version="1.0" encoding="UTF-8"?>' .
                     PHP_EOL .
                     '<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' .
                     PHP_EOL,
                 self::CLOSE_TAG_KEY => '</sitemapindex>',
             ],
             self::TYPE_URL => [
                 self::OPEN_TAG_KEY => '<?xml version="1.0" encoding="UTF-8"?>' .
                     PHP_EOL .
                     '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"' .
                     ' xmlns:content="http://www.google.com/schemas/sitemap-content/1.0"' .
                     ' xmlns:image="http://www.google.com/schemas/sitemap-image/1.1">' .
                     PHP_EOL,
                 self::CLOSE_TAG_KEY => '</urlset>',
             ],
         ];
     }

◆ _isEnabledSubmissionRobots()

_isEnabledSubmissionRobots ( )

protected

Check is enabled submission to robots.txt

Returns: bool

Deprecated:: Because the robots.txt file is not generated anymore, this method is not needed and will be removed in major release.

Definition at line 771 of file Sitemap.php.

     {
         $storeId = $this->getStoreId();
         return (bool)$this->configReader->getEnableSubmissionRobots($storeId);
     }

◆ _isSplitRequired()

_isSplitRequired ( $row )

protected

Check is split required

Parameters

string $row

Returns: bool

Definition at line 508 of file Sitemap.php.

     {
         $storeId = $this->getStoreId();
         if ($this->_lineCount + 1 > $this->configReader->getMaximumLinesNumber($storeId)) {
             return true;
         }
 
         if ($this->_fileSize + strlen($row) > $this->configReader->getMaximumFileSize($storeId)) {
             return true;
         }
 
         return false;
     }

◆ _writeSitemapRow()

_writeSitemapRow ( $row )

protected

Write sitemap row

Parameters

string $row

Returns: void

Definition at line 618 of file Sitemap.php.

     {
         $this->_getStream()->write($row . PHP_EOL);
     }

◆ addSitemapItem()

addSitemapItem ( DataObject $sitemapItem )

Add a sitemap item to the array of sitemap items

Parameters

DataObject $sitemapItem

Returns: $this

Deprecated:: 100.2.0

See also: ItemProviderInterface

Definition at line 289 of file Sitemap.php.

     {
         $this->_sitemapItems[] = $sitemapItem;
 
         return $this;
     }

◆ beforeSave()

beforeSave ( )

Check sitemap file location and permissions

Returns: \Magento\Framework\Model\AbstractModel

Exceptions

LocalizedException

Check path is allow

Check exists and writable path

Check allow filename

Definition at line 371 of file Sitemap.php.

     {
         $path = $this->getSitemapPath();
 
         if ($path && preg_match('#\.\.[\\\/]#', $path)) {
             throw new LocalizedException(__('Please define a correct path.'));
         }
         if (!$this->_directory->isExist($path)) {
             throw new LocalizedException(
                 __(
                     'Please create the specified folder "%1" before saving the sitemap.',
                     $this->_escaper->escapeHtml($this->getSitemapPath())
                 )
             );
         }
 
         if (!$this->_directory->isWritable($path)) {
             throw new LocalizedException(
                 __('Please make sure that "%1" is writable by the web-server.', $this->getSitemapPath())
             );
         }
         if (!preg_match('#^[a-zA-Z0-9_\.]+$#', $this->getSitemapFilename())) {
             throw new LocalizedException(
                 __(
                     'Please use only letters (a-z or A-Z), numbers (0-9) or underscores (_) in the filename.'
                     . ' No spaces or other characters are allowed.'
                 )
             );
         }
         if (!preg_match('#\.xml$#', $this->getSitemapFilename())) {
             $this->setSitemapFilename($this->getSitemapFilename() . '.xml');
         }
 
         $this->setSitemapPath(rtrim(str_replace(str_replace('\\', '/', $this->_getBaseDir()), '', $path), '/') . '/');
 
         return parent::beforeSave();
     }

◆ getIdentities()

getIdentities ( )

Get unique page cache identities

Returns: array

Since: 100.1.5

Implements IdentityInterface.

Definition at line 852 of file Sitemap.php.

     {
         return [
             Value::CACHE_TAG . '_' . $this->getStoreId(),
         ];
     }

◆ getSitemapUrl()

getSitemapUrl	(	$sitemapPath,
		$sitemapFileName
	)

Get sitemap.xml URL according to all config options

Parameters

string	$sitemapPath
string	$sitemapFileName

Returns: string

Definition at line 759 of file Sitemap.php.

     {
         return $this->_getStoreBaseDomain() . str_replace('//', '/', $sitemapPath . '/' . $sitemapFileName);
     }

Field Documentation

◆ $_cacheTag

$_cacheTag = true

protected

Definition at line 162 of file Sitemap.php.

◆ $_categoryFactory

$_categoryFactory

protected

Definition at line 124 of file Sitemap.php.

◆ $_cmsFactory

$_cmsFactory

protected

Definition at line 134 of file Sitemap.php.

◆ $_dateModel

$_dateModel

protected

Definition at line 139 of file Sitemap.php.

◆ $_directory

$_directory

protected

Definition at line 102 of file Sitemap.php.

◆ $_escaper

$_escaper

protected

Definition at line 119 of file Sitemap.php.

◆ $_filePath

$_filePath

protected

Definition at line 55 of file Sitemap.php.

◆ $_fileSize

$_fileSize = 0

protected

Definition at line 90 of file Sitemap.php.

◆ $_lineCount

$_lineCount = 0

protected

Definition at line 83 of file Sitemap.php.

◆ $_productFactory

$_productFactory

protected

Definition at line 129 of file Sitemap.php.

◆ $_request

$_request

protected

Definition at line 149 of file Sitemap.php.

◆ $_sitemapData

$_sitemapData

protected

Definition at line 114 of file Sitemap.php.

◆ $_sitemapIncrement

$_sitemapIncrement = 0

protected

Definition at line 69 of file Sitemap.php.

◆ $_sitemapItems

$_sitemapItems = []

protected

Definition at line 62 of file Sitemap.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 144 of file Sitemap.php.

◆ $_stream

$_stream

protected

Definition at line 107 of file Sitemap.php.

◆ $_tags

$_tags = []

protected

Definition at line 76 of file Sitemap.php.

◆ $dateTime

$dateTime

protected

Definition at line 154 of file Sitemap.php.

◆ CLOSE_TAG_KEY

const CLOSE_TAG_KEY = 'end'

Definition at line 37 of file Sitemap.php.

◆ INDEX_FILE_PREFIX

const INDEX_FILE_PREFIX = 'sitemap'

Definition at line 39 of file Sitemap.php.

◆ LAST_MOD_MIN_VAL

const LAST_MOD_MIN_VAL = '0000-01-01 00:00:00'

Last mode date min value

Definition at line 48 of file Sitemap.php.

◆ OPEN_TAG_KEY

const OPEN_TAG_KEY = 'start'

Definition at line 35 of file Sitemap.php.

◆ TYPE_INDEX

const TYPE_INDEX = 'sitemap'

Definition at line 41 of file Sitemap.php.

◆ TYPE_URL

const TYPE_URL = 'url'

Definition at line 43 of file Sitemap.php.

The documentation for this class was generated from the following file:

vendor/magento/module-sitemap/Model/Sitemap.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addSitemapToRobotsTxt()

◆ _construct()

◆ _createSitemap()

◆ _createSitemapIndex()

◆ _finalizeSitemap()

◆ _getBaseDir()

◆ _getCurrentDateTime()

◆ _getCurrentSitemapFilename()

◆ _getDocumentRoot()

◆ _getFormattedLastmodDate()

◆ _getMediaUrl()

◆ _getSitemapIndexRow()

◆ _getSitemapRow()

◆ _getStoreBaseDomain()

◆ _getStream()

◆ _getUrl()

◆ _initSitemapItems()

◆ _isEnabledSubmissionRobots()

◆ _isSplitRequired()

◆ _writeSitemapRow()

◆ addSitemapItem()

◆ beforeSave()

◆ getIdentities()

◆ getSitemapUrl()

Field Documentation

◆ $_cacheTag

◆ $_categoryFactory

◆ $_cmsFactory

◆ $_dateModel

◆ $_directory

◆ $_escaper

◆ $_filePath

◆ $_fileSize

◆ $_lineCount

◆ $_productFactory

◆ $_request

◆ $_sitemapData

◆ $_sitemapIncrement

◆ $_sitemapItems

◆ $_storeManager

◆ $_stream

◆ $_tags

◆ $dateTime

◆ CLOSE_TAG_KEY

◆ INDEX_FILE_PREFIX

◆ LAST_MOD_MIN_VAL

◆ OPEN_TAG_KEY

◆ TYPE_INDEX

◆ TYPE_URL