Observer Class Reference

Public Member Functions
	__construct (\Magento\Directory\Model\Currency\Import\Factory $importFactory, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Directory\Model\CurrencyFactory $currencyFactory, \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation)
	scheduledUpdateCurrencyRates ($schedule)

Data Fields
const	CRON_STRING_PATH = 'crontab/default/jobs/currency_rates_update/schedule/cron_expr'
const	IMPORT_ENABLE = 'currency/import/enabled'
const	IMPORT_SERVICE = 'currency/import/service'
const	XML_PATH_ERROR_TEMPLATE = 'currency/import/error_email_template'
const	XML_PATH_ERROR_IDENTITY = 'currency/import/error_email_identity'
const	XML_PATH_ERROR_RECIPIENT = 'currency/import/error_email'

Protected Attributes
	$_importFactory
	$_scopeConfig
	$_transportBuilder
	$_storeManager
	$_currencyFactory
	$inlineTranslation

Detailed Description

Definition at line 15 of file Observer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Directory\Model\Currency\Import\Factory	$importFactory,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Directory\Model\CurrencyFactory	$currencyFactory,
		\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation
	)

Parameters

\Magento\Directory\Model\Currency\Import\Factory	$importFactory
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Directory\Model\CurrencyFactory	$currencyFactory
\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation

Definition at line 69 of file Observer.php.

      {
        $this->_importFactory = $importFactory;
        $this->_scopeConfig = $scopeConfig;
        $this->_transportBuilder = $transportBuilder;
        $this->_storeManager = $storeManager;
        $this->_currencyFactory = $currencyFactory;
        $this->inlineTranslation = $inlineTranslation;
    }

Member Function Documentation

scheduledUpdateCurrencyRates()

scheduledUpdateCurrencyRates

(

$schedule

)

Parameters

mixed

$schedule

Returns

void

Exceptions

Definition at line 91 of file Observer.php.

    {
        $importWarnings = [];
        if (!$this->_scopeConfig->getValue(
            self::IMPORT_ENABLE,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        ) || !$this->_scopeConfig->getValue(
            self::CRON_STRING_PATH,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        )
        ) {
            return;
        }

        $errors = [];
        $rates = [];
        $service = $this->_scopeConfig->getValue(
            self::IMPORT_SERVICE,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        if ($service) {
            try {
                $importModel = $this->_importFactory->create($service);
                $rates = $importModel->fetchRates();
                $errors = $importModel->getMessages();
            } catch (\Exception $e) {
                $importWarnings[] = __('FATAL ERROR:') . ' '
                    . __("The import model can't be initialized. Verify the model and try again.");
                throw $e;
            }
        } else {
            $importWarnings[] = __('FATAL ERROR:') . ' ' . __('Please specify the correct Import Service.');
        }

        if (sizeof($errors) > 0) {
            foreach ($errors as $error) {
                $importWarnings[] = __('WARNING:') . ' ' . $error;
            }
        }

        $errorRecipient = $this->_scopeConfig->getValue(
            self::XML_PATH_ERROR_RECIPIENT,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        if (sizeof($importWarnings) == 0) {
            $this->_currencyFactory->create()->saveRates($rates);
        } elseif ($errorRecipient) {
            //if $errorRecipient is not set, there is no sense send email to nobody
            $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", $importWarnings)]
            )->setFrom(
                $this->_scopeConfig->getValue(
                    self::XML_PATH_ERROR_IDENTITY,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                )
            )->addTo($errorRecipient);
            $transport = $this->_transportBuilder->getTransport();
            $transport->sendMessage();

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

Field Documentation

$_currencyFactory

$_currencyFactory

protected

Definition at line 54 of file Observer.php.

$_importFactory

$_importFactory

protected

Definition at line 32 of file Observer.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 39 of file Observer.php.

$_storeManager

$_storeManager

protected

Definition at line 49 of file Observer.php.

$_transportBuilder

$_transportBuilder

protected

Definition at line 44 of file Observer.php.

$inlineTranslation

$inlineTranslation

protected

Definition at line 59 of file Observer.php.

CRON_STRING_PATH

const CRON_STRING_PATH = 'crontab/default/jobs/currency_rates_update/schedule/cron_expr'

Definition at line 17 of file Observer.php.

IMPORT_ENABLE

const IMPORT_ENABLE = 'currency/import/enabled'

Definition at line 19 of file Observer.php.

IMPORT_SERVICE

const IMPORT_SERVICE = 'currency/import/service'

Definition at line 21 of file Observer.php.

XML_PATH_ERROR_IDENTITY

const XML_PATH_ERROR_IDENTITY = 'currency/import/error_email_identity'

Definition at line 25 of file Observer.php.

XML_PATH_ERROR_RECIPIENT

const XML_PATH_ERROR_RECIPIENT = 'currency/import/error_email'

Definition at line 27 of file Observer.php.

XML_PATH_ERROR_TEMPLATE

const XML_PATH_ERROR_TEMPLATE = 'currency/import/error_email_template'

Definition at line 23 of file Observer.php.

---

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

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