Collaboration diagram for arFieldList:

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

	getArrayForConnector ()

	getFieldByName ($field_name)

	isField ($field_name)

	getPrimaryFieldName ()

	getPrimaryFieldType ()

	setFields ($fields)

	getFields ()

	setPrimaryField ($primary_field)

	getPrimaryField ()

	setRawFields ($raw_fields)

	getRawFields ()

	setPrimaryFields ($primary_fields)

	getPrimaryFields ()

Static Public Member Functions
static	mapKey ($key)

static	getAllowedConnectorFields ()

static	getAllowedDescriptionFields ()

static	getInstance (ActiveRecord $ar)

static	getInstanceFromStorage ($ar)

Data Fields
const	HAS_FIELD = 'has_field'

const	IS_UNIQUE = 'is_unique'

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

Static Protected Member Functions
static	isAllowedAttribute ($attribute_name)

static	checkAttributes (array $attributes)

Protected Attributes
	$primary_field

	$primary_fields = array()

	$raw_fields = array()

	$fields = array()

	$ar

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

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

static	$allowed_description_fields

static	$allowed_connector_fields

static	$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 11 of file class.arFieldList.php.

Constructor & Destructor Documentation

◆ __construct()

arFieldList::__construct ( ActiveRecord $ar )

arFieldList constructor.

Parameters

ActiveRecord $ar

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

                                                      {
                $this->ar = $ar;
        }

References $ar.

Member Function Documentation

◆ checkAttributes()

static arFieldList::checkAttributes ( array $attributes )

staticprotected

Parameters

array $attributes

Returns: bool

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

                                                                     {
                if ($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: array

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

                                                           {
                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

Returns: array

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

                                                             {
                return self::$allowed_description_fields;
        }

References $allowed_description_fields.

Referenced by arField\getAttributesForDescription().

Here is the caller graph for this function:

◆ getArrayForConnector()

arFieldList::getArrayForConnector ( )

Returns: array

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

                                               {
                $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 ( $field_name )

Parameters

$field_name

Returns: arField

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

                                                    {
                $field = NULL;
                static $field_map;
                $field_key = $this->ar->getConnectorContainerName() . '.' . $field_name;
                if ($field_map[$field_key]) {
                        return $field_map[$field_key];
                }
                foreach ($this->getFields() as $field) {
                        if ($field->getName() == $field_name) {
                                $field_map[$field_key] = $field;
 
                                return $field;
                        }
                }
        }

References getFields().

Here is the call graph for this function:

◆ getFields()

arFieldList::getFields ( )

Returns: arField[]

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

                                    {
                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

Parameters

ActiveRecord $ar

Returns: \arFieldList

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

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

References $ar.

Referenced by arFieldCache\store().

Here is the caller graph for this function:

◆ getInstanceFromStorage()

static arFieldList::getInstanceFromStorage ( $ar )

static

Parameters

ActiveRecord $ar

Deprecated:

Returns: \arFieldList

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

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

References $ar.

Referenced by arFieldCache\storeFromStorage().

Here is the caller graph for this function:

◆ getPrimaryField()

arFieldList::getPrimaryField ( )

Returns: \arField

Definition at line 318 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 ( )

Returns: string

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

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

References getPrimaryField().

Here is the call graph for this function:

◆ getPrimaryFields()

arFieldList::getPrimaryFields ( )

Returns: array

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

                                           {
                return $this->primary_fields;
        }

References $primary_fields.

◆ getPrimaryFieldType()

arFieldList::getPrimaryFieldType ( )

Returns: mixed

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

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

References getPrimaryField().

Here is the call graph for this function:

◆ getRawFields()

arFieldList::getRawFields ( )

Returns: array

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

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

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

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

Here is the call graph for this function:

◆ initRawFields()

arFieldList::initRawFields ( arStorageInterface $ar )

protected

Parameters

\ActiveRecord | \arStorageInterface $ar

Returns: array

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

                                                                 {
                $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().

Here is the call graph for this function:

◆ isAllowedAttribute()

static arFieldList::isAllowedAttribute ( $attribute_name )

staticprotected

Parameters

$attribute_name

Returns: bool

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

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

◆ isField()

arFieldList::isField ( $field_name )

Parameters

$field_name

Returns: bool

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

                                             {
                $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 ( $key )

static

Parameters

$key

Returns: mixed

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

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

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

Here is the caller graph for this function:

◆ setFields()

arFieldList::setFields ( $fields )

Parameters

array $fields

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

                                           {
                $this->fields = $fields;
        }

References $fields, and fields.

◆ setPrimaryField()

arFieldList::setPrimaryField ( $primary_field )

Parameters

\arField $primary_field

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

                                                        {
                $this->primary_field = $primary_field;
        }

References $primary_field.

Referenced by initFields().

Here is the caller graph for this function:

◆ setPrimaryFields()

arFieldList::setPrimaryFields ( $primary_fields )

Parameters

array $primary_fields

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

                                                          {
                $this->primary_fields = $primary_fields;
        }

References $primary_fields.

◆ setRawFields()

arFieldList::setRawFields ( $raw_fields )

Parameters

array $raw_fields

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

                                                  {
                $this->raw_fields = $raw_fields;
        }

References $raw_fields.

Referenced by initRawFields().

Here is the caller graph for this function:

Field Documentation

◆ $allowed_connector_fields

arFieldList::$allowed_connector_fields

staticprotected

Initial value:

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

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

Referenced by getAllowedConnectorFields().

◆ $allowed_description_fields

arFieldList::$allowed_description_fields

staticprotected

Initial value:

= array(
                self::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

arFieldList::$ar

protected

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

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

◆ $fields

arFieldList::$fields = array()

protected

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

Referenced by getFields(), and setFields().

◆ $key_maps

arFieldList::$key_maps

staticprotected

Initial value:

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

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

◆ $prefixes

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

staticprotected

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

◆ $primary_field

arFieldList::$primary_field

protected

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

Referenced by getPrimaryField(), and setPrimaryField().

◆ $primary_fields

arFieldList::$primary_fields = array()

protected

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

Referenced by getPrimaryFields(), and setPrimaryFields().

◆ $protected_names

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

staticprotected

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

◆ $raw_fields

arFieldList::$raw_fields = array()

protected

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

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

◆ FIELDTYPE

const arFieldList::FIELDTYPE = 'fieldtype'

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

Referenced by arField\isAllowedAttribute().

◆ HAS_FIELD

const arFieldList::HAS_FIELD = 'has_field'

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

Referenced by arField\isAllowedAttribute().

◆ INDEX

const arFieldList::INDEX = 'index'

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

◆ IS_NOTNULL

const arFieldList::IS_NOTNULL = 'is_notnull'

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

◆ IS_PRIMARY

const arFieldList::IS_PRIMARY = 'is_primary'

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

◆ IS_UNIQUE

const arFieldList::IS_UNIQUE = 'is_unique'

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

◆ LENGTH

const arFieldList::LENGTH = 'length'

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

◆ SEQUENCE

const arFieldList::SEQUENCE = 'sequence'

Definition at line 19 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

◆ IS_UNIQUE

◆ LENGTH

◆ SEQUENCE