Открытые члены
	__construct ()

	addElement (ChainElement $element)

	prependElement (ChainElement $element)

	prepend (Chain $chain)

	getFirstElement ()

	getLastElement ()

	getAllElements ()

	removeLastElement ()

	removeFirstElement ()

	hasBackReference ()

	getSize ()

	getDefinition ($elementsSlice=0)

	getDefinitionParts ()

	getAlias ()

	setCustomAlias ($alias)

	hasAggregation ()

	hasSubquery ()

	isConstant ()

	forceDataDoublingOff ()

	forcesDataDoublingOff ()

	getSqlDefinition ($with_alias=false)

	__clone ()

	dump ()

Открытые статические члены
static	getChainByDefinition (Entity $init_entity, $definition)

static	getDefinitionByChain (Chain $chain)

static	getDefinitionPartsByChain (Chain $chain)

static	appendDefinition ($currentDefinition, $newDefinitionPart)

static	getAliasByChain (Chain $chain)

static	getAliasByDefinition (Entity $entity, $definition)

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

	$size = 0

	$definition

	$definitionParts

	$alias

	$custom_alias

	$forcesDataDoublingOff = false

	$last_element

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

См. определение в файле main/lib/orm/query/chain.php строка 13

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

◆ __construct()

__construct ( )

См. определение в файле main/lib/orm/query/chain.php строка 36

     {
         $this->chain = array();
     }

Методы

◆ __clone()

__clone ( )

См. определение в файле main/lib/orm/query/chain.php строка 510

     {
         $this->custom_alias = null;
     }

◆ addElement()

addElement ( ChainElement $element )

Аргументы

ChainElement $element

Исключения

SystemException

См. определение в файле main/lib/orm/query/chain.php строка 46

     {
         if (empty($this->chain) && !($element->getValue() instanceof Entity))
         {
             throw new SystemException('The first element of chain should be Entity only.');
         }
  
         $this->chain[] = $element;
         $this->definition = null;
         $this->definitionParts = null;
         $this->alias = null;
  
         $this->last_element = $element;
         $this->size++;
     }

◆ appendDefinition()

static appendDefinition	(	$currentDefinition,
		$newDefinitionPart
	)

static

См. определение в файле main/lib/orm/query/chain.php строка 383

     {
         if ($currentDefinition !== '')
         {
             $currentDefinition .= '.';
         }
  
         return $currentDefinition.$newDefinitionPart;
     }

◆ dump()

dump ( )

См. определение в файле main/lib/orm/query/chain.php строка 515

     {
         echo '  '.'   forcesDataDoublingOff: '.($this->forcesDataDoublingOff()?'true':'false');
         echo PHP_EOL;
  
         $i = 0;
         foreach ($this->chain as $elem)
         {
             echo '  '.++$i.'. ';
             $elem->dump();
             echo PHP_EOL;
         }
     }

◆ forceDataDoublingOff()

forceDataDoublingOff ( )

См. определение в файле main/lib/orm/query/chain.php строка 481

     {
         $this->forcesDataDoublingOff = true;
     }

◆ forcesDataDoublingOff()

forcesDataDoublingOff ( )

См. определение в файле main/lib/orm/query/chain.php строка 486

     {
         return $this->forcesDataDoublingOff;
     }

◆ getAlias()

getAlias ( )

См. определение в файле main/lib/orm/query/chain.php строка 180

     {
         if ($this->custom_alias !== null)
         {
             return $this->custom_alias;
         }
  
         if ($this->alias === null)
         {
             $this->alias = self::getAliasByChain($this);
         }
  
         return $this->alias;
     }

◆ getAliasByChain()

static getAliasByChain ( Chain $chain )

static

См. определение в файле main/lib/orm/query/chain.php строка 393

     {
         $alias = array();
  
         $elements = $chain->getAllElements();
  
         // add prefix of init entity
         if (count($elements) > 2)
         {
             $alias[] = $chain->getFirstElement()->getAliasFragment();
         }
  
         // add other members of chain
         /** @var ChainElement[] $elements */
         $elements = array_slice($elements, 1);
  
         foreach ($elements  as $element)
         {
             $fragment = $element->getAliasFragment();
  
             if($fragment <> '')
             {
                 $alias[] = $fragment;
             }
         }
  
         return join('_', $alias);
     }

