PHP Class RainLab\Builder\Classes\PluginBaseModel

Author: Alexey Bobkov, Samuel Georges
Inheritance: extends RainLab\Builder\Classes\PluginYamlModel
Show file Open project: rainlab/builder-plugin Class Usage Examples

Public Properties

Property Type Description
$author
$author_namespace
$description
$homepage
$icon
$name
$namespace

Protected Properties

Property Type Description
$fillable
$localizedDescription
$localizedName
$validationRules
$yamlSection

Public Methods

Method Description
getIconOptions ( )
getPluginCode ( )
initDefaults ( )
listAllPluginCodes ( )

Protected Methods

Method Description
afterCreate ( )
beforeCreate ( )
forcePluginRegistration ( )
getFilePath ( ) : string Returns a file path to save the model to.
getPluginPath ( )
getPluginPathObj ( )
initBuilderSettings ( )
initPluginStructure ( )
initPropertiesFromPluginCodeObject ( $pluginCodeObj )
modelToYamlArray ( ) : array Converts the model's data to an array before it's saved to a YAML file.
rollbackPluginCreation ( )
sanitizePHPString ( $str )
yamlArrayToModel ( array $array ) Load the model's data from an array.

Method Details

afterCreate() protected method

protected afterCreate ( )

beforeCreate() protected method

protected beforeCreate ( )

forcePluginRegistration() protected method

protected forcePluginRegistration ( )

getFilePath() protected method

Returns a file path to save the model to.
protected getFilePath ( ) : string
return string Returns a path.

getIconOptions() public method

public getIconOptions ( )

getPluginCode() public method

public getPluginCode ( )

getPluginPath() protected method

protected getPluginPath ( )

getPluginPathObj() protected method

protected getPluginPathObj ( )

initBuilderSettings() protected method

protected initBuilderSettings ( )

initDefaults() public method

public initDefaults ( )

initPluginStructure() protected method

protected initPluginStructure ( )

initPropertiesFromPluginCodeObject() protected method

protected initPropertiesFromPluginCodeObject ( $pluginCodeObj )

listAllPluginCodes() public static method

public static listAllPluginCodes ( )

modelToYamlArray() protected method

Converts the model's data to an array before it's saved to a YAML file.
protected modelToYamlArray ( ) : array
return array

rollbackPluginCreation() protected method

protected rollbackPluginCreation ( )

sanitizePHPString() protected method

protected sanitizePHPString ( $str )

yamlArrayToModel() protected method

Load the model's data from an array.
protected yamlArrayToModel ( array $array )
$array array An array to load the model fields from.

Property Details

$author public property

public $author

$author_namespace public property

public $author_namespace

$description public property

public $description

$fillable protected static property

protected static $fillable

$homepage public property

public $homepage

$icon public property

public $icon

$localizedDescription protected property

protected $localizedDescription

$localizedName protected property

protected $localizedName

$name public property

public $name

$namespace public property

public $namespace

$validationRules protected property

protected $validationRules

$yamlSection protected property

protected $yamlSection