Граф наследования:EntityObject:

Открытые члены
	__construct ($setDefaultValues=true)
	EntityObject constructor. Подробнее...

	__clone ()

	collectValues ($valuesType=Values::ALL, $fieldsMask=FieldTypeMask::ALL, $recursive=false)
	Returns all objects values as an array. Подробнее...

	save ()
	ActiveRecord save. Подробнее...

	delete ()
	ActiveRecord delete. Подробнее...

	fill ($fields=FieldTypeMask::ALL)
	Fills all the values and relations of object. Подробнее...

	getId ()
	Fast popular alternative to __call(). Подробнее...

	get ($fieldName)

	remindActual ($fieldName)

Открытые статические члены
static	wakeUp ($row)
	Constructs existing object from pre-selected data, including references and relations. Подробнее...

Статические открытые данные
static	$dataClass

Защищенные члены
	cloneValues (array $values)

	filterValuesByMask (array $values, int $fieldsMask, bool $invertedFilter=false)

Защищенные данные
	$_entity

	$_state = State::RAW

	$_actualValues = []

	$_currentValues = []

	$_runtimeValues = []

	$_customData = null

	$_onPrimarySetListeners = []

	$_authContext

Статические защищенные данные
static	$_camelToSnakeCache = []

static	$_snakeToCamelCache = []

Подробное описание

См. определение в файле entityobject.php строка 47

Конструктор(ы)

◆ __construct()

__construct ( $setDefaultValues = true )

final

EntityObject constructor.

Аргументы

bool | array $setDefaultValues

Исключения

ArgumentException
SystemException

См. определение в файле entityobject.php строка 113

     {
         if (is_array($setDefaultValues))
         {
             // we have custom default values
             foreach ($setDefaultValues as $fieldName => $defaultValue)
             {
                 $this->set($fieldName, $defaultValue);
             }
         }
  
         if ($setDefaultValues || is_array($setDefaultValues))
         {
             foreach ($this->entity->getScalarFields() as $fieldName => $field)
             {
                 if ($this->sysHasValue($fieldName))
                 {
                     // already set custom default value
                     continue;
                 }
  
                 $defaultValue = $field->getDefaultValue($this);
  
                 if ($defaultValue !== null)
                 {
                     $this->set($fieldName, $defaultValue);
                 }
             }
         }
     }

Методы

◆ __clone()

__clone ( )

См. определение в файле entityobject.php строка 144

     {
         $this->_actualValues = $this->cloneValues($this->_actualValues);
         $this->_currentValues = $this->cloneValues($this->_currentValues);
     }

◆ cloneValues()

cloneValues ( array $values )

protected

См. определение в файле entityobject.php строка 150

                                                  : array
     {
         // Do not clone References to avoid infinite recursion
         $valuesWithoutReferences = $this->filterValuesByMask($values, FieldTypeMask::REFERENCE, true);
         $references = array_diff_key($values, $valuesWithoutReferences);
  
         return array_merge($references, \Bitrix\Main\Type\Collection::clone($valuesWithoutReferences));
     }

◆ collectValues()

collectValues	(	$valuesType = `Values::ALL`,
		$fieldsMask = `FieldTypeMask::ALL`,
		$recursive = `false`
	)

final

Returns all objects values as an array.

Аргументы

int	$valuesType
int	$fieldsMask
bool	$recursive

Возвращает: array

Исключения

ArgumentException

См. определение в файле entityobject.php строка 185

     {
         switch ($valuesType)
         {
             case Values::ACTUAL:
                 $objectValues = $this->_actualValues;
                 break;
             case Values::CURRENT:
                 $objectValues = $this->_currentValues;
                 break;
             default:
                 $objectValues = array_merge($this->_actualValues, $this->_currentValues);
         }
  
         // filter with field mask
         if ($fieldsMask !== FieldTypeMask::ALL)
         {
             foreach ($objectValues as $fieldName => $value)
             {
                 $fieldMask = $this->entity->getField($fieldName)->getTypeMask();
                 if (!($fieldsMask & $fieldMask))
                 {
                     unset($objectValues[$fieldName]);
                 }
             }
         }
  
         // recursive convert object to array
         if ($recursive)
         {
             foreach ($objectValues as $fieldName => $value)
             {
                 if ($value instanceof EntityObject)
                 {
                     $objectValues[$fieldName] = $value->collectValues($valuesType, $fieldsMask, $recursive);
                 }
                 elseif ($value instanceof Collection)
                 {
                     $arrayCollection = [];
                     foreach ($value as $relationObject)
                     {
                         $arrayCollection[] = $relationObject->collectValues($valuesType, $fieldsMask, $recursive);
                     }
                     $objectValues[$fieldName] = $arrayCollection;
                 }
             }
         }
  
         // remap from uppercase to real field names
         $values = [];
  
         foreach ($objectValues as $k => $v)
         {
             $values[$this->entity->getField($k)->getName()] = $v;
         }
  
         return $values;
     }

