Inheritance diagram for Data:

Public Member Functions
	getMaximumLinesNumber ($storeId)

	getMaximumFileSize ($storeId)

	getCategoryChangefreq ($storeId)

	getProductChangefreq ($storeId)

	getPageChangefreq ($storeId)

	getCategoryPriority ($storeId)

	getProductPriority ($storeId)

	getPagePriority ($storeId)

	getEnableSubmissionRobots ($storeId)

	getProductImageIncludePolicy ($storeId)

	getValidPaths ()

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_SITEMAP_VALID_PATHS = 'sitemap/file/valid_paths'

const	XML_PATH_PUBLIC_FILES_VALID_PATHS = 'general/file/public_files_valid_paths'

const	XML_PATH_MAX_LINES = 'sitemap/limit/max_lines'

const	XML_PATH_MAX_FILE_SIZE = 'sitemap/limit/max_file_size'

const	XML_PATH_CATEGORY_CHANGEFREQ = 'sitemap/category/changefreq'

const	XML_PATH_PRODUCT_CHANGEFREQ = 'sitemap/product/changefreq'

const	XML_PATH_PAGE_CHANGEFREQ = 'sitemap/page/changefreq'

const	XML_PATH_CATEGORY_PRIORITY = 'sitemap/category/priority'

const	XML_PATH_PRODUCT_PRIORITY = 'sitemap/product/priority'

const	XML_PATH_PAGE_PRIORITY = 'sitemap/page/priority'

const	XML_PATH_SUBMISSION_ROBOTS = 'sitemap/search_engines/submission_robots'

const	XML_PATH_PRODUCT_IMAGES_INCLUDE = 'sitemap/product/image_include'

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Detailed Description

Deprecated:

Definition at line 17 of file Data.php.

Member Function Documentation

◆ getCategoryChangefreq()

getCategoryChangefreq ( $storeId )

Get category change frequency

Parameters

int $storeId

Returns: string

Deprecated:

See also: CategoryConfigReader::getChangeFrequency()

Definition at line 110 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_CATEGORY_CHANGEFREQ,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getCategoryPriority()

getCategoryPriority ( $storeId )

Get category priority

Parameters

int $storeId

Returns: string

Deprecated:

See also: CategoryConfigReader::getPriority()

Definition at line 161 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_CATEGORY_PRIORITY,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getEnableSubmissionRobots()

getEnableSubmissionRobots ( $storeId )

Get enable Submission to Robots.txt

Parameters

int $storeId

Returns: int

Deprecated:

See also: SitemapConfigReader::getEnableSubmissionRobots()

Definition at line 212 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_SUBMISSION_ROBOTS,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getMaximumFileSize()

getMaximumFileSize ( $storeId )

Get maximum sitemap.xml file size in bytes

Parameters

int $storeId

Returns: int

Deprecated:

See also: SitemapConfigReader::getMaximumFileSize()

Definition at line 93 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_MAX_FILE_SIZE,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getMaximumLinesNumber()

getMaximumLinesNumber ( $storeId )

Get maximum sitemap.xml URLs number

Parameters

int $storeId

Returns: int

Deprecated:

See also: SitemapConfigReader::getMaximumLinesNumber()

Definition at line 76 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_MAX_LINES,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getPageChangefreq()

getPageChangefreq ( $storeId )

Get page change frequency

Parameters

int $storeId

Returns: string

Deprecated:

See also: CmsPageConfigReader::getChangeFrequency()

Definition at line 144 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_PAGE_CHANGEFREQ,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getPagePriority()

getPagePriority ( $storeId )

Get page priority

Parameters

int $storeId

Returns: string

Deprecated:

See also: CmsPageConfigReader::getPriority()

Definition at line 195 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_PAGE_PRIORITY,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getProductChangefreq()

getProductChangefreq ( $storeId )

Get product change frequency

Parameters

int $storeId

Returns: string

Deprecated:

See also: ProductConfigReader::getChangeFrequency()

Definition at line 127 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_PRODUCT_CHANGEFREQ,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getProductImageIncludePolicy()

getProductImageIncludePolicy ( $storeId )

Get product image include policy

Parameters

int $storeId

Returns: string

Deprecated:

See also: SitemapConfigReader::getProductImageIncludePolicy()

Definition at line 229 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_PRODUCT_IMAGES_INCLUDE,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getProductPriority()

getProductPriority ( $storeId )

Get product priority

Parameters

int $storeId

Returns: string

Deprecated:

See also: ProductConfigReader::getPriority()

