Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\Registry $registry)

	isGoogleAdwordsActive ()

	getLanguageCodes ()

	convertLanguageCodeToLocaleCode ($language)

	getConversionJsSrc ()

	getConversionImgSrc ()

	getConversionId ()

	getConversionLanguage ()

	getConversionFormat ()

	getConversionColor ()

	getConversionLabel ()

	getConversionValueType ()

	isDynamicConversionValue ()

	getConversionValueConstant ()

	getConversionValue ()

	hasSendConversionValueCurrency ()

	getConversionValueCurrency ()

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

	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_LANGUAGES = 'google/adwords/languages'

const	XML_PATH_LANGUAGE_CONVERT = 'google/adwords/language_convert'

const	XML_PATH_CONVERSION_JS_SRC = 'google/adwords/conversion_js_src'

const	XML_PATH_CONVERSION_IMG_SRC = 'google/adwords/conversion_img_src'

const	CONVERSION_VALUE_REGISTRY_NAME = 'google_adwords_conversion_value'

const	CONVERSION_VALUE_CURRENCY_REGISTRY_NAME = 'google_adwords_conversion_value_currency'

const	CONVERSION_VALUE_DEFAULT = 0

const	XML_PATH_ACTIVE = 'google/adwords/active'

const	XML_PATH_CONVERSION_ID = 'google/adwords/conversion_id'

const	XML_PATH_CONVERSION_LANGUAGE = 'google/adwords/conversion_language'

const	XML_PATH_CONVERSION_FORMAT = 'google/adwords/conversion_format'

const	XML_PATH_CONVERSION_COLOR = 'google/adwords/conversion_color'

const	XML_PATH_CONVERSION_LABEL = 'google/adwords/conversion_label'

const	XML_PATH_CONVERSION_VALUE_TYPE = 'google/adwords/conversion_value_type'

const	XML_PATH_CONVERSION_VALUE = 'google/adwords/conversion_value'

const	XML_PATH_SEND_CURRENCY = 'google/adwords/send_currency'

const	CONVERSION_VALUE_TYPE_DYNAMIC = 1

const	CONVERSION_VALUE_TYPE_CONSTANT = 0

Protected Attributes
	$_registry

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

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

	_getModuleName ()

	_getUrl ($route, $params=[])

Detailed Description

@api

Since: 100.0.2

Definition at line 14 of file Data.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\Registry	$registry
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\Registry	$registry

Definition at line 91 of file Data.php.

       {
         parent::__construct($context);
         $this->_registry = $registry;
     }

Member Function Documentation

◆ convertLanguageCodeToLocaleCode()

convertLanguageCodeToLocaleCode ( $language )

Convert language code in the code of the current locale language

Parameters

string $language

Returns: string

Definition at line 133 of file Data.php.

     {
         $convertArray = (array)$this->scopeConfig->getValue(self::XML_PATH_LANGUAGE_CONVERT, 'default');
         return isset($convertArray[$language]) ? $convertArray[$language] : $language;
     }

◆ getConversionColor()

getConversionColor ( )

Get Google AdWords conversion color

Returns: string

Definition at line 207 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_CONVERSION_COLOR,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ getConversionFormat()

getConversionFormat ( )

Get Google AdWords conversion format

Returns: int

Definition at line 194 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_CONVERSION_FORMAT,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ getConversionId()

getConversionId ( )

Get Google AdWords conversion id

Returns: int

