Class yii\db\pgsql\JsonExpressionBuilder

All Classes | Properties | Methods

Inheritance	yii\db\pgsql\JsonExpressionBuilder
Implements	yii\db\ExpressionBuilderInterface
Uses Traits	yii\db\ExpressionBuilderTrait
Available since version	2.0.14
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/db/pgsql/JsonExpressionBuilder.php

Class JsonExpressionBuilder builds yii\db\JsonExpression for PostgreSQL DBMS.

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$queryBuilder	yii\db\QueryBuilder		yii\db\ExpressionBuilderTrait

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()	ExpressionBuilderTrait constructor.	yii\db\ExpressionBuilderTrait
build()	Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.	yii\db\pgsql\JsonExpressionBuilder

Protected Methods

Hide inherited methods

Method	Description	Defined By
getTypecast()		yii\db\pgsql\JsonExpressionBuilder

Method Details

Hide inherited methods

__construct() public method

Defined in: yii\db\ExpressionBuilderTrait::__construct()

ExpressionBuilderTrait constructor.

public void __construct ( yii\db\QueryBuilder $queryBuilder )
$queryBuilder	yii\db\QueryBuilder

Source code

                public function __construct(QueryBuilder $queryBuilder)
{
    $this->queryBuilder = $queryBuilder;
}

build() public method

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

public string build ( yii\db\ExpressionInterface $expression, array &$params = [] )
$expression	yii\db\JsonExpression\|yii\db\ExpressionInterface	The expression to be built
$params	array	The binding parameters.
return	string	The raw SQL that will not be additionally escaped or quoted.

Source code

                public function build(ExpressionInterface $expression, array &$params = [])
{
    $value = $expression->getValue();
    if ($value instanceof Query) {
        list ($sql, $params) = $this->queryBuilder->build($value, $params);
        return "($sql)" . $this->getTypecast($expression);
    }
    if ($value instanceof ArrayExpression) {
        $placeholder = 'array_to_json(' . $this->queryBuilder->buildExpression($value, $params) . ')';
    } else {
        $placeholder = $this->queryBuilder->bindParam(Json::encode($value), $params);
    }
    return $placeholder . $this->getTypecast($expression);
}

getTypecast() protected method

protected string getTypecast ( yii\db\JsonExpression $expression )
$expression	yii\db\JsonExpression
return	string	The typecast expression based on type.

Source code

                protected function getTypecast(JsonExpression $expression)
{
    if ($expression->getType() === null) {
        return '';
    }
    return '::' . $expression->getType();
}