◆ getAliasByDefinition()

static getAliasByDefinition	(	Entity	$entity,
			$definition
	)

static

Аргументы

Entity	$entity
	$definition

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

Исключения

Main

См. определение в файле main/lib/orm/query/chain.php строка 430

     {
         return self::getChainByDefinition($entity, $definition)->getAlias();
     }

◆ getAllElements()

getAllElements ( )

Возвращает: array|ChainElement[]

См. определение в файле main/lib/orm/query/chain.php строка 104

     {
         return $this->chain;
     }

◆ getChainByDefinition()

static getChainByDefinition	(	Entity	$init_entity,
			$definition
	)

static

Аргументы

Entity	$init_entity
	$definition

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

Исключения

Main

См. определение в файле main/lib/orm/query/chain.php строка 208

     {
         if (!is_string($definition))
         {
             throw new Main\ArgumentException('String expected, but `'.gettype($definition).'` is given.');
         }
  
         $chain = new Chain;
         $chain->addElement(new ChainElement($init_entity));
  
         $def_elements = explode('.', $definition);
         $def_elements_size = count($def_elements);
  
         $prev_entity  = $init_entity;
  
         $i = 0;
  
         foreach ($def_elements as &$def_element)
         {
             $is_last_elem  = (++$i == $def_elements_size);
  
             $not_found = false;
  
             // all elements should be a Reference field or Entity
             // normal (scalar) field can only be the last element
  
             if ($prev_entity->hasField($def_element))
             {
                 // field has been found at current entity
                 $field = $prev_entity->getField($def_element);
  
                 if ($field instanceof Reference)
                 {
                     $prev_entity = $field->getRefEntity();
                 }
                 elseif ($field instanceof ExpressionField)
                 {
                     // expr can be in the middle too
                 }
                 elseif ($field instanceof OneToMany)
                 {
                     $prev_entity = $field->getRefEntity();
                 }
                 elseif ($field instanceof ManyToMany)
                 {
                     $prev_entity = $field->getRefEntity();
                 }
                 elseif (!$is_last_elem)
                 {
                     throw new SystemException(sprintf(
                         'Normal fields can be only the last in chain, `%s` %s is not the last.',
                         $field->getName(), get_class($field)
                     ));
                 }
  
                 if ($is_last_elem && $field instanceof ExpressionField)
                 {
                     // we should have own copy of build_from_chains to set join aliases there
                     $field = clone $field;
                 }
  
                 $chain->addElement(new ChainElement($field));
             }
             elseif (Entity::isExists($def_element)
                 && Entity::getInstance($def_element)->getReferencesCountTo($prev_entity->getName()) == 1
             )
             {
                 // def_element is another entity with only 1 reference to current entity
                 // need to identify Reference field
                 $ref_entity = Entity::getInstance($def_element);
                 $field = end($ref_entity->getReferencesTo($prev_entity->getName()));
  
                 $prev_entity = $ref_entity;
  
                 $chain->addElement(new ChainElement(
                     array($ref_entity, $field)
                 ));
             }
             elseif ( ($pos_wh = strpos($def_element, ':')) > 0 )
             {
                 $ref_entity_name = substr($def_element, 0, $pos_wh);
  
                 if (strpos($ref_entity_name, '\\') === false)
                 {
                     // if reference has no namespace, then it'is in the namespace of previous entity
                     $ref_entity_name = $prev_entity->getNamespace().$ref_entity_name;
                 }
  
                 if (
                     Entity::isExists($ref_entity_name)
                     && Entity::getInstance($ref_entity_name)->hasField($ref_field_name = substr($def_element, $pos_wh + 1))
                     && Entity::getInstance($ref_entity_name)->getField($ref_field_name) instanceof Reference
                 )
                 {
                     /** @var Reference $reference */
                     $reference = Entity::getInstance($ref_entity_name)->getField($ref_field_name);
  
                     if (
                         $reference->getRefEntity()->getFullName() == $prev_entity->getFullName() ||
                         is_subclass_of(
                             $prev_entity->getDataClass(),
                             $reference->getRefEntity()->getDataClass()
                         )
                     )
                     {
                         // chain element is another entity with >1 references to current entity
                         // def like NewsArticle:AUTHOR, NewsArticle:LAST_COMMENTER
                         // NewsArticle - entity, AUTHOR and LAST_COMMENTER - Reference fields
                         $chain->addElement(new ChainElement(array(
                             Entity::getInstance($ref_entity_name),
                             Entity::getInstance($ref_entity_name)->getField($ref_field_name)
                         )));
  
                         $prev_entity = Entity::getInstance($ref_entity_name);
                     }
                     else
                     {
                         $not_found = true;
                     }
                 }
                 else
                 {
                     $not_found = true;
                 }
  
             }
             elseif ($def_element == '*' && $is_last_elem)
             {
                 continue;
             }
             else
             {
                 // unknown chain
                 $not_found = true;
             }
  
             if ($not_found)
             {
                 throw new SystemException(sprintf(
                     'Unknown field definition `%s` (%s) for %s Entity.',
                     $def_element, $definition, $prev_entity->getFullName()
                 ), 100);
             }
         }
  
         return $chain;
     }

