Inheritance diagram for arField:

Collaboration diagram for arField:

Public Member Functions
	loadFromArray ($name, array $array)

	loadFromStdClass ($name, stdClass $stdClass)

	getAttributesForConnector ()

	getAttributesForDescription ()

	isDateField ()

	setFieldType ($field_type)

	getFieldType ()

	setHasField ($has_field)

	getHasField ()

	setLength ($length)

	getLength ()

	setName ($name)

	getName ()

	setNotNull ($not_null)

	getNotNull ()

	setPrimary ($primary)

	getPrimary ()

	setSequence ($sequence)

	getSequence ()

	setIndex ($index)

	getIndex ()

Static Public Member Functions
static	isAllowedAttribute ($type, $field_name)

static	isDateFieldType ($field_type)

Data Fields
const	FIELD_TYPE_TEXT = 'text'

const	FIELD_TYPE_INTEGER = 'integer'

const	FIELD_TYPE_FLOAT = 'float'

const	FIELD_TYPE_DATE = 'date'

const	FIELD_TYPE_TIME = 'time'

const	FIELD_TYPE_TIMESTAMP = 'timestamp'

const	FIELD_TYPE_CLOB = 'clob'

Protected Attributes
	$fieldtype

	$length = null

	$is_primary = false

	$name = ''

	$not_null = false

	$has_field = false

	$sequence = false

	$index = false

Static Protected Attributes
static	$allowed_attributes

static	$date_fields

Detailed Description

Class arField.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 2.0.7

Definition at line 10 of file class.arField.php.

Member Function Documentation

◆ getAttributesForConnector()

arField::getAttributesForConnector ( )

Returns: array

Definition at line 97 of file class.arField.php.

References arFieldList\getAllowedConnectorFields(), getFieldType(), and arFieldList\mapKey().

     {
         $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;
     }

Here is the call graph for this function:

◆ getAttributesForDescription()

arField::getAttributesForDescription ( )

Returns: array

Definition at line 113 of file class.arField.php.

References arFieldList\getAllowedDescriptionFields(), getFieldType(), and arFieldList\mapKey().

     {
         $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;
     }

Here is the call graph for this function:

◆ getFieldType()

arField::getFieldType ( )

Returns: mixed

Definition at line 181 of file class.arField.php.

References $fieldtype.

Referenced by arIndexTableGUI\addFilterField(), arEditGUI\addFormField(), getAttributesForConnector(), getAttributesForDescription(), isDateField(), arDisplayGUI\setArFieldData(), and arIndexTableGUI\setArFieldData().

     {
         return $this->fieldtype;
     }

Here is the caller graph for this function:

◆ getHasField()

arField::getHasField ( )

Returns: boolean

Definition at line 199 of file class.arField.php.

References $has_field.

     {
         return $this->has_field;
     }

◆ getIndex()

arField::getIndex ( )

Returns: boolean

Definition at line 307 of file class.arField.php.

References $index.

     {
         return $this->index;
     }

◆ getLength()

arField::getLength ( )

Returns: int

Definition at line 217 of file class.arField.php.

References $length.

     {
         return $this->length;
     }

◆ getName()

arField::getName ( )

Returns: string

Definition at line 235 of file class.arField.php.

References $name.

Referenced by arViewField\__construct(), arEditGUI\addBooleanInputField(), arEditGUI\addClobInputField(), arEditGUI\addDateTimeInputField(), arViewFields\addField(), arIndexTableGUI\addFilterField(), arEditGUI\addNumbericInputField(), arEditGUI\addTextInputField(), arEditGUI\afterValidation(), arViewField\castFromFieldToViewField(), arIndexTableGUI\checkColumnVisibile(), arViewField\getTxt(), arEditGUI\setDateTimeRecordField(), arEditGUI\setNumericRecordField(), and arEditGUI\setTextRecordField().

     {
         return $this->name;
     }

Here is the caller graph for this function:

◆ getNotNull()

arField::getNotNull ( )

Returns: boolean

Definition at line 253 of file class.arField.php.

References $not_null.

Referenced by arEditGUI\addFormField().

     {
         return $this->not_null;
     }

Here is the caller graph for this function:

◆ getPrimary()

arField::getPrimary ( )

Returns: boolean

