arFieldList Class Reference

Class arFieldList. More...

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

References $ar.

    {
        $this->ar = $ar;
    }

Member Function Documentation

checkAttributes()

static arFieldList::checkAttributes ( array  $attributes )

staticprotected

Parameters

array

$attributes

Returns

bool

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

    {
        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

array

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

Referenced by arField\getAttributesForConnector().

    {
        return self::$allowed_connector_fields;
    }

Here is the caller graph for this function:

getAllowedDescriptionFields()

static arFieldList::getAllowedDescriptionFields ( )

static

Returns

array

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

Referenced by arField\getAttributesForDescription().

    {
        return self::$allowed_description_fields;
    }

Here is the caller graph for this function:

getArrayForConnector()

arFieldList::getArrayForConnector

(

)

Returns

array

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

References getFields().

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

        return $return;
    }

Here is the call graph for this function:

getFieldByName()

arFieldList::getFieldByName

(

$field_name

)

Parameters

$field_name

Returns

arField

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

References getFields().

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

Here is the call graph for this function:

getFields()

arFieldList::getFields

(

)

Returns

arField[]

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

References $fields.

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

    {
        return $this->fields;
    }

Here is the caller graph for this function:

getInstance()

static arFieldList::getInstance ( ActiveRecord  $ar )

static

Parameters

ActiveRecord

$ar

Returns

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

References $ar.

Referenced by arFieldCache\store().

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

        return $arFieldList;
    }

Here is the caller graph for this function:

getInstanceFromStorage()

static arFieldList::getInstanceFromStorage (   $ar )

static

Parameters

ActiveRecord

$ar

Deprecated:

Returns

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

References $ar.

Referenced by arFieldCache\storeFromStorage().

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

        return $arFieldList;
    }

Here is the caller graph for this function:

getPrimaryField()

arFieldList::getPrimaryField

(

)

Returns

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

References $primary_field.

Referenced by getPrimaryFieldName(), and getPrimaryFieldType().

    {
        return $this->primary_field;
    }

Here is the caller graph for this function:

getPrimaryFieldName()

arFieldList::getPrimaryFieldName

(

)

Returns

string

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

References getPrimaryField().

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

Here is the call graph for this function:

getPrimaryFields()

arFieldList::getPrimaryFields

(

)

Returns

array

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

References $primary_fields.

    {
        return $this->primary_fields;
    }

getPrimaryFieldType()

arFieldList::getPrimaryFieldType

(

)

Returns

mixed

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

References getPrimaryField().

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

Here is the call graph for this function:

getRawFields()

arFieldList::getRawFields

(

)

Returns

array

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

References $raw_fields.

Referenced by initFields().

    {
        return $this->raw_fields;
    }

Here is the caller graph for this function:

initFields()

arFieldList::initFields ( )

protected

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

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

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

Here is the call graph for this function:

initRawFields()

arFieldList::initRawFields ( arStorageInterface  $ar )

protected

Parameters

\ActiveRecord | \arStorageInterface

$ar

Returns

array

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

References $raw_fields, and setRawFields().

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

Here is the call graph for this function:

isAllowedAttribute()

static arFieldList::isAllowedAttribute (   $attribute_name )

staticprotected

Parameters

$attribute_name

Returns

bool

Definition at line 278 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 211 of file class.arFieldList.php.

References getFields().

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

        return $is_field;
    }

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.

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

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

        return $key;
    }

Here is the caller graph for this function:

setFields()

arFieldList::setFields

(

$fields

)

Parameters

array

$fields

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

References $fields, and fields.

    {
        $this->fields = $fields;
    }

setPrimaryField()

arFieldList::setPrimaryField

(

$primary_field

)

Parameters

\arField

$primary_field

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

References $primary_field.

Referenced by initFields().

    {
        $this->primary_field = $primary_field;
    }

Here is the caller graph for this function:

setPrimaryFields()

arFieldList::setPrimaryFields

(

$primary_fields

)

Parameters

array

$primary_fields

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

References $primary_fields.

    {
        $this->primary_fields = $primary_fields;
    }

setRawFields()

arFieldList::setRawFields

(

$raw_fields

)

Parameters

array

$raw_fields

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

References $raw_fields.

Referenced by initRawFields().

    {
        $this->raw_fields = $raw_fields;
    }

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

$allowed_description_fields

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

$ar

arFieldList::$ar

protected

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

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

$fields

arFieldList::$fields = array()

protected

Definition at line 63 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 71 of file class.arFieldList.php.

$prefixes

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

staticprotected

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

$primary_field

arFieldList::$primary_field

protected

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

Referenced by getPrimaryField(), and setPrimaryField().

$primary_fields

arFieldList::$primary_fields = array()

protected

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

Referenced by getPrimaryFields(), and setPrimaryFields().

$protected_names

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

staticprotected

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

$raw_fields

arFieldList::$raw_fields = array()

protected

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

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

FIELDTYPE

const arFieldList::FIELDTYPE = 'fieldtype'

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

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

HAS_FIELD

const arFieldList::HAS_FIELD = 'has_field'

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

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

INDEX

const arFieldList::INDEX = 'index'

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

IS_NOTNULL

const arFieldList::IS_NOTNULL = 'is_notnull'

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

Referenced by arConverter\returnAttributesForField().

IS_PRIMARY

const arFieldList::IS_PRIMARY = 'is_primary'

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

Referenced by arConverter\returnAttributesForField().

LENGTH

const arFieldList::LENGTH = 'length'

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

Referenced by arConverter\returnAttributesForField().

SEQUENCE

const arFieldList::SEQUENCE = 'sequence'

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

---

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

• Services/ActiveRecord/Fields/class.arFieldList.php