Class yii\db\mysql\JsonExpressionBuilder
| Inheritance | yii\db\mysql\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/mysql/JsonExpressionBuilder.php |
Class JsonExpressionBuilder builds yii\db\JsonExpression for MySQL DBMS.
Public 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\mysql\JsonExpressionBuilder |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| PARAM_PREFIX | ':qp' | yii\db\mysql\JsonExpressionBuilder |
Method Details
Defined in: yii\db\ExpressionBuilderTrait::__construct()
ExpressionBuilderTrait constructor.
| public void __construct ( yii\db\QueryBuilder $queryBuilder ) | ||
| $queryBuilder | yii\db\QueryBuilder | |
public function __construct(QueryBuilder $queryBuilder)
{
$this->queryBuilder = $queryBuilder;
}
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. |
|---|---|---|
public function build(ExpressionInterface $expression, array &$params = [])
{
$value = $expression->getValue();
if ($value instanceof Query) {
list ($sql, $params) = $this->queryBuilder->build($value, $params);
return "($sql)";
}
$placeholder = static::PARAM_PREFIX . count($params);
$params[$placeholder] = Json::encode($value);
return "CAST($placeholder AS JSON)";
}