ComponentHelpers
in package
Defines some component helpers for the CMS UI.
Tags
Table of Contents
- getComponentDescription() : string
- Returns a component description.
- getComponentName() : string
- Returns a component name.
- getComponentPropertyValues() : mixed
- Returns a component property values.
- getComponentsPropertyConfig() : string
- Returns a component property configuration as a JSON string or array.
Methods
getComponentDescription()
Returns a component description.
public
static getComponentDescription(mixed $component) : string
Parameters
- $component : mixed
-
The component object
Return values
string —getComponentName()
Returns a component name.
public
static getComponentName(mixed $component) : string
Parameters
- $component : mixed
-
The component object
Return values
string —getComponentPropertyValues()
Returns a component property values.
public
static getComponentPropertyValues(mixed $component) : mixed
Parameters
- $component : mixed
-
The component object
Return values
mixed —getComponentsPropertyConfig()
Returns a component property configuration as a JSON string or array.
public
static getComponentsPropertyConfig(mixed $component[, bool $addAliasProperty = true ][, bool $returnArray = false ]) : string
Parameters
- $component : mixed
-
The component object
- $addAliasProperty : bool = true
-
Determines if the Alias property should be added to the result.
- $returnArray : bool = false
-
Determines if the method should return an array.