arFieldList Class Reference

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

Collaboration diagram for arFieldList:

Public Member Functions
	__construct (protected ActiveRecord $activeRecord)
	arFieldList constructor. More...
	getArrayForConnector ()
	getFieldByName (string $field_name)
	isField (string $field_name)
	getPrimaryFieldName ()
	getPrimaryFieldType ()
	setFields (array $fields)
	getFields ()
	setPrimaryField (\arField $arField)
	getPrimaryField ()
	setRawFields (array $raw_fields)
	getRawFields ()
	setPrimaryFields (array $primary_fields)
	getPrimaryFields ()

Static Public Member Functions
static	mapKey (string $key)
static	getAllowedConnectorFields ()
static	getAllowedDescriptionFields ()
static	getInstance (ActiveRecord $activeRecord)
static	getInstanceFromStorage (\ActiveRecord $activeRecord)

Data Fields
const	HAS_FIELD = 'has_field'
const	IS_PRIMARY = 'is_primary'
const	IS_NOTNULL = 'is_notnull'
const	FIELDTYPE = 'fieldtype'
const	LENGTH = 'length'
const	SEQUENCE = 'sequence'
const	INDEX = 'index'

Protected Member Functions
	initFields ()
	initRawFields (ActiveRecord $ar)

Static Protected Member Functions
static	isAllowedAttribute (string $attribute_name)
static	checkAttributes (array $attributes)

Protected Attributes
arField array	$primary_field
array	$primary_fields = []
array	$raw_fields = []
array	$fields = []

