Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions | Protected Attributes
Flag Class Reference
Inheritance diagram for Flag:
AbstractModel DataObject Flag Flag Flag

Public Member Functions

 __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=[], \Magento\Framework\Serialize\Serializer\Json $json=null, \Magento\Framework\Serialize\Serializer\Serialize $serialize=null)
 
 beforeSave ()
 
 getFlagData ()
 
 setFlagData ($value)
 
 loadSelf ()
 
- 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

 _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

 $_flagCode = 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

Flag model

@method string getFlagCode() @method \Magento\Framework\Flag setFlagCode(string $value) @method int getState() @method \Magento\Framework\Flag setState(int $value) @method string getLastUpdate() @method \Magento\Framework\Flag setLastUpdate(string $value)

Definition at line 18 of file Flag.php.

Constructor & Destructor Documentation

◆ __construct()

Parameters
\Magento\Framework\Model\Context$context
\Magento\Framework\Registry$registry
\Magento\Framework\Model\ResourceModel\AbstractResource$resource
\Magento\Framework\Data\Collection\AbstractDb$resourceCollection
array$data
\Magento\Framework\Serialize\Serializer\Json$json
\Magento\Framework\Serialize\Serializer\Serialize$serialize

Definition at line 50 of file Flag.php.

58  {
60  ->get(\Magento\Framework\Serialize\Serializer\Json::class);
62  ->get(\Magento\Framework\Serialize\Serializer\Serialize::class);
63  parent::__construct(
64  $context,
65  $registry,
66  $resource,
67  $resourceCollection,
68  $data
69  );
70  }
$resource
Definition: bulk.php:12
serialize($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
Definition: DataObject.php:446

Member Function Documentation

◆ _construct()

_construct ( )
protected

Init resource model Set flag_code if it is specified in arguments

Returns
void

Definition at line 78 of file Flag.php.

79  {
80  if ($this->hasData('flag_code')) {
81  $this->_flagCode = $this->getData('flag_code');
82  }
83  $this->_init(\Magento\Framework\Flag\FlagResource::class);
84  }
getData($key='', $index=null)
Definition: DataObject.php:119

◆ beforeSave()

beforeSave ( )

Processing object before save data

Exceptions

Definition at line 92 of file Flag.php.

93  {
94  if ($this->_flagCode === null) {
95  throw new Exception\LocalizedException(new \Magento\Framework\Phrase('Please define flag code.'));
96  }
97 
98  $this->setFlagCode($this->_flagCode);
99  if (!$this->hasKeepUpdateDate()) {
100  $this->setLastUpdate(date('Y-m-d H:i:s'));
101  }
102 
103  return parent::beforeSave();
104  }

◆ getFlagData()

getFlagData ( )

Retrieve flag data

Returns
mixed

Definition at line 111 of file Flag.php.

112  {
113  if ($this->hasFlagData()) {
114  $flagData = $this->getData('flag_data');
115  try {
116  $data = $this->json->unserialize($flagData);
117  } catch (\InvalidArgumentException $exception) {
118  $data = $this->serialize->unserialize($flagData);
119  }
120  return $data;
121  }
122  }
getData($key='', $index=null)
Definition: DataObject.php:119
serialize($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
Definition: DataObject.php:446

◆ loadSelf()

loadSelf ( )

load self (load by flag code)

Exceptions

Definition at line 141 of file Flag.php.

142  {
143  if ($this->_flagCode === null) {
144  throw new Exception\LocalizedException(new \Magento\Framework\Phrase('Please define flag code.'));
145  }
146 
147  return $this->load($this->_flagCode, 'flag_code');
148  }

◆ setFlagData()

setFlagData (   $value)

Set flag data

Parameters
mixed$value
Returns
$this

Definition at line 130 of file Flag.php.

131  {
132  return $this->setData('flag_data', $this->json->serialize($value));
133  }
$value
Definition: gender.phtml:16

Field Documentation

◆ $_flagCode

$_flagCode = null
protected

Definition at line 25 of file Flag.php.


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