Collaboration diagram for arFieldList:

Public Member Functions
	__construct (ActiveRecord $ar)
	arFieldList constructor. More...

	getArrayForConnector ()

	getFieldByName (string $field_name)

	isField (string $field_name)

	getPrimaryFieldName ()

	getPrimaryFieldType ()

	setFields (array $fields)

	getFields ()

	setPrimaryField (\arField $primary_field)

	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 $ar)

static	getInstanceFromStorage (\ActiveRecord $ar)

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
	$primary_field

array	$primary_fields = array()

array	$raw_fields = array()

array	$fields = array()

ActiveRecord	$ar

Static Protected Attributes
static array	$prefixes = array('db', 'con')

static array	$protected_names = array('arConnector', 'arFieldList')

static array	$allowed_description_fields

static array	$allowed_connector_fields

static array	$key_maps

Detailed Description

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 21 of file class.arFieldList.php.

Constructor & Destructor Documentation

◆ __construct()

arFieldList::__construct ( ActiveRecord $ar )

arFieldList constructor.

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

    {
        $this->ar = $ar;
    }

References $ar.

Member Function Documentation

◆ checkAttributes()

static arFieldList::checkAttributes ( array $attributes )

staticprotected

Definition at line 204 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;
    }

References $attributes.

◆ getAllowedConnectorFields()

static arFieldList::getAllowedConnectorFields ( )

static

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

                                                      : array
    {
        return self::$allowed_connector_fields;
    }

References $allowed_connector_fields.

Referenced by arField\getAttributesForConnector().

Here is the caller graph for this function:

◆ getAllowedDescriptionFields()

static arFieldList::getAllowedDescriptionFields ( )

static

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

                                                        : array
    {
        return self::$allowed_description_fields;
    }

References $allowed_description_fields.

Referenced by arField\getAttributesForDescription().

Here is the caller graph for this function:

◆ getArrayForConnector()

arFieldList::getArrayForConnector ( )

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

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

References getFields().

Here is the call graph for this function:

◆ getFieldByName()

arFieldList::getFieldByName ( string $field_name )

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

                                                      : ?arField
    {
        $field = null;
        static $field_map;
        $field_key = $this->ar->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;
    }

References getFields().

Here is the call graph for this function:

◆ getFields()

arFieldList::getFields ( )

Returns: arField[]

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

                               : array
    {
        return $this->fields;
    }

References $fields.

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

Here is the caller graph for this function:

◆ getInstance()

static arFieldList::getInstance ( ActiveRecord $ar )

static

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

                                                        : \arFieldList
    {
        $arFieldList = new self($ar);
        $arFieldList->initRawFields($ar);
        $arFieldList->initFields();
 
        return $arFieldList;
    }

References $ar, and initRawFields().

Referenced by arFieldCache\store().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceFromStorage()

static arFieldList::getInstanceFromStorage ( \ActiveRecord $ar )

static

Deprecated:

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

                                                                    : \arFieldList
    {
        $arFieldList = new self($ar);
        $arFieldList->initRawFields($ar);
        $arFieldList->initFields();
 
        return $arFieldList;
    }

References $ar, and initRawFields().

Referenced by arFieldCache\storeFromStorage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPrimaryField()

arFieldList::getPrimaryField ( )

Returns: \arField|mixed[]

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

    {
        return $this->primary_field;
    }

References $primary_field.

Referenced by getPrimaryFieldName(), and getPrimaryFieldType().

Here is the caller graph for this function:

◆ getPrimaryFieldName()

arFieldList::getPrimaryFieldName ( )

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

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

References getPrimaryField().

Here is the call graph for this function:

◆ getPrimaryFields()

arFieldList::getPrimaryFields ( )

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

                                      : array
    {
        return $this->primary_fields;
    }

References $primary_fields.

◆ getPrimaryFieldType()

arFieldList::getPrimaryFieldType ( )

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

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

References getPrimaryField().

Here is the call graph for this function:

◆ getRawFields()

arFieldList::getRawFields ( )

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

                                  : array
    {
        return $this->raw_fields;
    }

References $raw_fields.

Referenced by initFields().

Here is the caller graph for this function:

◆ initFields()

arFieldList::initFields ( )

protected

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

                                   : 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);
                }
            }
        }
    }

References $attributes, fields, getRawFields(), and setPrimaryField().

Here is the call graph for this function:

◆ initRawFields()

arFieldList::initRawFields ( ActiveRecord $ar )

protected

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

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

References $ar, $raw_fields, and setRawFields().

Referenced by getInstance(), and getInstanceFromStorage().

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 199 of file class.arFieldList.php.

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

◆ isField()

arFieldList::isField ( string $field_name )

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

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

