winter/modules/cms/classes/ComponentHelpers.php

<?php namespace Cms\Classes;

use Lang;

/**
 * Defines some component helpers for the CMS UI.
 *
 * @package october\system
 * @author Alexey Bobkov, Samuel Georges
 */
class ComponentHelpers
{
    /**
     * Returns a component property configuration as a JSON string.
     * @param mixed $component The component object
     * @return string 
     */
    public static function getComponentsPropertyConfig($component)
    {
        $result = [];

        $property = [
            'property'=>'oc.alias',
            'title'=>Lang::get('cms::lang.component.alias'),
            'description'=>Lang::get('cms::lang.component.alias_description'),
            'type'=>'string',
            'validationPattern'=>'^[a-zA-Z]+[0-9a-z\_]*$',
            'validationMessage'=>Lang::get('cms::lang.component.validation_message')
        ];
        $result[] = $property;

        $properties = $component->defineProperties();
        foreach ($properties as $name=>$params) {
            $property = [
                'property'=>$name,
                'title'=>isset($params['title']) ? $params['title'] : $name,
                'type'=>isset($params['type']) ? $params['type'] : 'string'
            ];

            foreach ($params as $name=>$value) {
                if (!array_key_exists($name, $property))
                    $property[$name] = $value;
            }

            $result[] = $property;
        }

        return json_encode($result);
    }

    /**
     * Returns a component property values.
     * @param mixed $component The component object
     * @return mixed
     */
    public static function getComponentPropertyValues($component)
    {
        $result = [];

        $result['oc.alias'] = $component->alias;

        $properties = $component->defineProperties();
        foreach ($properties as $name=>$params)
            $result[$name] = $component->property($name);

        return json_encode($result);
    }

    /**
     * Returns a component name.
     * @param mixed $component The component object
     * @return string 
     */
    public static function getComponentName($component)
    {
        $details = $component->componentDetails();
        if (isset($details['name']))
            return $details['name'];

        return Lang::get('cms::lang.component.unnamed');
    }

    /**
     * Returns a component description.
     * @param mixed $component The component object
     * @return string 
     */
    public static function getComponentDescription($component)
    {
        $details = $component->componentDetails();
        if (isset($details['description']))
            return $details['description'];

        return Lang::get('cms::lang.component.no_description');
    }
}