◆ getDefinition()

getDefinition ( $elementsSlice = 0 )

Аргументы

int $elementsSlice Definition length, e.g. -1 would exclude last element.

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

См. определение в файле main/lib/orm/query/chain.php строка 153

     {
         if (!isset($this->definition[$elementsSlice]))
         {
             $this->definition[$elementsSlice] = join('.',
                 $elementsSlice == 0
                     ? $this->getDefinitionParts()
                     : array_slice($this->getDefinitionParts(), 0, $elementsSlice)
             );
         }
  
         return $this->definition[$elementsSlice];
     }

◆ getDefinitionByChain()

static getDefinitionByChain ( Chain $chain )

static

См. определение в файле main/lib/orm/query/chain.php строка 356

     {
         return join('.', static::getDefinitionPartsByChain($chain));
     }

◆ getDefinitionParts()

getDefinitionParts ( )

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

См. определение в файле main/lib/orm/query/chain.php строка 170

     {
         if (is_null($this->definitionParts))
         {
             $this->definitionParts = static::getDefinitionPartsByChain($this);
         }
  
         return $this->definitionParts;
     }

◆ getDefinitionPartsByChain()

static getDefinitionPartsByChain ( Chain $chain )

static

См. определение в файле main/lib/orm/query/chain.php строка 361

     {
         $def = array();
  
         // add members of chain except of init entity
         /** @var $elements ChainElement[] */
         $elements = array_slice($chain->getAllElements(), 1);
  
         foreach ($elements  as $element)
         {
             //if ($element->getValue() instanceof ExpressionField && $element !== end($elements))
             {
                 // skip non-last expressions
                 //continue;
             }
  
             $def[] = $element->getDefinitionFragment();
         }
  
         return $def;
     }

◆ getFirstElement()

getFirstElement ( )

См. определение в файле main/lib/orm/query/chain.php строка 88

     {
         return $this->chain[0];
     }

◆ getLastElement()

getLastElement ( )

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

См. определение в файле main/lib/orm/query/chain.php строка 96

     {
         return $this->last_element;
     }

◆ getSize()

getSize ( )

См. определение в файле main/lib/orm/query/chain.php строка 143

     {
         return $this->size;
     }

◆ getSqlDefinition()

getSqlDefinition ( $with_alias = false )

Аргументы

bool $with_alias

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

Исключения

SystemException

См. определение в файле main/lib/orm/query/chain.php строка 497

     {
         $sql_def = $this->getLastElement()->getSqlDefinition();
  
         if ($with_alias)
         {
             $helper = $this->getLastElement()->getValue()->getEntity()->getConnection()->getSqlHelper();
             $sql_def .= ' AS ' . $helper->quote($this->getAlias());
         }
  
         return $sql_def;
     }

◆ hasAggregation()

hasAggregation ( )

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

Исключения

SystemException

См. определение в файле main/lib/orm/query/chain.php строка 439

     {
         $elements = array_reverse($this->chain);
  
         foreach ($elements as $element)
         {
             /** @var $element ChainElement */
             if ($element->getValue() instanceof ExpressionField && $element->getValue()->isAggregated())
             {
                 return true;
             }
         }
  
         return false;
     }

◆ hasBackReference()

hasBackReference ( )