Definition at line 271 of file class.arField.php.

References $is_primary.

Referenced by arEditGUI\afterValidation().

     {
         return $this->is_primary;
     }

Here is the caller graph for this function:

◆ getSequence()

arField::getSequence ( )

Returns: boolean

Definition at line 289 of file class.arField.php.

References $sequence.

     {
         return $this->sequence;
     }

◆ isAllowedAttribute()

static arField::isAllowedAttribute	(	$type,
		$field_name
	)

static

Parameters

$type
$field_name

Returns: bool

Definition at line 319 of file class.arField.php.

References $type, arFieldList\FIELDTYPE, and arFieldList\HAS_FIELD.

     {
         if ($field_name == arFieldList::FIELDTYPE or $field_name == arFieldList::HAS_FIELD) {
             return true;
         }
 
         return in_array($field_name, self::$allowed_attributes[$type]);
     }

◆ isDateField()

arField::isDateField ( )

Returns: bool

Definition at line 129 of file class.arField.php.

References getFieldType().

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

Here is the call graph for this function:

◆ isDateFieldType()

static arField::isDateFieldType ( $field_type )

static

Parameters

$field_type

Returns: bool

Definition at line 334 of file class.arField.php.

     {
         return in_array($field_type, self::$date_fields);
     }

◆ loadFromArray()

arField::loadFromArray	(		$name,
		array	$array
	)

Parameters

	$name
array	$array

Definition at line 64 of file class.arField.php.

References $key, $name, and setName().

