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

Открытые члены
	__construct ($name, $expression, $buildFrom=null, $parameters=array())
	All fields in exression should be placed as s (or as another placeholder for sprintf), and the real field names being carrying in $buildFrom array (= args for sprintf) Подробнее...

	__call ($name, $arguments)

	getTypeMask ()

	configureValueType ($class)

	setEntity (Entity $entity)

	getExpression ()

	getFullExpression ()

	isAggregated ()

	hasSubquery ()

	isConstant ()

	getBuildFromChains ()

	getDataType ()

	getValueType ()

	getValueField ()

	__clone ()

	cast ($value)

	convertValueFromDb ($value)

	convertValueToDb ($value)

	validateValue ($value, $primary, $row, Result $result)

Открытые члены унаследованные от Field
	__construct ($name, $parameters=array())

	resetEntity ()

	modifyValueBeforeSave ($value, $data)

	getValidators ()

	addValidator ($validator)

	getFetchDataModifiers ()

	addFetchDataModifier ($modifier)

	getSaveDataModifiers ()

	addSaveDataModifier ($modifier)

	isSerialized ()

	setSerialized ()

	configureSerialized ()

	getName ()

	setName ($name)

	configureTitle ($title)
	Lang phrase. Подробнее...

	getTitle ()

	setParameter ($name, $value)

	getParameter ($name)

	hasParameter ($name)

	setParentField (Field $parentField)

	getParentField ()

	getEntity ()

	getLangCode ()

	getConnection ()

	serialize ($value)

	unserialize ($value)

	postInitialize ()
	Called after being initialized by Entity. Подробнее...

Открытые статические члены
static	checkAggregation ($expression)

static	checkSubquery ($expression)

static	removeSubqueries ($expression)

Открытые статические члены унаследованные от Field
static	getOldDataTypeByClass ($class)

static	getOldDataTypeByField (Field $field)

static	getClassByOldDataType ($dateType)

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

static	$aggrFunctionsORACLE

static	$aggrFunctions

Защищенные статические члены
static	removeStrings ($quote, $expression)

static	removeSubqueryBody ($query)

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

	$fullExpression

	$valueType

	$valueField

	$buildFrom

	$buildFromChains

	$isAggregated

	$hasSubquery

Защищенные данные унаследованные от Field
	$name

	$dataType

	$initialParameters

	$title

	$validation = null

	$validators = null

	$additionalValidators = array()

	$fetchDataModification = null

	$fetchDataModifiers

	$additionalFetchDataModifiers = array()

	$saveDataModification = null

	$saveDataModifiers

	$additionalSaveDataModifiers = array()

	$isSerialized = false

	$parentField

	$entity

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

Статические защищенные данные унаследованные от Field
static	$oldDataTypes

Дополнительные унаследованные члены
Защищенные члены унаследованные от Field
	appendValidator ($validator)

	appendFetchDataModifier ($modifier)

	appendSaveDataModifier ($modifier)

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

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

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

◆ __construct()

__construct	(	$name,
		$expression,
		$buildFrom = `null`,
		$parameters = `array()`
	)

All fields in exression should be placed as s (or as another placeholder for sprintf), and the real field names being carrying in $buildFrom array (= args for sprintf)

Аргументы

string	$name
string	$expression
array \| string \| null	$buildFrom
array	$parameters	deprecated, use configure* and add* instead

Исключения

SystemException

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

     {
         if (!isset($parameters['data_type']))
         {
             $parameters['data_type'] = 'string'; // deprecated
  
             $this->valueType = StringField::class;
         }
  
         parent::__construct($name, $parameters);
  
         $this->expression = $expression;
  
         if (!is_array($buildFrom) && $buildFrom !== null)
         {
             $buildFrom = array($buildFrom);
         }
         elseif ($buildFrom === null)
         {
             $buildFrom = array();
         }
  
         $this->buildFrom = $buildFrom;
     }

Методы

◆ __call()

__call	(	$name,
		$arguments
	)

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

     {
         return call_user_func_array(array($this->valueField, $name), $arguments);
     }