◆ delete()

delete ( )

final

ActiveRecord delete.

Возвращает: Result

Исключения

ArgumentException
SystemException

См. определение в файле entityobject.php строка 333

     {
         $result = new Result;
  
         // delete relations
         foreach ($this->entity->getFields() as $field)
         {
             if ($field instanceof Reference)
             {
                 if ($field->getCascadeDeletePolicy() === CascadePolicy::FOLLOW)
                 {
                     /** @var EntityObject $remoteObject */
                     $remoteObject = $this->sysGetValue($field->getName());
                     $remoteObject->delete();
                 }
             }
             elseif ($field instanceof OneToMany)
             {
                 if ($field->getCascadeDeletePolicy() === CascadePolicy::FOLLOW)
                 {
                     // delete
                     $collection = $this->sysFillRelationCollection($field);
  
                     foreach ($collection as $object)
                     {
                         $object->delete();
                     }
                 }
                 elseif ($field->getCascadeDeletePolicy() === CascadePolicy::SET_NULL)
                 {
                     // set null
                     $this->sysRemoveAllFromCollection($field->getName());
                 }
             }
             elseif ($field instanceof ManyToMany)
             {
                 if ($field->getCascadeDeletePolicy() === CascadePolicy::FOLLOW_ORPHANS)
                 {
                     // delete
                 }
                 elseif ($field->getCascadeDeletePolicy() === CascadePolicy::SET_NULL)
                 {
                     // set null
                 }
  
                 // always delete mediator records
                 $this->sysRemoveAllFromCollection($field->getName());
             }
         }
  
         $this->sysSaveRelations($result);
  
         // delete object itself
         $dataClass = static::$dataClass;
         $deleteResult = $dataClass::delete($this->primary);
  
         if (!$deleteResult->isSuccess())
         {
             $result->addErrors($deleteResult->getErrors());
         }
  
         // clear status
         foreach ($this->entity->getPrimaryArray()as $primaryName)
         {
             unset($this->_actualValues[$primaryName]);
         }
  
         $this->sysChangeState(State::DELETED);
  
         return $result;
     }

◆ fill()

fill ( $fields = FieldTypeMask::ALL )

final

Fills all the values and relations of object.

Аргументы

int | string[] $fields Names of fields to fill

Возвращает: mixed

Исключения

ArgumentException
SystemException

См. определение в файле entityobject.php строка 525

     {
         // object must have primary
         $primaryFilter = Query::filter();
  
         foreach ($this->sysRequirePrimary() as $primaryName => $primaryValue)
         {
             $primaryFilter->where($primaryName, $primaryValue);
         }
  
         // collect fields to be selected
         if (is_array($fields))
         {
             // go through IDLE fields
             $fieldsToSelect = $this->sysGetIdleFields($fields);
         }
         elseif (is_scalar($fields) && !is_numeric($fields))
         {
             // one custom field
             $fields = [$fields];
             $fieldsToSelect = $this->sysGetIdleFields($fields);
         }
         else
         {
             // get fields according to selector mask
             $fieldsToSelect = $this->sysGetIdleFieldsByMask($fields);
         }
  
         if (!empty($fieldsToSelect))
         {
             $fieldsToSelect = array_merge($this->entity->getPrimaryArray(), $fieldsToSelect);
  
             // build query
             $dataClass = $this->entity->getDataClass();
             $result = $dataClass::query()->setSelect($fieldsToSelect)->where($primaryFilter)->exec();
  
             // set object to identityMap of result, and it will be partially completed by fetch
             $im = new IdentityMap;
             $im->put($this);
  
             $result->setIdentityMap($im);
             $result->fetchObject();
  
             // set filled flag to collections
             foreach ($fieldsToSelect as $fieldName)
             {
                 // check field before continue, it could be remote REF.ID definition so we skip it here
                 if ($this->entity->hasField($fieldName))
                 {
                     $field = $this->entity->getField($fieldName);
  
                     if ($field instanceof OneToMany || $field instanceof ManyToMany)
                     {
                         /** @var Collection $collection */
                         $collection = $this->sysGetValue($fieldName);
  
                         if (empty($collection))
                         {
                             $collection = $field->getRefEntity()->createCollection();
                             $this->_actualValues[$fieldName] = $collection;
                         }
  
                         $collection->sysSetFilled();
                     }
                 }
             }
         }
  
         // return field value it it was only one
         if (is_array($fields) && count($fields) == 1 && $this->entity->hasField(current($fields)))
         {
             return $this->sysGetValue(current($fields));
         }
  
         return null;
     }

