1. Documentation
  2. API
  3. Cms
  4. Classes
  5. ComponentHelpers

Cms\Classes\ComponentHelpers

Source: ~/modules/cms/classes/ComponentHelpers.php

Defines some component helpers for the CMS UI.

Public methods

public static string getComponentDescription(mixed $component)

Returns a component description.

Parameters
  • mixed $component - The component object

public static string getComponentName(mixed $component)

Returns a component name.

Parameters
  • mixed $component - The component object

public static mixed getComponentPropertyValues(mixed $component)

Returns a component property values.

Parameters
  • mixed $component - The component object

public static string getComponentsPropertyConfig(mixed $component, boolean $addAliasProperty=true, boolean $returnArray=false)

Returns a component property configuration as a JSON string or array.

Parameters
  • mixed $component - The component object
  • boolean $addAliasProperty - Determines if the Alias property should be added to the result.
  • boolean $returnArray - Determines if the method should return an array.