Referenced by loadFromStdClass().

     {
         $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;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromStdClass()

arField::loadFromStdClass	(		$name,
		stdClass	$stdClass
	)

Parameters

	$name
stdClass	$stdClass

Definition at line 87 of file class.arField.php.

References $name, and loadFromArray().

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

Here is the call graph for this function:

◆ setFieldType()

arField::setFieldType ( $field_type )

Parameters

mixed $field_type

Definition at line 172 of file class.arField.php.

     {
         $this->fieldtype = $field_type;
     }

◆ setHasField()

arField::setHasField ( $has_field )

Parameters

boolean $has_field

Definition at line 190 of file class.arField.php.

References $has_field.

     {
         $this->has_field = $has_field;
     }

◆ setIndex()

arField::setIndex ( $index )

Parameters

boolean $index

Definition at line 298 of file class.arField.php.

References $index.

     {
         $this->index = $index;
     }

◆ setLength()

arField::setLength ( $length )

Parameters

int $length

Definition at line 208 of file class.arField.php.

References $length.

     {
         $this->length = $length;
     }

◆ setName()

arField::setName ( $name )

Parameters

string $name

Definition at line 226 of file class.arField.php.

References $name.

Referenced by loadFromArray().

     {
         $this->name = $name;
     }

Here is the caller graph for this function:

◆ setNotNull()

arField::setNotNull ( $not_null )

Parameters

boolean $not_null

Definition at line 244 of file class.arField.php.

References $not_null.

     {
         $this->not_null = $not_null;
     }

◆ setPrimary()

arField::setPrimary ( $primary )

Parameters

boolean $primary

Definition at line 262 of file class.arField.php.

     {
         $this->is_primary = $primary;
     }

◆ setSequence()

arField::setSequence ( $sequence )

Parameters

boolean $sequence

Definition at line 280 of file class.arField.php.

References $sequence.

     {
         $this->sequence = $sequence;
     }

Field Documentation

◆ $allowed_attributes

arField::$allowed_attributes

staticprotected

Initial value:

= array(
        self::FIELD_TYPE_TEXT => array(
            arFieldList::LENGTH,
            arFieldList::IS_NOTNULL,
            arFieldList::IS_PRIMARY,
        ),
        self::FIELD_TYPE_INTEGER => array(
            arFieldList::LENGTH,
            arFieldList::IS_NOTNULL,
            arFieldList::IS_PRIMARY,
            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,
        ),
    )

Definition at line 22 of file class.arField.php.

Referenced by arViewField\setAllowedAttributes().

◆ $date_fields

arField::$date_fields

staticprotected

Initial value:

= array(
        self::FIELD_TYPE_DATE,
        self::FIELD_TYPE_TIME,
        self::FIELD_TYPE_TIMESTAMP
    )

Definition at line 53 of file class.arField.php.

◆ $fieldtype

arField::$fieldtype

protected

Definition at line 138 of file class.arField.php.

Referenced by getFieldType().

◆ $has_field

arField::$has_field = false

protected

Definition at line 158 of file class.arField.php.

Referenced by getHasField(), and setHasField().

◆ $index

arField::$index = false

protected

Definition at line 166 of file class.arField.php.

Referenced by getIndex(), and setIndex().

◆ $is_primary

arField::$is_primary = false

protected

Definition at line 146 of file class.arField.php.

Referenced by getPrimary().

◆ $length

arField::$length = null

protected

Definition at line 142 of file class.arField.php.

Referenced by getLength(), and setLength().

◆ $name

arField::$name = ''

protected

Definition at line 150 of file class.arField.php.

Referenced by arIndexTableField\__construct(), arViewField\__construct(), arViewField\castFromFieldToViewField(), getName(), loadFromArray(), loadFromStdClass(), and setName().

◆ $not_null

arField::$not_null = false

protected

Definition at line 154 of file class.arField.php.

Referenced by getNotNull(), and setNotNull().

◆ $sequence

arField::$sequence = false

protected

Definition at line 162 of file class.arField.php.

Referenced by getSequence(), and setSequence().

◆ FIELD_TYPE_CLOB

const arField::FIELD_TYPE_CLOB = 'clob'

Definition at line 18 of file class.arField.php.

◆ FIELD_TYPE_DATE

const arField::FIELD_TYPE_DATE = 'date'

Definition at line 15 of file class.arField.php.

Referenced by ilADTActiveRecordWrapper\getActiveRecordFieldTypeFromMDB2().

◆ FIELD_TYPE_FLOAT

const arField::FIELD_TYPE_FLOAT = 'float'

Definition at line 14 of file class.arField.php.

Referenced by ilADTActiveRecordWrapper\getActiveRecordFieldTypeFromMDB2().

◆ FIELD_TYPE_INTEGER

const arField::FIELD_TYPE_INTEGER = 'integer'

Definition at line 13 of file class.arField.php.

Referenced by arBuilder\generateDBUpdateForInstallation(), and ilADTActiveRecordWrapper\getActiveRecordFieldTypeFromMDB2().

◆ FIELD_TYPE_TEXT

const arField::FIELD_TYPE_TEXT = 'text'

Definition at line 12 of file class.arField.php.

Referenced by ilADTTextActiveRecordBridge\getActiveRecordFields(), and ilADTActiveRecordWrapper\getActiveRecordFieldTypeFromMDB2().

◆ FIELD_TYPE_TIME

const arField::FIELD_TYPE_TIME = 'time'

Definition at line 16 of file class.arField.php.

◆ FIELD_TYPE_TIMESTAMP

const arField::FIELD_TYPE_TIMESTAMP = 'timestamp'

Definition at line 17 of file class.arField.php.

Referenced by ilADTActiveRecordWrapper\getActiveRecordFieldTypeFromMDB2().

The documentation for this class was generated from the following file:

Services/ActiveRecord/Fields/class.arField.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ getAttributesForConnector()

◆ getAttributesForDescription()

◆ getFieldType()

◆ getHasField()

◆ getIndex()

◆ getLength()

◆ getName()

◆ getNotNull()

◆ getPrimary()

◆ getSequence()

◆ isAllowedAttribute()

◆ isDateField()

◆ isDateFieldType()

◆ loadFromArray()

◆ loadFromStdClass()

◆ setFieldType()

◆ setHasField()

◆ setIndex()

◆ setLength()

◆ setName()

◆ setNotNull()

◆ setPrimary()

◆ setSequence()

Field Documentation

◆ $allowed_attributes

◆ $date_fields

◆ $fieldtype

◆ $has_field

◆ $index

◆ $is_primary

◆ $length

◆ $name

◆ $not_null

◆ $sequence

◆ FIELD_TYPE_CLOB

◆ FIELD_TYPE_DATE

◆ FIELD_TYPE_FLOAT

◆ FIELD_TYPE_INTEGER

◆ FIELD_TYPE_TEXT

◆ FIELD_TYPE_TIME

◆ FIELD_TYPE_TIMESTAMP