См. определение в файле main/lib/orm/query/chain.php строка 130

     {
         foreach ($this->chain as $element)
         {
             if ($element->isBackReference())
             {
                 return true;
             }
         }
  
         return false;
     }

◆ hasSubquery()

hasSubquery ( )

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

Исключения

SystemException

См. определение в файле main/lib/orm/query/chain.php строка 459

     {
         $elements = array_reverse($this->chain);
  
         foreach ($elements as $element)
         {
             /** @var $element ChainElement */
             if ($element->getValue() instanceof ExpressionField && $element->getValue()->hasSubquery())
             {
                 return true;
             }
         }
  
         return false;
     }

◆ isConstant()

isConstant ( )

См. определение в файле main/lib/orm/query/chain.php строка 475

     {
         return ($this->getLastElement()->getValue() instanceof ExpressionField
             && $this->getLastElement()->getValue()->isConstant());
     }

◆ prepend()

prepend ( Chain $chain )

Аргументы

Chain $chain

См. определение в файле main/lib/orm/query/chain.php строка 78

     {
         $elements = $chain->getAllElements();
  
         for ($i=count($elements)-1; $i>=0; $i--)
         {
             $this->prependElement($elements[$i]);
         }
     }

◆ prependElement()

prependElement ( ChainElement $element )

Аргументы

ChainElement $element

См. определение в файле main/lib/orm/query/chain.php строка 65

     {
         $this->chain = array_merge(array($element), $this->chain);
         $this->definition = null;
         $this->definitionParts = null;
         $this->alias = null;
  
         $this->size++;
     }

◆ removeFirstElement()

removeFirstElement ( )

См. определение в файле main/lib/orm/query/chain.php строка 120

     {
         $this->chain = array_slice($this->chain, 1);
         $this->definition = null;
         $this->definitionParts = null;
         $this->alias = null;
  
         $this->size--;
     }

◆ removeLastElement()

removeLastElement ( )

См. определение в файле main/lib/orm/query/chain.php строка 109

     {
         $this->chain = array_slice($this->chain, 0, -1);
         $this->definition = null;
         $this->definitionParts = null;
         $this->alias = null;
  
         $this->last_element = end($this->chain);
         $this->size--;
     }

◆ setCustomAlias()

setCustomAlias ( $alias )

См. определение в файле main/lib/orm/query/chain.php строка 195

     {
         $this->custom_alias = $alias;
     }

Поля

◆ $alias

$alias

protected

См. определение в файле main/lib/orm/query/chain.php строка 26

◆ $chain

$chain

protected

См. определение в файле main/lib/orm/query/chain.php строка 16

◆ $custom_alias

$custom_alias

protected

См. определение в файле main/lib/orm/query/chain.php строка 28

◆ $definition

$definition

protected

См. определение в файле main/lib/orm/query/chain.php строка 21

◆ $definitionParts

$definitionParts

protected

См. определение в файле main/lib/orm/query/chain.php строка 24

◆ $forcesDataDoublingOff

$forcesDataDoublingOff = false

protected

См. определение в файле main/lib/orm/query/chain.php строка 31

◆ $last_element

$last_element

protected

См. определение в файле main/lib/orm/query/chain.php строка 34

◆ $size

$size = 0

protected

См. определение в файле main/lib/orm/query/chain.php строка 18

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

main/lib/orm/query/chain.php

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

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

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

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

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

◆ __construct()

Методы

◆ __clone()

◆ addElement()

◆ appendDefinition()

◆ dump()

◆ forceDataDoublingOff()

◆ forcesDataDoublingOff()

◆ getAlias()

◆ getAliasByChain()

◆ getAliasByDefinition()

◆ getAllElements()

◆ getChainByDefinition()

◆ getDefinition()

◆ getDefinitionByChain()

◆ getDefinitionParts()

◆ getDefinitionPartsByChain()

◆ getFirstElement()

◆ getLastElement()

◆ getSize()

◆ getSqlDefinition()

◆ hasAggregation()

◆ hasBackReference()

◆ hasSubquery()

◆ isConstant()

◆ prepend()

◆ prependElement()

◆ removeFirstElement()

◆ removeLastElement()

◆ setCustomAlias()

Поля

◆ $alias

◆ $chain

◆ $custom_alias

◆ $definition

◆ $definitionParts

◆ $forcesDataDoublingOff

◆ $last_element

◆ $size