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

Public Member Functions

 __construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Authorization\Model\ResourceModel\Role $resource, \Magento\Authorization\Model\ResourceModel\Role\Collection $resourceCollection, array $data=[])
 
 __sleep ()
 
 __wakeup ()
 
 update ()
 
 getRoleUsers ()
 
- 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

 $_eventPrefix = 'authorization_roles'
 
- 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

Admin Role Model

@api @method int getParentId() @method \Magento\Authorization\Model\Role setParentId(int $value) @method int getTreeLevel() @method \Magento\Authorization\Model\Role setTreeLevel(int $value) @method int getSortOrder() @method \Magento\Authorization\Model\Role setSortOrder(int $value) @method string getRoleType() @method \Magento\Authorization\Model\Role setRoleType(string $value) @method int getUserId() @method \Magento\Authorization\Model\Role setUserId(int $value) @method string getUserType() @method \Magento\Authorization\Model\Role setUserType(string $value) @method string getRoleName() @method \Magento\Authorization\Model\Role setRoleName(string $value) @api

Since
100.0.2

Definition at line 29 of file Role.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\Model\Context  $context,
\Magento\Framework\Registry  $registry,
\Magento\Authorization\Model\ResourceModel\Role  $resource,
\Magento\Authorization\Model\ResourceModel\Role\Collection  $resourceCollection,
array  $data = [] 
)
Parameters
\Magento\Framework\Model\Context$context
\Magento\Framework\Registry$registry
\Magento\Authorization\Model\ResourceModel\Role$resource
\Magento\Authorization\Model\ResourceModel\Role\Collection$resourceCollection
array$data

Definition at line 43 of file Role.php.

49  {
50  parent::__construct($context, $registry, $resource, $resourceCollection, $data);
51  }
$resource
Definition: bulk.php:12

Member Function Documentation

◆ __sleep()

__sleep ( )

{}

Definition at line 56 of file Role.php.

57  {
59  return array_diff($properties, ['_resource', '_resourceCollection']);
60  }
$properties
Definition: categories.php:26

◆ __wakeup()

__wakeup ( )

{}

Definition at line 65 of file Role.php.

66  {
69  $this->_resource = $objectManager->get(\Magento\Authorization\Model\ResourceModel\Role::class);
70  $this->_resourceCollection = $objectManager->get(
71  \Magento\Authorization\Model\ResourceModel\Role\Collection::class
72  );
73  }
$objectManager
Definition: bootstrap.php:17

◆ _construct()

_construct ( )
protected

Class constructor

Returns
void

Definition at line 80 of file Role.php.

81  {
82  $this->_init(\Magento\Authorization\Model\ResourceModel\Role::class);
83  }

◆ getRoleUsers()

getRoleUsers ( )

Return users for role

Returns
array

Definition at line 101 of file Role.php.

102  {
103  return $this->getResource()->getRoleUsers($this);
104  }

◆ update()

update ( )

Update object into database

Returns
$this

Definition at line 90 of file Role.php.

91  {
92  $this->getResource()->update($this);
93  return $this;
94  }

Field Documentation

◆ $_eventPrefix

$_eventPrefix = 'authorization_roles'
protected

Definition at line 34 of file Role.php.


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