Inheritance diagram for Variable:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Escaper $escaper, \Magento\Variable\Model\ResourceModel\Variable $resource, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	setStoreId ($storeId)

	getStoreId ()

	loadByCode ($code)

	getValue ($type=null)

	validate ()

	getVariablesOptionArray ($withGroup=false)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	TYPE_TEXT = 'text'

const	TYPE_HTML = 'html'

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_storeId = 0

	$_escaper = null

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Custom variable model

@method string getCode() @method \Magento\Variable\Model\Variable setCode(string $value) @method string getName() @method \Magento\Variable\Model\Variable setName(string $value)

@api

Since: 100.0.2

Definition at line 19 of file Variable.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Escaper	$escaper,
		\Magento\Variable\Model\ResourceModel\Variable	$resource,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Escaper	$escaper
\Magento\Variable\Model\ResourceModel\Variable	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data

Definition at line 43 of file Variable.php.

       {
         $this->_escaper = $escaper;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Internal Constructor

Returns: void

Definition at line 60 of file Variable.php.

     {
         parent::_construct();
         $this->_init(\Magento\Variable\Model\ResourceModel\Variable::class);
     }

◆ getStoreId()

getStoreId ( )

Getter

Returns: integer @codeCoverageIgnore

Definition at line 85 of file Variable.php.

     {
         return $this->_storeId;
     }

◆ getValue()

getValue ( $type = null )

Return variable value depend on given type

Parameters

string $type

Returns: string

Definition at line 109 of file Variable.php.

     {
         if ($type === null) {
             $type = self::TYPE_HTML;
         }
         if ($type == self::TYPE_TEXT || !strlen((string)$this->getData('html_value'))) {
             $value = $this->getData('plain_value');
             //escape html if type is html, but html value is not defined
             if ($type == self::TYPE_HTML) {
                 $value = nl2br($this->_escaper->escapeHtml($value));
             }
             return $value;
         }
         return $this->getData('html_value');
     }

◆ getVariablesOptionArray()

getVariablesOptionArray ( $withGroup = false )

Retrieve variables option array

Todo:: : extract method as separate class

Parameters

bool $withGroup

Returns: array

Definition at line 148 of file Variable.php.

     {
         /* @var $collection \Magento\Variable\Model\ResourceModel\Variable\Collection */
         $collection = $this->getCollection();
         $variables = [];
         foreach ($collection->toOptionArray() as $variable) {
             $variables[] = [
                 'value' => '{{customVar code=' . $variable['value'] . '}}',
                 'label' => __('%1', $this->_escaper->escapeHtml($variable['label'])),
             ];
         }
         if ($withGroup && $variables) {
             $variables = [['label' => __('Custom Variables'), 'value' => $variables]];
         }
         return $variables;
     }

◆ loadByCode()

loadByCode ( $code )

Load variable by code

Parameters

string $code

Returns: $this @codeCoverageIgnore

Definition at line 97 of file Variable.php.

     {
         $this->getResource()->loadByCode($this, $code);
         return $this;
     }

◆ setStoreId()

setStoreId ( $storeId )

Setter

Parameters

integer $storeId

Returns: $this @codeCoverageIgnore

Definition at line 73 of file Variable.php.

     {
         $this->_storeId = $storeId;
         return $this;
     }

◆ validate()

validate ( )

Validation of object data. Checking for unique variable code

Returns: \Magento\Framework\Phrase|bool

Definition at line 130 of file Variable.php.

     {
         if ($this->getCode() && $this->getName()) {
             $variable = $this->getResource()->getVariableByCode($this->getCode());
             if (!empty($variable) && $variable['variable_id'] != $this->getId()) {
                 return __('Variable Code must be unique.');
             }
             return true;
         }
         return __('Validation has failed.');
     }

Field Documentation

◆ $_escaper

$_escaper = null

protected

Definition at line 33 of file Variable.php.

◆ $_storeId

$_storeId = 0

protected

Definition at line 28 of file Variable.php.

◆ TYPE_HTML

const TYPE_HTML = 'html'

Definition at line 23 of file Variable.php.

◆ TYPE_TEXT

const TYPE_TEXT = 'text'

Definition at line 21 of file Variable.php.

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

vendor/magento/module-variable/Model/Variable.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ getStoreId()

◆ getValue()

◆ getVariablesOptionArray()

◆ loadByCode()

◆ setStoreId()

◆ validate()

Field Documentation

◆ $_escaper

◆ $_storeId

◆ TYPE_HTML

◆ TYPE_TEXT