AbstractModel Class Reference

Inheritance diagram for AbstractModel:

Public Member Functions
	getConditionsInstance ()
	getActionsInstance ()
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Data\FormFactory $formFactory, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], ExtensionAttributesFactory $extensionFactory=null, AttributeValueFactory $customAttributeFactory=null, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	beforeSave ()
	setConditions ($conditions)
	getConditions ()
	setActions ($actions)
	getActions ()
	getForm ()
	loadPost (array $data)
	validate (\Magento\Framework\DataObject $object)
	validateData (\Magento\Framework\DataObject $dataObject)
	isDeleteable ()
	setIsDeleteable ($value)
	isReadonly ()
	setIsReadonly ($value)
	getWebsiteIds ()
Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	getCustomAttributes ()
	getCustomAttribute ($attributeCode)
	setCustomAttributes (array $attributes)
	setCustomAttribute ($attributeCode, $attributeValue)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	setId ($value)
	__sleep ()
	__wakeup ()
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)

Protected Member Functions
	_resetConditions ($conditions=null)
	_resetActions ($actions=null)
	_convertFlatToRecursive (array $data)
Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)
	initializeCustomAttributes ()
	convertCustomAttributeValues (array &$customAttributes)
	getCustomAttributesCodes ()
	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
	_getExtensionAttributes ()
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
	$_conditions
	$_actions
	$_form
	$_isDeleteable = true
	$_isReadonly = false
	$serializer
	$_formFactory
	$_localeDate
Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory
	$extensionAttributes
	$customAttributeFactory
	$customAttributesCodes = null
	$customAttributesChanged = false
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
Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Abstract Rule entity data model

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since

100.0.2

Definition at line 18 of file AbstractModel.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Data\FormFactory	$formFactory,
		\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = null,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = null,
		array	$data = [],
		ExtensionAttributesFactory	$extensionFactory = null,
		AttributeValueFactory	$customAttributeFactory = null,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = null
	)

AbstractModel constructor

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Data\FormFactory	$formFactory
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
\Magento\Framework\Model\ResourceModel\AbstractResource | null	$resource
\Magento\Framework\Data\Collection\AbstractDb | null	$resourceCollection
array	$data
ExtensionAttributesFactory | null	$extensionFactory
AttributeValueFactory | null	$customAttributeFactory
\Magento\Framework\Serialize\Serializer\Json	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 104 of file AbstractModel.php.

      {
        $this->_formFactory = $formFactory;
        $this->_localeDate = $localeDate;
        $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()->get(
            \Magento\Framework\Serialize\Serializer\Json::class
        );
        parent::__construct(
            $context,
            $registry,
            $extensionFactory ?: $this->getExtensionFactory(),
            $customAttributeFactory ?: $this->getCustomAttributeFactory(),
            $resource,
            $resourceCollection,
            $data
        );
    }

Member Function Documentation

_convertFlatToRecursive()

_convertFlatToRecursive ( array  $data )

protected

Set specified data to current rule. Set conditions and actions recursively. Convert dates into \DateTime.

Parameters

array

$data

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity)

Convert dates into \DateTime

Definition at line 337 of file AbstractModel.php.

    {
        $arr = [];
        foreach ($data as $key => $value) {
            if (($key === 'conditions' || $key === 'actions') && is_array($value)) {
                foreach ($value as $id => $data) {
                    $path = explode('--', $id);
                    $node = & $arr;
                    for ($i = 0, $l = sizeof($path); $i < $l; $i++) {
                        if (!isset($node[$key][$path[$i]])) {
                            $node[$key][$path[$i]] = [];
                        }
                        $node = & $node[$key][$path[$i]];
                    }
                    foreach ($data as $k => $v) {
                        $node[$k] = $v;
                    }
                }
            } else {
                if (in_array($key, ['from_date', 'to_date'], true) && $value) {
                    $value = new \DateTime($value);
                }
                $this->setData($key, $value);
            }
        }

        return $arr;
    }

_resetActions()

_resetActions (   $actions = null )

protected

Reset rule actions

Parameters

null | \Magento\Rule\Model\Action\Collection

$actions

Returns

$this

Definition at line 285 of file AbstractModel.php.

    {
        if (null === $actions) {
            $actions = $this->getActionsInstance();
        }
        $actions->setRule($this)->setId('1')->setPrefix('actions');
        $this->setActions($actions);

        return $this;
    }

_resetConditions()

