class.arViewField.php

Go to the documentation of this file.

<?php
include_once('./Services/ActiveRecord/Fields/class.arField.php');

class arViewField extends arField
{

    protected $txt_prefix = "";
    protected $txt = "";
    protected $position = 1000;
    protected $visible = false;
    protected $custom_field = false;
    protected $get_function_name = "";
    protected $set_function_name = "";
    protected $is_created_by_field = false;
    protected $is_modified_by_field = false;
    protected $is_creation_date_field = false;
    protected $is_modification_date_field = false;


    public function __construct($name, $txt = null, $position = 0, $visible = true, $custom_field = false)
    {
        $this->name = $name;
        $this->position = $position;
        $this->txt = $txt;
        $this->visible = $visible;
        $this->custom_field = $custom_field;

        $camel_case = ActiveRecord::_toCamelCase($this->getName(), true);
        $this->get_function_name = "get" . $camel_case;
        $this->set_function_name = "set" . $camel_case;
    }


    public function setPosition($position)
    {
        $this->position = $position;
    }


    public function getPosition()
    {
        return $this->position;
    }


    public function setTxt($txt)
    {
        $this->txt = $txt;
    }


    public function getTxt()
    {
        if ($this->txt) {
            return $this->getTxtPrefix() . $this->txt;
        }

        return $this->getTxtPrefix() . $this->getName();
    }


    public function setVisible($visible)
    {
        $this->visible = $visible;
    }


    public function getVisible()
    {
        return $this->visible;
    }


    public function setCustomField($custom_field)
    {
        $this->custom_field = $custom_field;
    }


    public function getCustomField()
    {
        return $this->custom_field;
    }


    public static function setAllowedAttributes($allowed_attributes)
    {
        self::$allowed_attributes = $allowed_attributes;
    }


    public static function getAllowedAttributes()
    {
        return self::$allowed_attributes;
    }


    public function setTxtPrefix($txt_prefix)
    {
        $this->txt_prefix = $txt_prefix;
    }


    public function getTxtPrefix()
    {
        return $this->txt_prefix;
    }


    public function getGetFunctionName()
    {
        return $this->get_function_name;
    }


    public function getSetFunctionName()
    {
        return $this->set_function_name;
    }


    public function setIsCreatedByField($is_created_by_field)
    {
        $this->is_created_by_field = $is_created_by_field;
    }


    public function setIsCreationDateField($is_creation_date_field)
    {
        $this->is_creation_date_field = $is_creation_date_field;
    }


    public function getIsCreationDateField()
    {
        return $this->is_creation_date_field;
    }


    public function getIsCreatedByField()
    {
        return $this->is_created_by_field;
    }


    public function setIsModifiedByField($is_modified_by_field)
    {
        $this->is_modified_by_field = $is_modified_by_field;
    }


    public function getIsModifiedByField()
    {
        return $this->is_modified_by_field;
    }


    public function setIsModificationDateField($is_modification_date_field)
    {
        $this->is_modification_date_field = $is_modification_date_field;
    }


    public function getIsModificationDateField()
    {
        return $this->is_modification_date_field;
    }


    public static function castFromFieldToViewField(arField $field)
    {
        require_once('./Services/ActiveRecord/Views/Index/class.arIndexTableField.php');
        require_once('./Services/ActiveRecord/Views/Edit/class.arEditField.php');
        require_once('./Services/ActiveRecord/Views/Display/class.arDisplayField.php');

        $field_class = get_called_class();
        $obj = new $field_class($field->getName());
        foreach (get_object_vars($field) as $key => $name) {
            $obj->$key = $name;
        }

        return $obj;
    }
}