◆ __clone()

__clone ( )

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

     {
         $this->buildFromChains = null;
         $this->fullExpression = null;
     }

◆ cast()

cast ( $value )

Аргументы

mixed $value

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

Замещает IReadable.

Переопределяется в UserTypeField.

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

     {
         $valueField = $this->valueField;
         return $valueField->cast($value);
     }

◆ checkAggregation()

static checkAggregation ( $expression )

static

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

     {
         if (empty(self::$aggrFunctions))
         {
             self::$aggrFunctions = array_unique(array_merge(
                 self::$aggrFunctionsMYSQL, self::$aggrFunctionsMSSQL, self::$aggrFunctionsORACLE
             ));
         }
  
         // should remove subqueries from expression here: EXISTS(..(..)..), (SELECT ..(..)..)
         $expression = static::removeSubqueries($expression);
  
         // then check for aggr functions
         preg_match_all('/(?:^|[^a-z0-9_])('.join('|', self::$aggrFunctions).')[\s\(]+/i', $expression, $matches);
  
         return isset($matches[1]) ? $matches[1] : null;
     }

◆ checkSubquery()

static checkSubquery ( $expression )

static

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

     {
         return (preg_match('/(?:^|[^a-zA-Z0-9_])EXISTS\s*\(/i', $expression) || preg_match('/(?:^|[^a-zA_Z0-9_])\(\s*SELECT/i', $expression));
     }

◆ configureValueType()

configureValueType ( $class )

Аргументы

$class

Возвращает: $this

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

     {
         $this->valueType = $class;
         return $this;
     }

◆ convertValueFromDb()

convertValueFromDb ( $value )

Аргументы

mixed $value

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

Замещает IReadable.

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

     {
         $valueField = $this->valueField;
         return $valueField->convertValueFromDb($value);
     }

◆ convertValueToDb()

convertValueToDb ( $value )

Аргументы

mixed $value

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

Замещает IReadable.

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

     {
         /** @var IStorable $valueField */
         $valueField = $this->valueField;
         return $valueField->convertValueToDb($value);
     }

◆ getBuildFromChains()

getBuildFromChains ( )

Возвращает: array|\Bitrix\Main\ORM\Query\Chain[]

Исключения

SystemException

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

     {
         if (is_null($this->buildFromChains))
         {
             $this->buildFromChains = array();
  
             foreach ($this->buildFrom as $elem)
             {
                 // validate if build from scalar or expression
                 $chain = Chain::getChainByDefinition($this->entity, $elem);
                 $field = $chain->getLastElement()->getValue();
  
                 if ($field instanceof ScalarField || $field instanceof ExpressionField)
                 {
                     $this->buildFromChains[] = $chain;
                 }
                 else
                 {
                     throw new SystemException(sprintf(
                         'Expected ScalarField or ExpressionField in `%s` build_from, but `%s` was given.',
                         $this->name, is_object($field) ? get_class($field).':'.$field->getName() : gettype($field)
                     ));
                 }
             }
         }
  
         return $this->buildFromChains;
     }

◆ getDataType()

getDataType ( )

Уст.:

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

Переопределяет метод предка Field.

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

     {
         return $this->valueField->getDataType();
     }

◆ getExpression()

getExpression ( )

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

     {
         return $this->expression;
     }

◆ getFullExpression()

getFullExpression ( )

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

Исключения

SystemException

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

     {
         if (!isset($this->fullExpression))
         {
             $SQLBuildFrom = array();
  
             foreach ($this->getBuildFromChains() as $chain)
             {
                 if ($chain->getLastElement()->getValue() instanceof ExpressionField)
                 {
                     $SQLBuildFrom[] = $chain->getLastElement()->getValue()->getFullExpression();
                 }
                 else
                 {
                     $SQLBuildFrom[] = '%s';
                 }
             }
  
             $this->fullExpression = call_user_func_array('sprintf', array_merge(array($this->expression), $SQLBuildFrom));
         }
  
         return $this->fullExpression;
     }

◆ getTypeMask()

