This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for arField:

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

	loadFromStdClass (string $name, stdClass $stdClass)

	getAttributesForConnector ()

	getAttributesForDescription ()

	isDateField ()

	setFieldType (string $field_type)

	getFieldType ()

	setHasField (bool $has_field)

	getHasField ()

	setLength (int $length)

	getLength ()

	setName (string $name)

	getName ()

	setNotNull (bool $not_null)

	getNotNull ()

	setPrimary (bool $primary)

	getPrimary ()

	setSequence (bool $sequence)

	getSequence ()

	setIndex (bool $index)

	getIndex ()

Static Public Member Functions
static	isAllowedAttribute (string $type, string $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
bool	$is_unique = false

string	$fieldtype

int	$length = null

bool	$is_primary = false

string	$name = ''

bool	$is_notnull = false

bool	$has_field = false

bool	$sequence = false

bool	$index = false

Static Protected Attributes
static array	$allowed_attributes

static array	$date_fields = [self::FIELD_TYPE_DATE, self::FIELD_TYPE_TIME, self::FIELD_TYPE_TIMESTAMP]

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 24 of file class.arField.php.

Member Function Documentation

◆ getAttributesForConnector()

arField::getAttributesForConnector ( )

Returns: array<int|string, mixed>

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

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

                                                : array
     {
         $return = [];
         foreach (arFieldList::getAllowedConnectorFields() as $field_name) {
             if (isset($this->{$field_name}) && $this->{$field_name} && 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<int|string, mixed>

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

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

                                                  : array
     {
         $return = [];
         foreach (arFieldList::getAllowedDescriptionFields() as $field_name) {
             if ($this->{$field_name} && 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 ( )

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

References $fieldtype.

Referenced by getAttributesForConnector(), getAttributesForDescription(), and isDateField().

                                   : string
     {
         return $this->fieldtype;
     }

Here is the caller graph for this function:

◆ getHasField()

arField::getHasField ( )

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

References $has_field.

                                  : bool
     {
         return $this->has_field;
     }

◆ getIndex()

arField::getIndex ( )

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

References $index.

                               : bool
     {
         return $this->index;
     }

◆ getLength()

arField::getLength ( )

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

References $length.

                                : ?int
     {
         return $this->length;
     }

◆ getName()

arField::getName ( )

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

References $name.

                              : string
     {
         return $this->name;
     }

◆ getNotNull()

arField::getNotNull ( )

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

                                 : bool
     {
         return $this->not_null;
     }

◆ getPrimary()

arField::getPrimary ( )

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

References $is_primary.

                                 : bool
     {
         return $this->is_primary;
     }

◆ getSequence()

arField::getSequence ( )

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

References $sequence.

                                  : bool
     {
         return $this->sequence;
     }

◆ isAllowedAttribute()

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

static

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

References arFieldList\FIELDTYPE, and arFieldList\HAS_FIELD.

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

◆ isDateField()

arField::isDateField ( )

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

References getFieldType().

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

Here is the call graph for this function:

◆ isDateFieldType()

static arField::isDateFieldType ( $field_type )

static

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

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

◆ loadFromArray()

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

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

References setName().

Referenced by loadFromStdClass().

                                                              : void
     {
         $this->setName($name);
         foreach ($array as $key => $value) {
             $this->{$key} = match ($value) {
                 'true' => true,
                 'false' => false,
                 default => $value,
             };
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadFromStdClass()

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

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

References loadFromArray().

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

Here is the call graph for this function:

◆ setFieldType()

arField::setFieldType ( string $field_type )

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

                                                     : void
     {
         $this->fieldtype = $field_type;
     }

◆ setHasField()

arField::setHasField ( bool $has_field )

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

References $has_field.

                                                 : void
     {
         $this->has_field = $has_field;
     }

◆ setIndex()

arField::setIndex ( bool $index )

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

References $index.

                                          : void
     {
         $this->index = $index;
     }

◆ setLength()

arField::setLength ( int $length )

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

References $length.

                                           : void
     {
         $this->length = $length;
     }

◆ setName()

arField::setName ( string $name )

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

References $name.

Referenced by loadFromArray().

                                          : void
     {
         $this->name = $name;
     }

Here is the caller graph for this function:

◆ setNotNull()

arField::setNotNull ( bool $not_null )

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

                                               : void
     {
         $this->not_null = $not_null;
     }

◆ setPrimary()

arField::setPrimary ( bool $primary )

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

                                              : void
     {
         $this->is_primary = $primary;
     }

◆ setSequence()

arField::setSequence ( bool $sequence )

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

References $sequence.

                                                : void
     {
         $this->sequence = $sequence;
     }

Field Documentation

◆ $allowed_attributes

array arField::$allowed_attributes

staticprotected

Initial value:

= [
        self::FIELD_TYPE_TEXT => [
            arFieldList::LENGTH,
            arFieldList::IS_NOTNULL,
            arFieldList::IS_PRIMARY
        ]

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

◆ $date_fields

array arField::$date_fields = [self::FIELD_TYPE_DATE, self::FIELD_TYPE_TIME, self::FIELD_TYPE_TIMESTAMP]

staticprotected

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

◆ $fieldtype

string arField::$fieldtype

protected

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

Referenced by getFieldType().

◆ $has_field

bool arField::$has_field = false

protected

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

Referenced by getHasField(), and setHasField().

◆ $index

bool arField::$index = false

protected

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

Referenced by getIndex(), and setIndex().

◆ $is_notnull

bool arField::$is_notnull = false

protected

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

◆ $is_primary

bool arField::$is_primary = false

protected

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

Referenced by getPrimary().

◆ $is_unique

bool arField::$is_unique = false

protected

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

◆ $length

int arField::$length = null

protected

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

Referenced by getLength(), and setLength().

◆ $name

string arField::$name = ''

protected

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

Referenced by getName(), and setName().

◆ $sequence

bool arField::$sequence = false

protected

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

Referenced by getSequence(), and setSequence().

◆ FIELD_TYPE_CLOB

const arField::FIELD_TYPE_CLOB = 'clob'

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

◆ FIELD_TYPE_DATE

const arField::FIELD_TYPE_DATE = 'date'

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

◆ FIELD_TYPE_FLOAT

const arField::FIELD_TYPE_FLOAT = 'float'

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

◆ FIELD_TYPE_INTEGER

const arField::FIELD_TYPE_INTEGER = 'integer'

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

Referenced by arBuilder\generateDBUpdateForInstallation().

◆ FIELD_TYPE_TEXT

const arField::FIELD_TYPE_TEXT = 'text'

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

Referenced by ilADTTextActiveRecordBridge\getActiveRecordFields().

◆ FIELD_TYPE_TIME

const arField::FIELD_TYPE_TIME = 'time'

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

◆ FIELD_TYPE_TIMESTAMP

const arField::FIELD_TYPE_TIMESTAMP = 'timestamp'

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

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

components/ILIAS/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_notnull

◆ $is_primary

◆ $is_unique

◆ $length

◆ $name

◆ $sequence

◆ FIELD_TYPE_CLOB

◆ FIELD_TYPE_DATE

◆ FIELD_TYPE_FLOAT

◆ FIELD_TYPE_INTEGER

◆ FIELD_TYPE_TEXT

◆ FIELD_TYPE_TIME

◆ FIELD_TYPE_TIMESTAMP