SitemapConfigReader Class Reference

Inheritance diagram for SitemapConfigReader:

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig)
	getEnableSubmissionRobots ($storeId)
	getMaximumFileSize ($storeId)
	getMaximumLinesNumber ($storeId)
	getProductImageIncludePolicy ($storeId)
	getValidPaths ()

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_SUBMISSION_ROBOTS = 'sitemap/search_engines/submission_robots'
const	XML_PATH_PRODUCT_IMAGES_INCLUDE = 'sitemap/product/image_include'

Detailed Description

Definition at line 12 of file SitemapConfigReader.php.

Constructor & Destructor Documentation

__construct()

__construct

(

ScopeConfigInterface

$scopeConfig

)

Sitemap Config Reader constructor.

Parameters

ScopeConfigInterface

$scopeConfig

Definition at line 53 of file SitemapConfigReader.php.

    {
        $this->scopeConfig = $scopeConfig;
    }

Member Function Documentation

getEnableSubmissionRobots()

getEnableSubmissionRobots

(

$storeId

)

{Get enable Submission to Robots.txt

Parameters

int

$storeId

Returns

int

}

Implements SitemapConfigReaderInterface.

Definition at line 61 of file SitemapConfigReader.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

}

Implements SitemapConfigReaderInterface.

Definition at line 73 of file SitemapConfigReader.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

}

Implements SitemapConfigReaderInterface.

Definition at line 85 of file SitemapConfigReader.php.

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

getProductImageIncludePolicy()

getProductImageIncludePolicy

(

$storeId

)

{Get product image include policy

Parameters

int

$storeId

Returns

string

}

Implements SitemapConfigReaderInterface.

Definition at line 97 of file SitemapConfigReader.php.

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

getValidPaths()

getValidPaths

(

)

{Get list valid paths for generate a sitemap XML file

Returns

string[]

}

Implements SitemapConfigReaderInterface.

Definition at line 109 of file SitemapConfigReader.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_MAX_FILE_SIZE

const XML_PATH_MAX_FILE_SIZE = 'sitemap/limit/max_file_size'

Definition at line 28 of file SitemapConfigReader.php.

XML_PATH_MAX_LINES

const XML_PATH_MAX_LINES = 'sitemap/limit/max_lines'

#+ Limits xpath config settings

Definition at line 27 of file SitemapConfigReader.php.

XML_PATH_PRODUCT_IMAGES_INCLUDE

const XML_PATH_PRODUCT_IMAGES_INCLUDE = 'sitemap/product/image_include'

Include product image setting

Definition at line 39 of file SitemapConfigReader.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 22 of file SitemapConfigReader.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 17 of file SitemapConfigReader.php.

XML_PATH_SUBMISSION_ROBOTS

const XML_PATH_SUBMISSION_ROBOTS = 'sitemap/search_engines/submission_robots'

#- Search Engine Submission Settings

Definition at line 34 of file SitemapConfigReader.php.

---

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

• vendor/magento/module-sitemap/Model/SitemapConfigReader.php