getTypeMask ( )

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

Переопределяет метод предка Field.

Переопределяется в UserTypeField.

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

     {
         return FieldTypeMask::EXPRESSION;
     }

◆ getValueField()

getValueField ( )

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

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

     {
         return $this->valueField;
     }

◆ getValueType()

getValueType ( )

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

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

     {
         return $this->valueType;
     }

◆ hasSubquery()

hasSubquery ( )

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

Исключения

SystemException

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

     {
         if (!isset($this->hasSubquery))
         {
             $this->hasSubquery = (bool) self::checkSubquery($this->getFullExpression());
         }
  
         return $this->hasSubquery;
     }

◆ isAggregated()

isAggregated ( )

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

Исключения

SystemException

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

     {
         if (!isset($this->isAggregated))
         {
             $this->isAggregated = (bool) self::checkAggregation($this->getFullExpression());
         }
  
         return $this->isAggregated;
     }

◆ isConstant()

isConstant ( )

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

     {
         return empty($this->buildFrom);
     }

◆ removeStrings()

static removeStrings	(	$quote,
		$expression
	)

staticprotected

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

     {
         // remove escaped quotes
         $expression = str_replace('\\' . $quote, '', $expression);
  
         // remove quoted strings
         $expression = preg_replace('/' . $quote . '.*?' . $quote . '/', '', $expression);
  
         return $expression;
     }

◆ removeSubqueries()

static removeSubqueries ( $expression )

static

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

     {
         // remove double slashes
         $expression = str_replace('\\\\\\\\', '', $expression);
  
         // remove strings
         $expression = static::removeStrings('"', $expression);
         $expression = static::removeStrings("'", $expression);
  
         // remove subqueries' bodies
         $clear = static::removeSubqueryBody($expression);
  
         while ($clear !== $expression)
         {
             $expression = $clear;
             $clear = static::removeSubqueryBody($expression);
         }
  
         return $clear;
     }

◆ removeSubqueryBody()

static removeSubqueryBody ( $query )

staticprotected

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

     {
         $subqPattern = '\(\s*SELECT\s+';
  
         $matches = null;
         preg_match('/' . $subqPattern . '/i', $query, $matches);
  
         if (!empty($matches))
         {
             $substring = $matches[0];
  
             $subqPosition = strpos($query, $substring);
             $subqStartPosition = $subqPosition + strlen($substring);
  
             $bracketsCount = 1;
             $currentPosition = $subqStartPosition;
  
             // until initial bracket is closed
             while ($bracketsCount > 0)
             {
                 $symbol = substr($query, $currentPosition, 1);
  
                 if ($symbol == '')
                 {
                     // end of string
                     break;
                 }
  
                 if ($symbol == '(')
                 {
                     $bracketsCount++;
                 }
                 elseif ($symbol == ')')
                 {
                     $bracketsCount--;
                 }
  
                 $currentPosition++;
             }
  
             $query = substr($query, 0, $subqPosition) . substr($query, $currentPosition);
         }
  
         return $query;
     }

◆ setEntity()

setEntity ( Entity $entity )

Аргументы

Entity $entity

Исключения

SystemException

Переопределяет метод предка Field.

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

     {
         parent::setEntity($entity);
  
         if ($this->valueType !== null)
         {
             /** @var ScalarField $valueField */
             $valueField = new $this->valueType($this->name);
             $this->valueField = $this->entity->initializeField($this->name, $valueField);
         }
         else
         {
             // deprecated - old format with parameters and data_type
             $parameters = $this->initialParameters;
  
             unset($parameters['expression']);
             $this->valueField = $this->entity->initializeField($this->name, $parameters);
             $this->valueType = get_class($this->valueField);
         }
  
         if (!($this->valueField instanceof ScalarField))
         {
             throw new SystemException('expression field can only be a scalar type.');
         }
     }

◆ validateValue()

validateValue	(		$value,
			$primary,
			$row,
		Result	$result
	)

Переопределяет метод предка Field.

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

     {
         throw new NotImplementedException;
     }