Definition at line 178 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_PRODUCT_PRIORITY,
             ScopeInterface::SCOPE_STORE,
             $storeId
         );
     }

◆ getValidPaths()

getValidPaths ( )

Get list valid paths for generate a sitemap XML file

Returns: string[]

Deprecated:

See also: SitemapConfigReader::getValidPaths()

Definition at line 245 of file Data.php.

     {
         return array_merge(
             $this->scopeConfig->getValue(self::XML_PATH_SITEMAP_VALID_PATHS, ScopeInterface::SCOPE_STORE),
             $this->scopeConfig->getValue(self::XML_PATH_PUBLIC_FILES_VALID_PATHS, ScopeInterface::SCOPE_STORE)
         );
     }

Field Documentation

◆ XML_PATH_CATEGORY_CHANGEFREQ

const XML_PATH_CATEGORY_CHANGEFREQ = 'sitemap/category/changefreq'

#- #+ Change frequency xpath config settings

Definition at line 41 of file Data.php.

◆ XML_PATH_CATEGORY_PRIORITY

const XML_PATH_CATEGORY_PRIORITY = 'sitemap/category/priority'

#- #+ Change frequency xpath config settings

Definition at line 52 of file Data.php.

◆ XML_PATH_MAX_FILE_SIZE

const XML_PATH_MAX_FILE_SIZE = 'sitemap/limit/max_file_size'

Definition at line 34 of file Data.php.

◆ XML_PATH_MAX_LINES

const XML_PATH_MAX_LINES = 'sitemap/limit/max_lines'

#+ Limits xpath config settings

Definition at line 32 of file Data.php.

◆ XML_PATH_PAGE_CHANGEFREQ

const XML_PATH_PAGE_CHANGEFREQ = 'sitemap/page/changefreq'

Definition at line 45 of file Data.php.

◆ XML_PATH_PAGE_PRIORITY

const XML_PATH_PAGE_PRIORITY = 'sitemap/page/priority'

Definition at line 56 of file Data.php.

◆ XML_PATH_PRODUCT_CHANGEFREQ

const XML_PATH_PRODUCT_CHANGEFREQ = 'sitemap/product/changefreq'

Definition at line 43 of file Data.php.

◆ XML_PATH_PRODUCT_IMAGES_INCLUDE

const XML_PATH_PRODUCT_IMAGES_INCLUDE = 'sitemap/product/image_include'

#-

Definition at line 66 of file Data.php.

◆ XML_PATH_PRODUCT_PRIORITY

const XML_PATH_PRODUCT_PRIORITY = 'sitemap/product/priority'

Definition at line 54 of file Data.php.

◆ XML_PATH_PUBLIC_FILES_VALID_PATHS

const XML_PATH_PUBLIC_FILES_VALID_PATHS = 'general/file/public_files_valid_paths'

Config path to valid file paths

Definition at line 27 of file Data.php.

◆ XML_PATH_SITEMAP_VALID_PATHS

const XML_PATH_SITEMAP_VALID_PATHS = 'sitemap/file/valid_paths'

Config path to sitemap valid paths

Definition at line 22 of file Data.php.

◆ XML_PATH_SUBMISSION_ROBOTS

const XML_PATH_SUBMISSION_ROBOTS = 'sitemap/search_engines/submission_robots'

#- #+ Search Engine Submission Settings

Definition at line 63 of file Data.php.

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

vendor/magento/module-sitemap/Helper/Data.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCategoryChangefreq()

◆ getCategoryPriority()

◆ getEnableSubmissionRobots()

◆ getMaximumFileSize()

◆ getMaximumLinesNumber()

◆ getPageChangefreq()

◆ getPagePriority()

◆ getProductChangefreq()

◆ getProductImageIncludePolicy()

◆ getProductPriority()

◆ getValidPaths()

Field Documentation

◆ XML_PATH_CATEGORY_CHANGEFREQ

◆ XML_PATH_CATEGORY_PRIORITY

◆ XML_PATH_MAX_FILE_SIZE

◆ XML_PATH_MAX_LINES

◆ XML_PATH_PAGE_CHANGEFREQ

◆ XML_PATH_PAGE_PRIORITY

◆ XML_PATH_PRODUCT_CHANGEFREQ

◆ XML_PATH_PRODUCT_IMAGES_INCLUDE

◆ XML_PATH_PRODUCT_PRIORITY

◆ XML_PATH_PUBLIC_FILES_VALID_PATHS

◆ XML_PATH_SITEMAP_VALID_PATHS

◆ XML_PATH_SUBMISSION_ROBOTS