ORIENT/modules/backend/classes/FormField.php

<?php namespace Backend\Classes;

use Str;

/**
 * Form Field definition
 * A translation of the form field configuration
 *
 * @package october\backend
 * @author Alexey Bobkov, Samuel Georges
 */
class FormField
{

    /**
     * @var string Form field column name.
     */
    public $columnName;

    /**
     * @var string If the field element names should be contained in an array.
     * Eg: <input name="nameArray[fieldName]" />
     */
    public $arrayName;

    /**
     * @var string A prefix to the field identifier so it can be totally unique.
     */
    public $idPrefix;

    /**
     * @var string Form field label.
     */
    public $label;

    /**
     * @var string Form field value.
     */
    public $value;

    /**
     * @var string Specifies if this field belongs to a tab.
     */
    public $tab;

    /**
     * @var string Display mode. Text, textarea
     */
    public $type = 'text';

    /**
     * @var string Field or widget options.
     */
    public $options = [];

    /**
     * @var string Specifies a side. Possible values: auto, left, right, full
     */
    public $span = 'full';

    /**
     * @var string Specifies a size. Possible values: tiny, small, large, huge, giant
     */
    public $size = 'large';

    /**
     * @var string Specifies contextual visibility of this form field.
     */
    public $context = null;

    /**
     * @var bool Specifies if this field is mandatory.
     */
    public $required = false;

    /**
     * @var bool Specify if the field is disabled or not.
     */
    public $disabled = false;

    /**
     * @var bool Specifies if this field stretch to fit the page height.
     */
    public $stretch = false;

    /**
     * @var string Specifies a comment to accompany the field
     */
    public $comment;
    
    /**
     * @var string Specifies the comment position
     */
    public $commentPosition = 'below';

    /**
     * @var string Specifies if the comment is in HTML format
     */
    public $commentHtml = false;

    /**
     * @var string Specifies a default value for supported fields.
     */
    public $defaults;

    /**
     * @var string Specifies a message to display when there is no value supplied (placeholder).
     */
    public $placeholder;

    /**
     * @var array Contains a list of attributes specified in the field configuration.
     */
    public $attributes;

    /**
     * @var string Specifies a CSS class to attach to the field container.
     */
    public $cssClass;

    /**
     * @var string Specifies a path for partial-type fields.
     */
    public $path;

    public function __construct($columnName, $label)
    {
        $this->columnName = $columnName;
        $this->label = $label;
    }

    /**
     * If this field belongs to a tab.
     */
    public function tab($value)
    {
        $this->tab = $value;
        return $this;
    }

    /**
     * Sets a side of the field on a form.
     * @param $value Specifies a side. Possible values: left, right, full
     */
    public function span($value = 'full')
    {
        $this->span = $value;
        return $this;
    }

    /**
     * Sets a side of the field on a form.
     * @param $value Specifies a size. Possible values: tiny, small, large, huge, giant
     */
    public function size($value = 'large')
    {
        $this->size = $value;
        return $this;
    }

    /**
     * Specifies a field control rendering mode. Supported modes are:
     * - text - creates a text field. Default for varchar column types.
     * - textarea - creates a textarea control. Default for text column types.
     * - dropdown - creates a drop-down list. Default for reference-based columns.
     * - radio - creates a set of radio buttons.
     * - checkbox - creates a single checkbox.
     * - checkboxlist - creates a checkbox list.
     * @param string $type Specifies a render mode as described above
     * @param array $options A list of render mode specific options.
     */
    public function displayAs($type, $options = [])
    {
        $this->type = $type;
        $this->options = $options;
        return $this;
    }

    /**
     * Adds a text comment above or below the field.
     * @param string $text Specifies a comment text.
     * @param string $position Specifies a comment position.
     * @param bool $commentHtml Set to true if you use HTML formatting in the comment
     * Supported values are 'below' and 'above'
     */
    public function comment($text, $position = 'below', $isHtml = false)
    {
        $this->comment = $text;
        $this->commentPosition = $position;
        $this->commentHtml = $isHtml;
        return $this;
    }

    /**
     * Returns a value suitable for the field name property.
     */
    public function getName()
    {
        if ($this->arrayName)
            return $this->arrayName.'['.implode('][', Str::evalHtmlArray($this->columnName)).']';
        else
            return $this->columnName;
    }

    /**
     * Returns a value suitable for the field id property.
     */
    public function getId($suffix = null)
    {
        $id = 'field';
        if ($this->arrayName)
            $id .= '-'.$this->arrayName;

        $id .= '-'.$this->columnName;

        if ($suffix)
            $id .= '-'.$suffix;

        if ($this->idPrefix)
            $id = $this->idPrefix . '-' . $id;

        $id = rtrim(str_replace(['[', ']'], '-', $id), '-');
        return $id;
    }

}