Поля

◆ $aggrFunctions

$aggrFunctions

static

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

◆ $aggrFunctionsMSSQL

$aggrFunctionsMSSQL

static

Инициализатор

= array('AVG', 'MIN', 'CHECKSUM_AGG', 'OVER', 'COUNT',
            'ROWCOUNT_BIG', 'COUNT_BIG', 'STDEV', 'GROUPING', 'STDEVP',
            'GROUPING_ID', 'SUM', 'MAX', 'VAR', 'VARP'
        )

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

◆ $aggrFunctionsMYSQL

$aggrFunctionsMYSQL

staticprotected

Инициализатор

= array('AVG', 'BIT_AND', 'BIT_OR', 'BIT_XOR', 'COUNT',
            'GROUP_CONCAT', 'MAX', 'MIN', 'STD', 'STDDEV_POP', 'STDDEV_SAMP',
            'STDDEV', 'SUM', 'VAR_POP', 'VAR_SAMP', 'VARIANCE'
        )

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

◆ $aggrFunctionsORACLE

$aggrFunctionsORACLE

static

Инициализатор

= array('AVG', 'COLLECT', 'CORR', 'CORR_S', 'CORR_K',
            'COUNT', 'COVAR_POP', 'COVAR_SAMP', 'CUME_DIST', 'DENSE_RANK', 'FIRST',
            'GROUP_ID', 'GROUPING', 'GROUPING_ID', 'LAST', 'MAX', 'MEDIAN', 'MIN',
            'PERCENTILE_CONT', 'PERCENTILE_DISC', 'PERCENT_RANK', 'RANK',
            'REGR_SLOPE', 'REGR_INTERCEPT', 'REGR_COUNT', 'REGR_R2', 'REGR_AVGX',
            'REGR_AVGY', 'REGR_SXX', 'REGR_SYY', 'REGR_SXY', 'STATS_BINOMIAL_TEST',
            'STATS_CROSSTAB', 'STATS_F_TEST', 'STATS_KS_TEST', 'STATS_MODE',
            'STATS_MW_TEST', 'STATS_ONE_WAY_ANOVA', 'STATS_T_TEST_ONE',
            'STATS_T_TEST_PAIRED', 'STATS_T_TEST_INDEP', 'STATS_T_TEST_INDEPU',
            'STATS_WSR_TEST', 'STDDEV', 'STDDEV_POP', 'STDDEV_SAMP', 'SUM',
            'VAR_POP', 'VAR_SAMP', 'VARIANCE'
        )

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

◆ $buildFrom

$buildFrom

protected

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

◆ $buildFromChains

$buildFromChains

protected

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

◆ $expression

$expression

protected

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

◆ $fullExpression

$fullExpression

protected

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

◆ $hasSubquery

$hasSubquery

protected

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

◆ $isAggregated

$isAggregated

protected

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

◆ $valueField

$valueField

protected

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

◆ $valueType

$valueType

protected

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

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

expressionfield.php

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

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

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

Защищенные статические члены

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

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

Дополнительные унаследованные члены

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

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

◆ __construct()

Методы

◆ __call()

◆ __clone()

◆ cast()

◆ checkAggregation()

◆ checkSubquery()

◆ configureValueType()

◆ convertValueFromDb()

◆ convertValueToDb()

◆ getBuildFromChains()

◆ getDataType()

◆ getExpression()

◆ getFullExpression()

◆ getTypeMask()

◆ getValueField()

◆ getValueType()

◆ hasSubquery()

◆ isAggregated()

◆ isConstant()

◆ removeStrings()

◆ removeSubqueries()

◆ removeSubqueryBody()

◆ setEntity()

◆ validateValue()

Поля

◆ $aggrFunctions

◆ $aggrFunctionsMSSQL

◆ $aggrFunctionsMYSQL

◆ $aggrFunctionsORACLE

◆ $buildFrom

◆ $buildFromChains

◆ $expression

◆ $fullExpression

◆ $hasSubquery

◆ $isAggregated

◆ $valueField

◆ $valueType