◆ filterValuesByMask()

filterValuesByMask	(	array	$values,
		int	$fieldsMask,
		bool	$invertedFilter = `false`
	)

protected

См. определение в файле entityobject.php строка 159

                                                                                                        : array
     {
         if ($fieldsMask === FieldTypeMask::ALL)
         {
             return $invertedFilter ? [] : $values;
         }
  
         return array_filter($values, function($fieldName) use ($fieldsMask, $invertedFilter)
         {
             $maskOfSingleField = $this->entity->getField($fieldName)->getTypeMask();
             $matchesMask = (bool)($fieldsMask & $maskOfSingleField);
  
             return $invertedFilter ? !$matchesMask: $matchesMask;
         }, ARRAY_FILTER_USE_KEY);
     }

◆ get()

get ( $fieldName )

final

Аргументы

$fieldName

Возвращает: mixed

Исключения

ArgumentException
SystemException

См. определение в файле entityobject.php строка 637

     {
         return $this->__call(__FUNCTION__, func_get_args());
     }

◆ getId()

getId ( )

Fast popular alternative to __call().

Возвращает: Collection|EntityObject|mixed

Исключения

SystemException

См. определение в файле entityobject.php строка 608

     {
         if (array_key_exists('ID', $this->_currentValues))
         {
             return $this->_currentValues['ID'];
         }
         elseif (array_key_exists('ID', $this->_actualValues))
         {
             return $this->_actualValues['ID'];
         }
         elseif (!$this->entity->hasField('ID'))
         {
             throw new SystemException(sprintf(
                 'Unknown method `%s` for object `%s`', 'getId', get_called_class()
             ));
         }
         else
         {
             return null;
         }
     }

◆ remindActual()

remindActual ( $fieldName )

final

Аргументы

$fieldName

Возвращает: mixed

Исключения

ArgumentException
SystemException

См. определение в файле entityobject.php строка 649

     {
         return $this->__call(__FUNCTION__, func_get_args());
     }

◆ save()

save ( )

final

ActiveRecord save.

Возвращает: Result

Исключения

ArgumentException
SystemException

См. определение в файле entityobject.php строка 252

     {
         // default empty result
         switch ($this->state)
         {
             case State::RAW:
                 $result = new AddResult;
                 break;
             case State::CHANGED:
             case State::ACTUAL:
                 $result = new UpdateResult;
                 break;
             default:
                 $result = new Result;
         }
  
         $dataClass = $this->entity->getDataClass();
  
         if ($this->_state == State::RAW)
         {
             $data = $this->_currentValues;
             $data['__object'] = $this;
  
             // put secret key __object to array
             $result = $dataClass::add($data);
  
             // check for error
             if (!$result->isSuccess())
             {
                 return $result;
             }
  
             // set primary
             foreach ($result->getPrimary() as $primaryName => $primaryValue)
             {
                 $this->sysSetActual($primaryName, $primaryValue);
             }
  
             // on primary gain event
             $this->sysOnPrimarySet();
         }
         elseif ($this->_state == State::CHANGED)
         {
             // changed scalar and reference
             if (!empty($this->_currentValues))
             {
                 $data = $this->_currentValues;
                 $data['__object'] = $this;
  
                 // put secret key __object to array
                 $result = $dataClass::update($this->primary, $data);
  
                 // check for error
                 if (!$result->isSuccess())
                 {
                     return $result;
                 }
             }
         }
  
         // changed collections
         $this->sysSaveRelations($result);
  
         // return if there were errors
         if (!$result->isSuccess())
         {
             return $result;
         }
  
         $this->sysPostSave();
  
         return $result;
     }

◆ wakeUp()

static wakeUp ( $row )

staticfinal

Constructs existing object from pre-selected data, including references and relations.

Аргументы

mixed $row Array of [field => value] or single scalar primary value.

Возвращает: static

Исключения

ArgumentException
SystemException

