ControllerModel
extends BaseModel
in package
Represents and manages plugin controllers.
Tags
Table of Contents
- $baseModelClassName : mixed
- $behaviors : mixed
- $controller : mixed
- $exists : bool
- $menuItem : mixed
- $permissions : mixed
- $fillable : mixed
- $pluginCodeObj : PluginCode
- $updatedData : mixed
- $validationMessages : mixed
- $validationRules : mixed
- fill() : mixed
- getBaseModelClassNameOptions() : mixed
- getBehaviorsOptions() : mixed
- getControllerFilePath() : mixed
- getMenuItemOptions() : mixed
- getModelPluginName() : mixed
- getPermissionsOptions() : mixed
- getPluginCodeObj() : mixed
- getPluginRegistryData() : mixed
- isNewModel() : mixed
- listPluginControllers() : mixed
- load() : mixed
- save() : mixed
- setPluginCode() : mixed
- Sets a string code of a plugin the model is associated with
- setPluginCodeObj() : mixed
- Sets a code object of a plugin the model is associated with
- validate() : mixed
- generateController() : mixed
- loadBehaviorConfiguration() : mixed
- loadControllerBehaviors() : mixed
- saveBehaviorConfiguration() : mixed
- saveController() : mixed
- trimExtension() : mixed
- validateBeforeCreate() : mixed
- validateFileName() : mixed
Properties
$baseModelClassName
public
mixed
$baseModelClassName
$behaviors
public
mixed
$behaviors
= []
$controller
public
mixed
$controller
$exists
public
bool
$exists
= false
This property is used by the system internally.
$menuItem
public
mixed
$menuItem
$permissions
public
mixed
$permissions
= []
$fillable
protected
static mixed
$fillable
= ['controller', 'behaviors', 'baseModelClassName', 'permissions', 'menuItem']
$pluginCodeObj
protected
PluginCode
$pluginCodeObj
= null
The plugin code object the model is associated with.
$updatedData
protected
mixed
$updatedData
= []
$validationMessages
protected
mixed
$validationMessages
= []
$validationRules
protected
mixed
$validationRules
= ['controller' => ['regex:/^[A-Z]+[a-zA-Z0-9_]+$/']]
Methods
fill()
public
fill(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —getBaseModelClassNameOptions()
public
getBaseModelClassNameOptions() : mixed
Return values
mixed —getBehaviorsOptions()
public
getBehaviorsOptions() : mixed
Return values
mixed —getControllerFilePath()
public
getControllerFilePath([mixed $controllerFilesDirectory = false ]) : mixed
Parameters
- $controllerFilesDirectory : mixed = false
Return values
mixed —getMenuItemOptions()
public
getMenuItemOptions() : mixed
Return values
mixed —getModelPluginName()
public
getModelPluginName() : mixed
Return values
mixed —getPermissionsOptions()
public
getPermissionsOptions() : mixed
Return values
mixed —getPluginCodeObj()
public
getPluginCodeObj() : mixed
Return values
mixed —getPluginRegistryData()
public
static getPluginRegistryData(mixed $pluginCode, mixed $subtype) : mixed
Parameters
- $pluginCode : mixed
- $subtype : mixed
Return values
mixed —isNewModel()
public
isNewModel() : mixed
Return values
mixed —listPluginControllers()
public
static listPluginControllers(mixed $pluginCodeObj) : mixed
Parameters
- $pluginCodeObj : mixed
Return values
mixed —load()
public
load(mixed $controller) : mixed
Parameters
- $controller : 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()
Sets a code object of a plugin the model is associated with
public
setPluginCodeObj(PluginCode $obj) : mixed
Parameters
- $obj : PluginCode
-
Specifies the plugin code object
Return values
mixed —validate()
public
validate() : mixed
Return values
mixed —generateController()
protected
generateController() : mixed
Return values
mixed —loadBehaviorConfiguration()
protected
loadBehaviorConfiguration(mixed $fileName, mixed $behaviorClass) : mixed
Parameters
- $fileName : mixed
- $behaviorClass : mixed
Return values
mixed —loadControllerBehaviors()
protected
loadControllerBehaviors() : mixed
Return values
mixed —saveBehaviorConfiguration()
protected
saveBehaviorConfiguration(mixed $fileName, mixed $configuration, mixed $behaviorClass) : mixed
Parameters
- $fileName : mixed
- $configuration : mixed
- $behaviorClass : mixed
Return values
mixed —saveController()
protected
saveController() : mixed
Return values
mixed —trimExtension()
protected
trimExtension(mixed $fileName) : mixed
Parameters
- $fileName : mixed
Return values
mixed —validateBeforeCreate()
protected
validateBeforeCreate() : mixed
Return values
mixed —validateFileName()
protected
validateFileName(mixed $fileName) : mixed
Parameters
- $fileName : mixed