_resetConditions (   $conditions = null )

protected

Reset rule combine conditions

Parameters

null | \Magento\Rule\Model\Condition\Combine

$conditions

Returns

$this

Definition at line 268 of file AbstractModel.php.

    {
        if (null === $conditions) {
            $conditions = $this->getConditionsInstance();
        }
        $conditions->setRule($this)->setId('1')->setPrefix('conditions');
        $this->setConditions($conditions);

        return $this;
    }

beforeSave()

beforeSave

(

)

Prepare data before saving

Returns

$this

Exceptions

Prepare website Ids if applicable and if they were set as string in comma separated format. Backwards compatibility.

Prepare customer group Ids if applicable and if they were set as string in comma separated format. Backwards compatibility.

Definition at line 139 of file AbstractModel.php.

    {
        // Check if discount amount not negative
        if ($this->hasDiscountAmount()) {
            if ((int)$this->getDiscountAmount() < 0) {
                throw new \Magento\Framework\Exception\LocalizedException(__('Please choose a valid discount amount.'));
            }
        }

        // Serialize conditions
        if ($this->getConditions()) {
            $this->setConditionsSerialized($this->serializer->serialize($this->getConditions()->asArray()));
            $this->_conditions = null;
        }

        // Serialize actions
        if ($this->getActions()) {
            $this->setActionsSerialized($this->serializer->serialize($this->getActions()->asArray()));
            $this->_actions = null;
        }

        if ($this->hasWebsiteIds()) {
            $websiteIds = $this->getWebsiteIds();
            if (is_string($websiteIds) && !empty($websiteIds)) {
                $this->setWebsiteIds(explode(',', $websiteIds));
            }
        }

        if ($this->hasCustomerGroupIds()) {
            $groupIds = $this->getCustomerGroupIds();
            if (is_string($groupIds) && !empty($groupIds)) {
                $this->setCustomerGroupIds(explode(',', $groupIds));
            }
        }

        parent::beforeSave();
        return $this;
    }

getActions()

getActions

(

)

Retrieve rule actions model

Returns

\Magento\Rule\Model\Action\Collection

Definition at line 241 of file AbstractModel.php.

    {
        if (!$this->_actions) {
            $this->_resetActions();
        }

        // Load rule actions if it is applicable
        if ($this->hasActionsSerialized()) {
            $actions = $this->getActionsSerialized();
            if (!empty($actions)) {
                $actions = $this->serializer->unserialize($actions);
                if (is_array($actions) && !empty($actions)) {
                    $this->_actions->loadArray($actions);
                }
            }
            $this->unsActionsSerialized();
        }

        return $this->_actions;
    }

getActionsInstance()

getActionsInstance ( )

abstract

Getter for rule actions collection instance

Returns

\Magento\Rule\Model\Action\Collection

getConditions()

getConditions

(

)

Retrieve rule combine conditions model

Returns

\Magento\Rule\Model\Condition\Combine

Definition at line 203 of file AbstractModel.php.

    {
        if (empty($this->_conditions)) {
            $this->_resetConditions();
        }

        // Load rule conditions if it is applicable
        if ($this->hasConditionsSerialized()) {
            $conditions = $this->getConditionsSerialized();
            if (!empty($conditions)) {
                $conditions = $this->serializer->unserialize($conditions);
                if (is_array($conditions) && !empty($conditions)) {
                    $this->_conditions->loadArray($conditions);
                }
            }
            $this->unsConditionsSerialized();
        }

        return $this->_conditions;
    }

getConditionsInstance()

getConditionsInstance ( )

abstract

Getter for rule combine conditions instance

Returns

\Magento\Rule\Model\Condition\Combine

getForm()

getForm

(

)

Rule form getter

Returns

\Magento\Framework\Data\Form

Definition at line 301 of file AbstractModel.php.

    {
        if (!$this->_form) {
            $this->_form = $this->_formFactory->create();
        }
        return $this->_form;
    }

getWebsiteIds()

getWebsiteIds

(

)

Get rule associated website Ids

Returns

array

Definition at line 476 of file AbstractModel.php.

    {
        if (!$this->hasWebsiteIds()) {
            $websiteIds = $this->_getResource()->getWebsiteIds($this->getId());
            $this->setData('website_ids', (array)$websiteIds);
        }
        return $this->_getData('website_ids');
    }

isDeleteable()

isDeleteable

(

)

Check availability to delete rule

Returns