Definition at line 168 of file Data.php.

     {
         return (int)$this->scopeConfig->getValue(
             self::XML_PATH_CONVERSION_ID,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ getConversionImgSrc()

getConversionImgSrc ( )

Get conversion img src

Returns: string

Definition at line 154 of file Data.php.

     {
         return sprintf(
             $this->scopeConfig->getValue(self::XML_PATH_CONVERSION_IMG_SRC, 'default'),
             $this->getConversionId(),
             $this->getConversionLabel()
         );
     }

◆ getConversionJsSrc()

getConversionJsSrc ( )

Get conversion path to js src

Returns: string

Definition at line 144 of file Data.php.

     {
         return (string)$this->scopeConfig->getValue(self::XML_PATH_CONVERSION_JS_SRC, 'default');
     }

◆ getConversionLabel()

getConversionLabel ( )

Get Google AdWords conversion label

Returns: string

Definition at line 220 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_CONVERSION_LABEL,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ getConversionLanguage()

getConversionLanguage ( )

Get Google AdWords conversion language

Returns: string

Definition at line 181 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_CONVERSION_LANGUAGE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ getConversionValue()

getConversionValue ( )

Get Google AdWords conversion value

Returns: float

Definition at line 269 of file Data.php.

     {
         if ($this->isDynamicConversionValue()) {
             $conversionValue = (double)$this->_registry->registry(self::CONVERSION_VALUE_REGISTRY_NAME);
         } else {
             $conversionValue = $this->getConversionValueConstant();
         }
         return empty($conversionValue) ? self::CONVERSION_VALUE_DEFAULT : $conversionValue;
     }

◆ getConversionValueConstant()

getConversionValueConstant ( )

Get Google AdWords conversion value constant

Returns: float

Definition at line 256 of file Data.php.

     {
         return (double)$this->scopeConfig->getValue(
             self::XML_PATH_CONVERSION_VALUE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ getConversionValueCurrency()

getConversionValueCurrency ( )

Get Google AdWords conversion value currency

Returns: string|false

Definition at line 297 of file Data.php.

     {
         if ($this->hasSendConversionValueCurrency()) {
             return (string) $this->_registry->registry(self::CONVERSION_VALUE_CURRENCY_REGISTRY_NAME);
         }
         return false;
     }

◆ getConversionValueType()

getConversionValueType ( )

Get Google AdWords conversion value type

Returns: string

Definition at line 233 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_CONVERSION_VALUE_TYPE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ getLanguageCodes()

getLanguageCodes ( )

Retrieve language codes from config

Returns: string[]

Definition at line 122 of file Data.php.

     {
         return (array)$this->scopeConfig->getValue(self::XML_PATH_LANGUAGES, 'default');
     }

◆ hasSendConversionValueCurrency()

hasSendConversionValueCurrency ( )

Get send order currency to Google Adwords

Returns: boolean

Definition at line 284 of file Data.php.

     {
         return $this->scopeConfig->isSetFlag(
             self::XML_PATH_SEND_CURRENCY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ isDynamicConversionValue()

isDynamicConversionValue ( )

Checks if conversion value is dynamic

Returns: bool

Definition at line 246 of file Data.php.

     {
         return $this->getConversionValueType() == self::CONVERSION_VALUE_TYPE_DYNAMIC;
     }

◆ isGoogleAdwordsActive()

isGoogleAdwordsActive ( )

Is Google AdWords active

Returns: bool

Definition at line 104 of file Data.php.

     {
         return $this->scopeConfig->isSetFlag(
             self::XML_PATH_ACTIVE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) &&
             $this->getConversionId() &&
             $this->getConversionLanguage() &&
             $this->getConversionFormat() &&
             $this->getConversionColor() &&
             $this->getConversionLabel();
     }

Field Documentation

◆ $_registry

$_registry

protected

#- #-

Definition at line 85 of file Data.php.

◆ CONVERSION_VALUE_CURRENCY_REGISTRY_NAME

const CONVERSION_VALUE_CURRENCY_REGISTRY_NAME = 'google_adwords_conversion_value_currency'

Google AdWords registry name for conversion value currency

Definition at line 42 of file Data.php.

◆ CONVERSION_VALUE_DEFAULT

const CONVERSION_VALUE_DEFAULT = 0

Default value for conversion value

Definition at line 47 of file Data.php.

◆ CONVERSION_VALUE_REGISTRY_NAME

const CONVERSION_VALUE_REGISTRY_NAME = 'google_adwords_conversion_value'

#- Google AdWords registry name for conversion value

Definition at line 37 of file Data.php.

◆ CONVERSION_VALUE_TYPE_CONSTANT

const CONVERSION_VALUE_TYPE_CONSTANT = 0

Definition at line 80 of file Data.php.

◆ CONVERSION_VALUE_TYPE_DYNAMIC

const CONVERSION_VALUE_TYPE_DYNAMIC = 1

#- #+ Conversion value types

Definition at line 78 of file Data.php.

◆ XML_PATH_ACTIVE

const XML_PATH_ACTIVE = 'google/adwords/active'

#+ Google AdWords config data

Definition at line 52 of file Data.php.

◆ XML_PATH_CONVERSION_COLOR

const XML_PATH_CONVERSION_COLOR = 'google/adwords/conversion_color'

Definition at line 60 of file Data.php.

◆ XML_PATH_CONVERSION_FORMAT

const XML_PATH_CONVERSION_FORMAT = 'google/adwords/conversion_format'

Definition at line 58 of file Data.php.

◆ XML_PATH_CONVERSION_ID

const XML_PATH_CONVERSION_ID = 'google/adwords/conversion_id'

Definition at line 54 of file Data.php.

◆ XML_PATH_CONVERSION_IMG_SRC

const XML_PATH_CONVERSION_IMG_SRC = 'google/adwords/conversion_img_src'

Definition at line 30 of file Data.php.

◆ XML_PATH_CONVERSION_JS_SRC

const XML_PATH_CONVERSION_JS_SRC = 'google/adwords/conversion_js_src'

#- #+ Google AdWords conversion src

Definition at line 28 of file Data.php.

◆ XML_PATH_CONVERSION_LABEL

const XML_PATH_CONVERSION_LABEL = 'google/adwords/conversion_label'

Definition at line 62 of file Data.php.

◆ XML_PATH_CONVERSION_LANGUAGE

const XML_PATH_CONVERSION_LANGUAGE = 'google/adwords/conversion_language'

Definition at line 56 of file Data.php.

◆ XML_PATH_CONVERSION_VALUE

const XML_PATH_CONVERSION_VALUE = 'google/adwords/conversion_value'

Definition at line 66 of file Data.php.

◆ XML_PATH_CONVERSION_VALUE_TYPE

const XML_PATH_CONVERSION_VALUE_TYPE = 'google/adwords/conversion_value_type'

Definition at line 64 of file Data.php.

◆ XML_PATH_LANGUAGE_CONVERT

const XML_PATH_LANGUAGE_CONVERT = 'google/adwords/language_convert'

Definition at line 21 of file Data.php.

◆ XML_PATH_LANGUAGES

const XML_PATH_LANGUAGES = 'google/adwords/languages'

#+ Google AdWords language codes

Definition at line 19 of file Data.php.

◆ XML_PATH_SEND_CURRENCY

const XML_PATH_SEND_CURRENCY = 'google/adwords/send_currency'

Google Adwords send order conversion value currency when using dynamic value

Definition at line 71 of file Data.php.

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

vendor/magento/module-google-adwords/Helper/Data.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members