PermissionsModel
extends PluginYamlModel
in package
Manages plugin permissions information.
Tags
Table of Contents
- $exists : bool
- $permissions : mixed
- $fillable : mixed
- $originalFileData : mixed
- $originalFilePath : mixed
- $pluginCodeObj : mixed
- $pluginName : mixed
- $updatedData : mixed
- $validationMessages : mixed
- $validationRules : mixed
- $yamlSection : mixed
- deleteModel() : mixed
- fill() : mixed
- getModelPluginName() : mixed
- getPluginCodeObj() : mixed
- getPluginName() : mixed
- getPluginRegistryData() : mixed
- initDefaults() : mixed
- isNewModel() : mixed
- loadPlugin() : mixed
- save() : mixed
- setPluginCode() : mixed
- Sets a string code of a plugin the model is associated with
- setPluginCodeObj() : mixed
- validate() : mixed
- afterCreate() : mixed
- beforeCreate() : mixed
- getArrayKeySafe() : mixed
- getFilePath() : string
- Returns a file path to save the model to.
- initPropertiesFromPluginCodeObject() : mixed
- isEmptyRow() : mixed
- load() : mixed
- loadCommonProperties() : mixed
- modelToYamlArray() : array<string|int, mixed>
- Converts the model's data to an array before it's saved to a YAML file.
- pluginSettingsFileExists() : mixed
- trimPermissionProperties() : mixed
- validateBeforeCreate() : mixed
- validateDupicatePermissions() : mixed
- validateRequiredProperties() : mixed
- yamlArrayToModel() : mixed
- Load the model's data from an array.
Properties
$exists
public
bool
$exists
= false
This property is used by the system internally.
$permissions
public
mixed
$permissions
= []
$fillable
protected
static mixed
$fillable
= ['permissions']
$originalFileData
protected
mixed
$originalFileData
= []
$originalFilePath
protected
mixed
$originalFilePath
$pluginCodeObj
protected
mixed
$pluginCodeObj
$pluginName
protected
mixed
$pluginName
$updatedData
protected
mixed
$updatedData
= []
$validationMessages
protected
mixed
$validationMessages
= []
$validationRules
protected
mixed
$validationRules
= []
$yamlSection
protected
mixed
$yamlSection
= 'permissions'
Methods
deleteModel()
public
deleteModel() : mixed
Return values
mixed —fill()
public
fill(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —getModelPluginName()
public
getModelPluginName() : mixed
Return values
mixed —getPluginCodeObj()
public
getPluginCodeObj() : mixed
Return values
mixed —getPluginName()
public
getPluginName() : mixed
Return values
mixed —getPluginRegistryData()
public
static getPluginRegistryData(mixed $pluginCode) : mixed
Parameters
- $pluginCode : mixed
Return values
mixed —initDefaults()
public
initDefaults() : mixed
Return values
mixed —isNewModel()
public
isNewModel() : mixed
Return values
mixed —loadPlugin()
public
loadPlugin(mixed $pluginCode) : mixed
Parameters
- $pluginCode : mixed
Return values
mixed —save()
public
save() : mixed
Return values
mixed —setPluginCode()
Sets a string code of a plugin the model is associated with
public
setPluginCode(string $code) : mixed
Parameters
- $code : string
-
Specifies the plugin code
Return values
mixed —setPluginCodeObj()
public
setPluginCodeObj(mixed $pluginCodeObj) : mixed
Parameters
- $pluginCodeObj : mixed
Return values
mixed —validate()
public
validate() : mixed
Return values
mixed —afterCreate()
protected
afterCreate() : mixed
Return values
mixed —beforeCreate()
protected
beforeCreate() : mixed
Return values
mixed —getArrayKeySafe()
protected
getArrayKeySafe(mixed $array, mixed $key[, mixed $default = null ]) : mixed
Parameters
- $array : mixed
- $key : mixed
- $default : mixed = null
Return values
mixed —getFilePath()
Returns a file path to save the model to.
protected
getFilePath() : string
Return values
string —Returns a path.
initPropertiesFromPluginCodeObject()
protected
initPropertiesFromPluginCodeObject(mixed $pluginCodeObj) : mixed
Parameters
- $pluginCodeObj : mixed
Return values
mixed —isEmptyRow()
protected
isEmptyRow(mixed $permission) : mixed
Parameters
- $permission : mixed
Return values
mixed —load()
protected
load(mixed $filePath) : mixed
Parameters
- $filePath : mixed
Return values
mixed —loadCommonProperties()
protected
loadCommonProperties() : mixed
Return values
mixed —modelToYamlArray()
Converts the model's data to an array before it's saved to a YAML file.
protected
modelToYamlArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —pluginSettingsFileExists()
protected
static pluginSettingsFileExists(mixed $pluginCodeObj) : mixed
Parameters
- $pluginCodeObj : mixed
Return values
mixed —trimPermissionProperties()
protected
trimPermissionProperties(mixed $permission) : mixed
Parameters
- $permission : mixed
Return values
mixed —validateBeforeCreate()
protected
validateBeforeCreate() : mixed
Return values
mixed —validateDupicatePermissions()
protected
validateDupicatePermissions() : mixed
Return values
mixed —validateRequiredProperties()
protected
validateRequiredProperties() : mixed
Return values
mixed —yamlArrayToModel()
Load the model's data from an array.
protected
yamlArrayToModel(array<string|int, mixed> $array) : mixed
Parameters
- $array : array<string|int, mixed>
-
An array to load the model fields from.