bool @codeCoverageIgnore

Definition at line 429 of file AbstractModel.php.

    {
        return $this->_isDeleteable;
    }

isReadonly()

isReadonly

(

)

Check if rule is readonly

Returns

bool @codeCoverageIgnore

Definition at line 453 of file AbstractModel.php.

    {
        return $this->_isReadonly;
    }

loadPost()

loadPost

(

array

$data

)

Initialize rule model data from array

Parameters

array

$data

Returns

$this

Definition at line 315 of file AbstractModel.php.

    {
        $arr = $this->_convertFlatToRecursive($data);
        if (isset($arr['conditions'])) {
            $this->getConditions()->setConditions([])->loadArray($arr['conditions'][1]);
        }
        if (isset($arr['actions'])) {
            $this->getActions()->setActions([])->loadArray($arr['actions'][1], 'actions');
        }

        return $this;
    }

setActions()

setActions

(

$actions

)

Set rule actions model

Parameters

\Magento\Rule\Model\Action\Collection

$actions

Returns

$this

Definition at line 230 of file AbstractModel.php.

    {
        $this->_actions = $actions;
        return $this;
    }

setConditions()

setConditions

(

$conditions

)

Set rule combine conditions model

Parameters

\Magento\Rule\Model\Condition\Combine

$conditions

Returns

$this

Definition at line 192 of file AbstractModel.php.

    {
        $this->_conditions = $conditions;
        return $this;
    }

setIsDeleteable()

setIsDeleteable

(

$value

)

Set is rule can be deleted flag

Parameters

bool

$value

Returns

$this @codeCoverageIgnore

Definition at line 441 of file AbstractModel.php.

    {
        $this->_isDeleteable = (bool)$value;
        return $this;
    }

setIsReadonly()

setIsReadonly

(

$value

)

Set is readonly flag to rule

Parameters

bool

$value

Returns

$this @codeCoverageIgnore

Definition at line 465 of file AbstractModel.php.

    {
        $this->_isReadonly = (bool)$value;
        return $this;
    }

validate()

validate

(

\Magento\Framework\DataObject

$object

)

Validate rule conditions to determine if rule can run

Parameters

\Magento\Framework\DataObject

$object

Returns

bool

Definition at line 375 of file AbstractModel.php.

    {
        return $this->getConditions()->validate($object);
    }

validateData()

validateData

(

\Magento\Framework\DataObject

$dataObject

)

Validate rule data

Parameters

\Magento\Framework\DataObject

$dataObject

Returns

bool|string[] - return true if validation passed successfully. Array with errors description otherwise @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 388 of file AbstractModel.php.

    {
        $result = [];
        $fromDate = $toDate = null;

        if ($dataObject->hasFromDate() && $dataObject->hasToDate()) {
            $fromDate = $dataObject->getFromDate();
            $toDate = $dataObject->getToDate();
        }

        if ($fromDate && $toDate) {
            $fromDate = new \DateTime($fromDate);
            $toDate = new \DateTime($toDate);

            if ($fromDate > $toDate) {
                $result[] = __('End Date must follow Start Date.');
            }
        }

        if ($dataObject->hasWebsiteIds()) {
            $websiteIds = $dataObject->getWebsiteIds();
            if (empty($websiteIds)) {
                $result[] = __('Please specify a website.');
            }
        }
        if ($dataObject->hasCustomerGroupIds()) {
            $customerGroupIds = $dataObject->getCustomerGroupIds();
            if (empty($customerGroupIds)) {
                $result[] = __('Please specify Customer Groups.');
            }
        }

        return !empty($result) ? $result : true;
    }

Field Documentation

$_actions

$_actions

protected

Definition at line 32 of file AbstractModel.php.

$_conditions

$_conditions

protected

Definition at line 25 of file AbstractModel.php.

$_form

$_form

protected

Definition at line 39 of file AbstractModel.php.

$_formFactory

$_formFactory

protected

Definition at line 80 of file AbstractModel.php.

$_isDeleteable

$_isDeleteable = true

protected

Definition at line 46 of file AbstractModel.php.

$_isReadonly

$_isReadonly = false

protected

Definition at line 53 of file AbstractModel.php.

$_localeDate

$_localeDate

protected

Definition at line 87 of file AbstractModel.php.

$serializer

$serializer

protected

Definition at line 59 of file AbstractModel.php.

---

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

• vendor/magento/module-rule/Model/AbstractModel.php