Static Protected Attributes
static array	$prefixes = ['db', 'con']
static array	$protected_names = ['arConnector', 'arFieldList']
static array	$allowed_description_fields
static array	$allowed_connector_fields = [self::IS_NOTNULL, self::FIELDTYPE, self::LENGTH]
static array	$key_maps = [self::FIELDTYPE => 'type'

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 arFieldList

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.arFieldList.php.

Constructor & Destructor Documentation

__construct()

arFieldList::__construct

(

protected ActiveRecord

$activeRecord

)

arFieldList constructor.

Definition at line 55 of file class.arFieldList.php.

    {
    }

Member Function Documentation

checkAttributes()

static arFieldList::checkAttributes ( array  $attributes )

staticprotected

Definition at line 198 of file class.arFieldList.php.

                                                                : bool
    {
        if (isset($attributes[self::HAS_FIELD]) && $attributes[self::HAS_FIELD] === 'true') {
            foreach (array_keys($attributes) as $atr) {
                if (!self::isAllowedAttribute($atr)) {
                    return false;
                }
            }
        } else {
            return false;
        }

        return true;
    }

getAllowedConnectorFields()

static arFieldList::getAllowedConnectorFields ( )

static

Returns

mixed[]

Definition at line 67 of file class.arFieldList.php.

Referenced by arField\getAttributesForConnector().

                                                      : array
    {
        return self::$allowed_connector_fields;
    }

Here is the caller graph for this function:

getAllowedDescriptionFields()

static arFieldList::getAllowedDescriptionFields ( )

static

Returns

mixed[]

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

Referenced by arField\getAttributesForDescription().

                                                        : array
    {
        return self::$allowed_description_fields;
    }

Here is the caller graph for this function:

getArrayForConnector()

arFieldList::getArrayForConnector

(

)

Returns

array<string, array<int|string, mixed>>

Definition at line 104 of file class.arFieldList.php.

References getFields().

                                          : array
    {
        $return = [];
        foreach ($this->getFields() as $arField) {
            $return[$arField->getName()] = $arField->getAttributesForConnector();
        }

        return $return;
    }

Here is the call graph for this function:

getFieldByName()

arFieldList::getFieldByName

(

string

$field_name

)

Definition at line 128 of file class.arFieldList.php.

References getFields(), and null.

                                                      : ?arField
    {
        $field = null;
        static $field_map;
        $field_key = $this->activeRecord->getConnectorContainerName() . '.' . $field_name;
        if (is_array($field_map) && array_key_exists($field_key, $field_map)) {
            return $field_map[$field_key];
        }
        foreach ($this->getFields() as $field) {
            if ($field->getName() === $field_name) {
                $field_map[$field_key] = $field;

                return $field;
            }
        }
        return null;
    }

Here is the call graph for this function:

getFields()

arFieldList::getFields

(

)

Returns

arField[]

Definition at line 224 of file class.arFieldList.php.

References $fields.

Referenced by getArrayForConnector(), getFieldByName(), and isField().

                               : array
    {
        return $this->fields;
    }

Here is the caller graph for this function:

getInstance()

static arFieldList::getInstance ( ActiveRecord  $activeRecord )

static

Definition at line 80 of file class.arFieldList.php.

References initRawFields().

Referenced by arFieldCache\store(), and ilServicesActiveRecordFieldTest\testFieldList().

                                                                  : \arFieldList
    {
        $self = new self($activeRecord);
        $self->initRawFields($activeRecord);
        $self->initFields();

        return $self;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstanceFromStorage()

static arFieldList::getInstanceFromStorage ( \ActiveRecord  $activeRecord )

static

Deprecated:

Definition at line 92 of file class.arFieldList.php.

References initRawFields().

Referenced by arFieldCache\storeFromStorage().

                                                                              : \arFieldList
    {
        $self = new self($activeRecord);
        $self->initRawFields($activeRecord);
        $self->initFields();

        return $self;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPrimaryField()

arFieldList::getPrimaryField

(

)

Returns

|mixed[]

Definition at line 237 of file class.arFieldList.php.

References $primary_field.

Referenced by getPrimaryFieldName(), and getPrimaryFieldType().

                                     : \arField|array
    {
        return $this->primary_field;
    }

Here is the caller graph for this function:

getPrimaryFieldName()

arFieldList::getPrimaryFieldName

(

)

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

References getPrimaryField().

                                         : string
    {
        return $this->getPrimaryField()->getName();
    }

Here is the call graph for this function:

getPrimaryFields()

arFieldList::getPrimaryFields

(

)

Returns

mixed[]

Definition at line 269 of file class.arFieldList.php.

References $primary_fields.

                                      : array
    {
        return $this->primary_fields;
    }

getPrimaryFieldType()

arFieldList::getPrimaryFieldType

(

)

Definition at line 163 of file class.arFieldList.php.

References getPrimaryField().

                                         : string
    {
        return $this->getPrimaryField()->getFieldType();
    }

Here is the call graph for this function:

getRawFields()

arFieldList::getRawFields

(

)

Returns

mixed[]

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

References $raw_fields.

Referenced by initFields().

                                  : array
    {
        return $this->raw_fields;
    }

Here is the caller graph for this function:

initFields()

arFieldList::initFields ( )

protected

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

References getRawFields(), and setPrimaryField().

                                   : void
    {
        foreach ($this->getRawFields() as $fieldname => $attributes) {
            if (self::checkAttributes($attributes)) {
                $arField = new arField();
                $arField->loadFromArray($fieldname, $attributes);
                $this->fields[] = $arField;
                if ($arField->getPrimary()) {
                    $this->setPrimaryField($arField);
                }
            }
        }
    }

Here is the call graph for this function:

initRawFields()

arFieldList::initRawFields ( ActiveRecord  $ar )

protected

Definition at line 168 of file class.arFieldList.php.

References setRawFields().

Referenced by getInstance(), and getInstanceFromStorage().

                                                      : void
    {
        $regex = "/[\t ]*\\* @(" . implode('|', self::$prefixes) . ")_([a-zA-Z0-9_]+)[\t ]+([a-zA-Z0-9_]+)/u";
        $reflection = new ReflectionClass($ar);
        $raw_fields = [];
        foreach ($reflection->getProperties() as $property) {
            if (in_array($property->getName(), self::$protected_names)) {
                continue;
            }
            $properties_array = [];
            $has_property = false;
            foreach (explode("\n", $property->getDocComment()) as $line) {
                if (preg_match($regex, $line, $matches)) {
                    $has_property = true;
                    $properties_array[$matches[2]] = $matches[3];
                }
            }
            if ($has_property) {
                $raw_fields[$property->getName()] = $properties_array;
            }
        }

        $this->setRawFields($raw_fields);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAllowedAttribute()

static arFieldList::isAllowedAttribute ( string  $attribute_name )

staticprotected

Definition at line 193 of file class.arFieldList.php.

                                                                        : bool
    {
        return in_array($attribute_name, array_merge(self::$allowed_description_fields, [self::HAS_FIELD]), true);
    }

isField()

arFieldList::isField

(

string

$field_name

)

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

References getFields().

                                               : bool
    {
        $is_field = false;
        foreach ($this->getFields() as $arField) {
            if ($arField->getName() === $field_name) {
                $is_field = true;
            }
        }

        return $is_field;
    }

Here is the call graph for this function:

mapKey()

static arFieldList::mapKey ( string  $key )

static

Definition at line 59 of file class.arFieldList.php.

Referenced by arBuilder\generateDBUpdateForInstallation(), arField\getAttributesForConnector(), and arField\getAttributesForDescription().

                                              : string
    {
        return self::$key_maps[$key] ?? $key;
    }

Here is the caller graph for this function:

setFields()

arFieldList::setFields

(

array

$fields

)

Parameters

Definition at line 216 of file class.arFieldList.php.

References $fields.

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

setPrimaryField()

arFieldList::setPrimaryField

(

\arField

$arField

)

Definition at line 229 of file class.arFieldList.php.

Referenced by initFields().

                                                      : void
    {
        $this->primary_field = $arField;
    }

Here is the caller graph for this function:

setPrimaryFields()

arFieldList::setPrimaryFields

(

array

$primary_fields

)

Parameters

mixed[]

$primary_fields

Definition at line 261 of file class.arFieldList.php.

References $primary_fields.

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

setRawFields()

arFieldList::setRawFields

(

array

$raw_fields

)

Parameters

mixed[]

$raw_fields

Definition at line 245 of file class.arFieldList.php.

References $raw_fields.

Referenced by initRawFields().

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

Here is the caller graph for this function:

Field Documentation

$allowed_connector_fields

array arFieldList::$allowed_connector_fields = [self::IS_NOTNULL, self::FIELDTYPE, self::LENGTH]

staticprotected

Definition at line 45 of file class.arFieldList.php.

$allowed_description_fields

array arFieldList::$allowed_description_fields

staticprotected

Initial value:

= [
        'is_unique',
        
        self::IS_PRIMARY,
        self::IS_NOTNULL,
        self::FIELDTYPE,
        self::LENGTH,
        self::SEQUENCE,
        self::INDEX,
    ]

Definition at line 35 of file class.arFieldList.php.

$fields

array arFieldList::$fields = []

protected

Definition at line 49 of file class.arFieldList.php.

Referenced by getFields(), and setFields().

$key_maps

array arFieldList::$key_maps = [self::FIELDTYPE => 'type'

staticprotected

Definition at line 50 of file class.arFieldList.php.

$prefixes

array arFieldList::$prefixes = ['db', 'con']

staticprotected

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

$primary_field

arField array arFieldList::$primary_field

protected

Definition at line 46 of file class.arFieldList.php.

Referenced by getPrimaryField().

$primary_fields

array arFieldList::$primary_fields = []

protected

Definition at line 47 of file class.arFieldList.php.

Referenced by getPrimaryFields(), and setPrimaryFields().

$protected_names

array arFieldList::$protected_names = ['arConnector', 'arFieldList']

staticprotected

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

$raw_fields

array arFieldList::$raw_fields = []

protected

Definition at line 48 of file class.arFieldList.php.

Referenced by getRawFields(), and setRawFields().

FIELDTYPE

const arFieldList::FIELDTYPE = 'fieldtype'

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

Referenced by arField\isAllowedAttribute(), and arConverter\returnAttributesForField().

HAS_FIELD

const arFieldList::HAS_FIELD = 'has_field'

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

Referenced by arField\isAllowedAttribute(), and arConverter\returnAttributesForField().

INDEX

const arFieldList::INDEX = 'index'

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

IS_NOTNULL

const arFieldList::IS_NOTNULL = 'is_notnull'

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

Referenced by arConverter\returnAttributesForField().

IS_PRIMARY

const arFieldList::IS_PRIMARY = 'is_primary'

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

Referenced by arConverter\returnAttributesForField().

LENGTH

const arFieldList::LENGTH = 'length'

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

Referenced by arConverter\returnAttributesForField().

SEQUENCE

const arFieldList::SEQUENCE = 'sequence'

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

---

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

• components/ILIAS/ActiveRecord/Fields/class.arFieldList.php