Observer Class Reference

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Sitemap\Model\ResourceModel\Sitemap\CollectionFactory $collectionFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder, \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation)
	scheduledGenerateSitemaps ()

Data Fields
const	XML_PATH_GENERATION_ENABLED = 'sitemap/generate/enabled'
const	XML_PATH_CRON_EXPR = 'crontab/default/jobs/generate_sitemaps/schedule/cron_expr'
const	XML_PATH_ERROR_TEMPLATE = 'sitemap/generate/error_email_template'
const	XML_PATH_ERROR_IDENTITY = 'sitemap/generate/error_email_identity'
const	XML_PATH_ERROR_RECIPIENT = 'sitemap/generate/error_email'

Protected Attributes
	$_scopeConfig
	$_collectionFactory
	$_transportBuilder
	$_storeManager
	$inlineTranslation

Detailed Description

Sitemap module observer

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 13 of file Observer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Sitemap\Model\ResourceModel\Sitemap\CollectionFactory	$collectionFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder,
		\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Sitemap\Model\ResourceModel\Sitemap\CollectionFactory	$collectionFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder
\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation

Definition at line 76 of file Observer.php.

      {
        $this->_scopeConfig = $scopeConfig;
        $this->_collectionFactory = $collectionFactory;
        $this->_storeManager = $storeManager;
        $this->_transportBuilder = $transportBuilder;
        $this->inlineTranslation = $inlineTranslation;
    }

Member Function Documentation

scheduledGenerateSitemaps()

scheduledGenerateSitemaps

(

)

Generate sitemaps

Returns

void

Exceptions

Definition at line 97 of file Observer.php.

    {
        $errors = [];

        // check if scheduled generation enabled
        if (!$this->_scopeConfig->isSetFlag(
            self::XML_PATH_GENERATION_ENABLED,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        )
        ) {
            return;
        }

        $collection = $this->_collectionFactory->create();
        /* @var $collection \Magento\Sitemap\Model\ResourceModel\Sitemap\Collection */
        foreach ($collection as $sitemap) {
            /* @var $sitemap \Magento\Sitemap\Model\Sitemap */
            try {
                $sitemap->generateXml();
            } catch (\Exception $e) {
                $errors[] = $e->getMessage();
            }
        }

        if ($errors && $this->_scopeConfig->getValue(
            self::XML_PATH_ERROR_RECIPIENT,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        )
        ) {
            $this->inlineTranslation->suspend();

            $this->_transportBuilder->setTemplateIdentifier(
                $this->_scopeConfig->getValue(
                    self::XML_PATH_ERROR_TEMPLATE,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                )
            )->setTemplateOptions(
                [
                    'area' => \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE,
                    'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID,
                ]
            )->setTemplateVars(
                ['warnings' => join("\n", $errors)]
            )->setFrom(
                $this->_scopeConfig->getValue(
                    self::XML_PATH_ERROR_IDENTITY,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                )
            )->addTo(
                $this->_scopeConfig->getValue(
                    self::XML_PATH_ERROR_RECIPIENT,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                )
            );
            $transport = $this->_transportBuilder->getTransport();
            $transport->sendMessage();

            $this->inlineTranslation->resume();
        }
    }

Field Documentation

$_collectionFactory

$_collectionFactory

protected

Definition at line 52 of file Observer.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 47 of file Observer.php.

$_storeManager

$_storeManager

protected

Definition at line 62 of file Observer.php.

$_transportBuilder

$_transportBuilder

protected

Definition at line 57 of file Observer.php.

$inlineTranslation

$inlineTranslation

protected

Definition at line 67 of file Observer.php.

XML_PATH_CRON_EXPR

const XML_PATH_CRON_EXPR = 'crontab/default/jobs/generate_sitemaps/schedule/cron_expr'

Cronjob expression configuration

Deprecated:

Use \Magento\Cron\Model\Config\Backend\Sitemap::CRON_STRING_PATH instead.

Definition at line 25 of file Observer.php.

XML_PATH_ERROR_IDENTITY

const XML_PATH_ERROR_IDENTITY = 'sitemap/generate/error_email_identity'

Error email identity configuration

Definition at line 35 of file Observer.php.

XML_PATH_ERROR_RECIPIENT

const XML_PATH_ERROR_RECIPIENT = 'sitemap/generate/error_email'

'Send error emails to' configuration

Definition at line 40 of file Observer.php.

XML_PATH_ERROR_TEMPLATE

const XML_PATH_ERROR_TEMPLATE = 'sitemap/generate/error_email_template'

Error email template configuration

Definition at line 30 of file Observer.php.

XML_PATH_GENERATION_ENABLED

const XML_PATH_GENERATION_ENABLED = 'sitemap/generate/enabled'

Enable/disable configuration

Definition at line 18 of file Observer.php.

---

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

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