class.arField.php

Go to the documentation of this file.

<?php

class arField
{
    const FIELD_TYPE_TEXT = 'text'; // MySQL varchar, char
    const FIELD_TYPE_INTEGER = 'integer'; // MySQL tinyint, smallint, mediumint, int, bigint
    const FIELD_TYPE_FLOAT = 'float'; // MySQL double
    const FIELD_TYPE_DATE = 'date'; // MySQL date
    const FIELD_TYPE_TIME = 'time'; // MySQL time
    const FIELD_TYPE_TIMESTAMP = 'timestamp'; // MySQL datetime
    const FIELD_TYPE_CLOB = 'clob'; // MySQL longtext
    protected static $allowed_attributes = array(
        self::FIELD_TYPE_TEXT => array(
            arFieldList::LENGTH,
            arFieldList::IS_NOTNULL,
            arFieldList::IS_PRIMARY,
            arFieldList::IS_UNIQUE,
        ),
        self::FIELD_TYPE_INTEGER => array(
            arFieldList::LENGTH,
            arFieldList::IS_NOTNULL,
            arFieldList::IS_PRIMARY,
            arFieldList::IS_UNIQUE,
            arFieldList::SEQUENCE,
        ),
        self::FIELD_TYPE_FLOAT => array(
            arFieldList::IS_NOTNULL,
        ),
        self::FIELD_TYPE_DATE => array(
            arFieldList::IS_NOTNULL,
        ),
        self::FIELD_TYPE_TIME => array(
            arFieldList::IS_NOTNULL,
        ),
        self::FIELD_TYPE_TIMESTAMP => array(
            arFieldList::IS_NOTNULL,
        ),
        self::FIELD_TYPE_CLOB => array(
            arFieldList::IS_NOTNULL,
        ),
    );
    protected static $date_fields = array(
        self::FIELD_TYPE_DATE,
        self::FIELD_TYPE_TIME,
        self::FIELD_TYPE_TIMESTAMP
    );


    public function loadFromArray($name, array $array)
    {
        $this->setName($name);
        foreach ($array as $key => $value) {
            switch ($value) {
                case 'true':
                    $this->{$key} = true;
                    break;
                case 'false':
                    $this->{$key} = false;
                    break;
                default:
                    $this->{$key} = $value;
                    break;
            }
        }
    }


    public function loadFromStdClass($name, stdClass $stdClass)
    {
        $array = (array) $stdClass;
        $this->loadFromArray($name, $array);
    }


    public function getAttributesForConnector()
    {
        $return = array();
        foreach (arFieldList::getAllowedConnectorFields() as $field_name) {
            if (isset($this->{$field_name}) && $this->{$field_name} and self::isAllowedAttribute($this->getFieldType(), $field_name)) {
                $return[arFieldList::mapKey($field_name)] = $this->{$field_name};
            }
        }

        return $return;
    }


    public function getAttributesForDescription()
    {
        $return = array();
        foreach (arFieldList::getAllowedDescriptionFields() as $field_name) {
            if ($this->{$field_name} and self::isAllowedAttribute($this->getFieldType(), $field_name)) {
                $return[arFieldList::mapKey($field_name)] = $this->{$field_name};
            }
        }

        return $return;
    }


    public function isDateField()
    {
        return self::isDateFieldType($this->getFieldType());
    }


    protected $fieldtype;
    protected $length = null;
    protected $is_primary = false;
    protected $name = '';
    protected $not_null = false;
    protected $unique = false;
    protected $has_field = false;
    protected $sequence = false;
    protected $index = false;


    public function setFieldType($field_type)
    {
        $this->fieldtype = $field_type;
    }


    public function getFieldType()
    {
        return $this->fieldtype;
    }


    public function setHasField($has_field)
    {
        $this->has_field = $has_field;
    }


    public function getHasField()
    {
        return $this->has_field;
    }


    public function setLength($length)
    {
        $this->length = $length;
    }


    public function getLength()
    {
        return $this->length;
    }


    public function setName($name)
    {
        $this->name = $name;
    }


    public function getName()
    {
        return $this->name;
    }


    public function setNotNull($not_null)
    {
        $this->not_null = $not_null;
    }


    public function getNotNull()
    {
        return $this->not_null;
    }


    public function setPrimary($primary)
    {
        $this->is_primary = $primary;
    }


    public function getPrimary()
    {
        return $this->is_primary;
    }


    public function setUnique($unique)
    {
        $this->unique = $unique;
    }


    public function getUnique()
    {
        return $this->unique;
    }


    public function setSequence($sequence)
    {
        $this->sequence = $sequence;
    }


    public function getSequence()
    {
        return $this->sequence;
    }


    public function setIndex($index)
    {
        $this->index = $index;
    }


    public function getIndex()
    {
        return $this->index;
    }


    public static function isAllowedAttribute($type, $field_name)
    {
        if ($field_name == arFieldList::FIELDTYPE or $field_name == arFieldList::HAS_FIELD) {
            return true;
        }

        return in_array($field_name, self::$allowed_attributes[$type]);
    }


    public static function isDateFieldType($field_type)
    {
        return in_array($field_type, self::$date_fields);
    }
}