Skip to content
PHP Ecosystem
Explore

ArrayExpressionBuilder

API reference › yii › db › pgsql › ArrayExpressionBuilder

classyii\db\pgsql\ArrayExpressionBuilder
Implementsyii\db\ExpressionBuilderInterface
Uses traitsyii\db\ExpressionBuilderTrait
Since2.0.14
Sourceframework/db/pgsql/ArrayExpressionBuilder.php

Class ArrayExpressionBuilder builds ArrayExpression for PostgreSQL DBMS.

PropertyTypeDescriptionDefined by
$queryBuilder protectedyii\db\QueryBuilderDefault: null.yii\db\ExpressionBuilderTrait
MethodDescriptionDefined by
__construct()ExpressionBuilderTrait constructor.yii\db\ExpressionBuilderTrait
build()Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.ArrayExpressionBuilder
buildPlaceholders() protectedBuilds placeholders array out of $expression valuesArrayExpressionBuilder
buildSubqueryArray() protectedBuild an array expression from a subquery SQL.ArrayExpressionBuilder
getTypehint() protectedArrayExpressionBuilder
typecastValue() protectedCasts $value to use in $expressionArrayExpressionBuilder
public function build(yii\db\ArrayExpression|yii\db\ExpressionInterface $expression, array &$params = []): string

Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.

Parameters

ParameterTypeDescription
$expressionyii\db\ArrayExpression|yii\db\ExpressionInterfaceThe expression to be built
$paramsarrayThe binding parameters.

Returns

string: The raw SQL that will not be additionally escaped or quoted.

protected function buildPlaceholders(yii\db\ExpressionInterface|yii\db\ArrayExpression $expression, array &$params): array

Builds placeholders array out of $expression values

Parameters

ParameterTypeDescription
$expressionyii\db\ExpressionInterface|yii\db\ArrayExpression
$paramsarrayThe binding parameters.

Returns

array

protected function buildSubqueryArray(string $sql, yii\db\ArrayExpression $expression): string

Build an array expression from a subquery SQL.

Parameters

ParameterTypeDescription
$sqlstringThe subquery SQL.
$expressionyii\db\ArrayExpression

Returns

string: The subquery array expression.

protected function getTypehint(yii\db\ArrayExpression $expression): string

Parameters

ParameterTypeDescription
$expressionyii\db\ArrayExpression

Returns

string: The typecast expression based on type.

protected function typecastValue(yii\db\ArrayExpression $expression, mixed $value): mixed

Casts $value to use in $expression

Parameters

ParameterTypeDescription
$expressionyii\db\ArrayExpression
$valuemixed

Returns

mixed