ComponentHelpers
Defines some component helpers for the CMS UI.
class Cms\Classes\ComponentHelpersMethods
public static getComponentDescription (mixed $component) : string
Returns a component description.
Parameters
| Property | Type | Description |
|---|---|---|
| $component | mixed |
mixed
The component object |
Returns
string
public static getComponentName (mixed $component) : string
Returns a component name.
Parameters
| Property | Type | Description |
|---|---|---|
| $component | mixed |
mixed
The component object |
Returns
string
public static getComponentPropertyValues (mixed $component) : mixed
Returns a component property values.
Parameters
| Property | Type | Description |
|---|---|---|
| $component | mixed |
mixed
The component object |
Returns
mixed
public
static
getComponentsPropertyConfig (mixed $component, boolean $addAliasProperty = true, boolean $returnArray = false)
: string
Returns a component property configuration as a JSON string or array.
Parameters
| Property | Type | Description |
|---|---|---|
| $component | mixed |
mixed
The component object |
| $addAliasProperty | boolean |
boolean
Determines if the Alias property should be added to the result. |
| $returnArray | boolean |
boolean
Determines if the method should return an array. |
Returns
string
Copyright © 2024 Winter CMS