См. определение в файле entityobject.php строка 414

     {
         /** @var static $objectClass */
         $objectClass = get_called_class();
  
         /** @var \Bitrix\Main\ORM\Data\DataManager $dataClass */
         $dataClass = static::$dataClass;
  
         $entity = $dataClass::getEntity();
         $entityPrimary = $entity->getPrimaryArray();
  
         // normalize input data and primary
         $primary = [];
  
         if (!is_array($row))
         {
             // it could be single primary
             if (count($entityPrimary) == 1)
             {
                 $primary[$entityPrimary[0]] = $row;
                 $row = [];
             }
             else
             {
                 throw new ArgumentException(sprintf(
                     'Multi-primary for %s was not found', $objectClass
                 ));
             }
         }
         else
         {
             foreach ($entityPrimary as $primaryName)
             {
                 if (!isset($row[$primaryName]))
                 {
                     throw new ArgumentException(sprintf(
                         'Primary %s for %s was not found', $primaryName, $objectClass
                     ));
                 }
  
                 $primary[$primaryName] = $row[$primaryName];
                 unset($row[$primaryName]);
             }
         }
  
         // create object
         /** @var static $object */
         $object = new $objectClass(false); // here go with false to not set default values
         $object->sysChangeState(State::ACTUAL);
  
         // set primary
         foreach ($primary as $primaryName => $primaryValue)
         {
             /** @var ScalarField $primaryField */
             $primaryField = $entity->getField($primaryName);
             $object->sysSetActual($primaryName, $primaryField->cast($primaryValue));
         }
  
         // set other data
         foreach ($row as $fieldName => $value)
         {
             /** @var ScalarField $primaryField */
             $field = $entity->getField($fieldName);
  
             if ($field instanceof IReadable)
             {
                 $object->sysSetActual($fieldName, $field->cast($value));
             }
             else
             {
                 // we have a relation
                 if ($value instanceof static || $value instanceof Collection)
                 {
                     // it is ready data
                     $object->sysSetActual($fieldName, $value);
                 }
                 else
                 {
                     // wake up relation
                     if ($field instanceof Reference)
                     {
                         // wake up an object
                         $remoteObjectClass = $field->getRefEntity()->getObjectClass();
                         $remoteObject = $remoteObjectClass::wakeUp($value);
  
                         $object->sysSetActual($fieldName, $remoteObject);
                     }
                     elseif ($field instanceof OneToMany || $field instanceof ManyToMany)
                     {
                         // wake up collection
                         $remoteCollectionClass = $field->getRefEntity()->getCollectionClass();
                         $remoteCollection = $remoteCollectionClass::wakeUp($value);
  
                         $object->sysSetActual($fieldName, $remoteCollection);
                     }
                 }
             }
         }
  
         return $object;
     }

Поля

◆ $_actualValues

$_actualValues = []

protected

См. определение в файле entityobject.php строка 68

◆ $_authContext

$_authContext

protected

См. определение в файле entityobject.php строка 91

◆ $_camelToSnakeCache

$_camelToSnakeCache = []

staticprotected

См. определение в файле entityobject.php строка 97

◆ $_currentValues

$_currentValues = []

protected

См. определение в файле entityobject.php строка 74

◆ $_customData

$_customData = null

protected

См. определение в файле entityobject.php строка 85

◆ $_entity

$_entity

protected

См. определение в файле entityobject.php строка 56

◆ $_onPrimarySetListeners

$_onPrimarySetListeners = []

protected

См. определение в файле entityobject.php строка 88

◆ $_runtimeValues

$_runtimeValues = []

protected

См. определение в файле entityobject.php строка 80

◆ $_snakeToCamelCache

$_snakeToCamelCache = []

staticprotected

См. определение в файле entityobject.php строка 103

◆ $_state

$_state = State::RAW

protected

См. определение в файле entityobject.php строка 62

◆ $dataClass

$dataClass

static

См. определение в файле entityobject.php строка 53

Объявления и описания членов класса находятся в файле:

entityobject.php

Открытые члены

Открытые статические члены

Статические открытые данные

Защищенные члены

Защищенные данные

Статические защищенные данные

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ __clone()

◆ cloneValues()

◆ collectValues()

◆ delete()

◆ fill()

◆ filterValuesByMask()

◆ get()

◆ getId()

◆ remindActual()

◆ save()

◆ wakeUp()

Поля

◆ $_actualValues

◆ $_authContext

◆ $_camelToSnakeCache

◆ $_currentValues

◆ $_customData

◆ $_entity

◆ $_onPrimarySetListeners

◆ $_runtimeValues

◆ $_snakeToCamelCache

◆ $_state

◆ $dataClass