References getFields().

Here is the call graph for this function:

◆ mapKey()

static arFieldList::mapKey ( string $key )

static

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

                                              : string
    {
        if (isset(self::$key_maps[$key])) {
            return self::$key_maps[$key];
        }
 
        return $key;
    }

References ILIAS\LTI\ToolProvider\$key.

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

Here is the caller graph for this function:

◆ setFields()

arFieldList::setFields ( array $fields )

Parameters

\arField[] $fields

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

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

References $fields, and fields.

◆ setPrimaryField()

arFieldList::setPrimaryField ( \arField $primary_field )

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

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

References $primary_field.

Referenced by initFields().

Here is the caller graph for this function:

◆ setPrimaryFields()

arFieldList::setPrimaryFields ( array $primary_fields )

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

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

References $primary_fields.

◆ setRawFields()

arFieldList::setRawFields ( array $raw_fields )

Parameters

mixed[] $raw_fields

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

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

References $raw_fields.

Referenced by initRawFields().

Here is the caller graph for this function:

Field Documentation

◆ $allowed_connector_fields

array arFieldList::$allowed_connector_fields

staticprotected

Initial value:

= array(
        self::IS_NOTNULL,
        self::FIELDTYPE,
        self::LENGTH,
    )

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

Referenced by getAllowedConnectorFields().

◆ $allowed_description_fields

array arFieldList::$allowed_description_fields

staticprotected

Initial value:

= array(
        'is_unique', 
        self::IS_PRIMARY,
        self::IS_NOTNULL,
        self::FIELDTYPE,
        self::LENGTH,
        self::SEQUENCE,
        self::INDEX
    )

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

Referenced by getAllowedDescriptionFields().

◆ $ar

ActiveRecord arFieldList::$ar

protected

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

Referenced by __construct(), getInstance(), getInstanceFromStorage(), and initRawFields().

◆ $fields

array arFieldList::$fields = array()

protected

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

Referenced by getFields(), and setFields().

◆ $key_maps

array arFieldList::$key_maps

staticprotected

Initial value:

= array(
        self::FIELDTYPE => 'type',
        self::IS_NOTNULL => 'notnull',
    )

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

◆ $prefixes

array arFieldList::$prefixes = array('db', 'con')

staticprotected

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

◆ $primary_field

arFieldList::$primary_field

protected

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

Referenced by getPrimaryField(), and setPrimaryField().

◆ $primary_fields

array arFieldList::$primary_fields = array()

protected

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

Referenced by getPrimaryFields(), and setPrimaryFields().

◆ $protected_names

array arFieldList::$protected_names = array('arConnector', 'arFieldList')

staticprotected

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

◆ $raw_fields

array arFieldList::$raw_fields = array()

protected

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

Referenced by getRawFields(), initRawFields(), and setRawFields().

◆ FIELDTYPE

const arFieldList::FIELDTYPE = 'fieldtype'

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

Referenced by arField\isAllowedAttribute().

◆ HAS_FIELD

const arFieldList::HAS_FIELD = 'has_field'

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

Referenced by arField\isAllowedAttribute().

◆ INDEX

const arFieldList::INDEX = 'index'

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

◆ IS_NOTNULL

const arFieldList::IS_NOTNULL = 'is_notnull'

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

◆ IS_PRIMARY

const arFieldList::IS_PRIMARY = 'is_primary'

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

◆ LENGTH

const arFieldList::LENGTH = 'length'

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

◆ SEQUENCE

const arFieldList::SEQUENCE = 'sequence'

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

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

Services/ActiveRecord/Fields/class.arFieldList.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAttributes()

◆ getAllowedConnectorFields()

◆ getAllowedDescriptionFields()

◆ getArrayForConnector()

◆ getFieldByName()

◆ getFields()

◆ getInstance()

◆ getInstanceFromStorage()

◆ getPrimaryField()

◆ getPrimaryFieldName()

◆ getPrimaryFields()

◆ getPrimaryFieldType()

◆ getRawFields()

◆ initFields()

◆ initRawFields()

◆ isAllowedAttribute()

◆ isField()

◆ mapKey()

◆ setFields()

◆ setPrimaryField()

◆ setPrimaryFields()

◆ setRawFields()

Field Documentation

◆ $allowed_connector_fields

◆ $allowed_description_fields

◆ $ar

◆ $fields

◆ $key_maps

◆ $prefixes

◆ $primary_field

◆ $primary_fields

◆ $protected_names

◆ $raw_fields

◆ FIELDTYPE

◆ HAS_FIELD

◆ INDEX

◆ IS_NOTNULL

◆ IS_PRIMARY

◆ LENGTH

◆ SEQUENCE