Query.php 28 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\sphinx;

use Yii;
use yii\base\Component;
12
use yii\base\InvalidCallException;
13
use yii\db\Expression;
14
use yii\db\QueryInterface;
Paul Klimov committed
15
use yii\db\QueryTrait;
16 17

/**
18
 * Query represents a SELECT SQL statement.
19
 *
20 21
 * Query provides a set of methods to facilitate the specification of different clauses
 * in a SELECT statement. These methods can be chained together.
Paul Klimov committed
22
 *
23 24 25 26 27 28 29
 * By calling [[createCommand()]], we can get a [[Command]] instance which can be further
 * used to perform/execute the Sphinx query.
 *
 * For example,
 *
 * ~~~
 * $query = new Query;
30
 * $query->select('id, group_id')
31 32 33 34 35 36 37 38 39 40 41 42
 *     ->from('idx_item')
 *     ->limit(10);
 * // build and execute the query
 * $command = $query->createCommand();
 * // $command->sql returns the actual SQL
 * $rows = $command->queryAll();
 * ~~~
 *
 * Since Sphinx does not store the original indexed text, the snippets for the rows in query result
 * should be build separately via another query. You can simplify this workflow using [[snippetCallback]].
 *
 * Warning: even if you do not set any query limit, implicit LIMIT 0,20 is present by default!
Paul Klimov committed
43
 *
Carsten Brandt committed
44
 * @property Connection $connection Sphinx connection instance.
45
 *
46 47 48
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
49
class Query extends Component implements QueryInterface
50
{
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
    use QueryTrait;

    /**
     * @var array the columns being selected. For example, `['id', 'group_id']`.
     * This is used to construct the SELECT clause in a SQL statement. If not set, if means selecting all columns.
     * @see select()
     */
    public $select;
    /**
     * @var string additional option that should be appended to the 'SELECT' keyword.
     */
    public $selectOption;
    /**
     * @var boolean whether to select distinct rows of data only. If this is set true,
     * the SELECT clause would be changed to SELECT DISTINCT.
     */
    public $distinct;
    /**
     * @var array the index(es) to be selected from. For example, `['idx_user', 'idx_user_delta']`.
     * This is used to construct the FROM clause in a SQL statement.
     * @see from()
     */
    public $from;
    /**
75
     * @var string|Expression text, which should be searched in fulltext mode.
76
     * This value will be composed into MATCH operator inside the WHERE clause.
77
     * Note: this value will be processed by [[Connection::escapeMatchValue()]],
78 79
     * if you need to compose complex match condition use [[Expression]],
     * see [[match()]] for details.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
     */
    public $match;
    /**
     * @var array how to group the query results. For example, `['company', 'department']`.
     * This is used to construct the GROUP BY clause in a SQL statement.
     */
    public $groupBy;
    /**
     * @var string WITHIN GROUP ORDER BY clause. This is a Sphinx specific extension
     * that lets you control how the best row within a group will to be selected.
     * The possible value matches the [[orderBy]] one.
     */
    public $within;
    /**
     * @var array per-query options in format: optionName => optionValue
     * They will compose OPTION clause. This is a Sphinx specific extension
     * that lets you control a number of per-query options.
     */
    public $options;
    /**
     * @var array list of query parameter values indexed by parameter placeholders.
     * For example, `[':name' => 'Dan', ':age' => 31]`.
     */
    public $params = [];
    /**
     * @var callable PHP callback, which should be used to fetch source data for the snippets.
     * Such callback will receive array of query result rows as an argument and must return the
     * array of snippet source strings in the order, which match one of incoming rows.
     * For example:
     * ~~~
     * $query = new Query;
     * $query->from('idx_item')
     *     ->match('pencil')
     *     ->snippetCallback(function ($rows) {
     *         $result = [];
     *         foreach ($rows as $row) {
     *             $result[] = file_get_contents('/path/to/index/files/' . $row['id'] . '.txt');
     *         }
     *         return $result;
     *     })
     *     ->all();
     * ~~~
     */
    public $snippetCallback;
    /**
     * @var array query options for the call snippet.
     */
    public $snippetOptions;
128

129 130 131 132 133
    /**
     * @var Connection the Sphinx connection used to generate the SQL statements.
     */
    private $_connection;

134

135
    /**
136 137
     * @param Connection $connection Sphinx connection instance
     * @return static the query object itself
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
     */
    public function setConnection($connection)
    {
        $this->_connection = $connection;

        return $this;
    }

    /**
     * @return Connection Sphinx connection instance
     */
    public function getConnection()
    {
        if ($this->_connection === null) {
            $this->_connection = $this->defaultConnection();
        }

        return $this->_connection;
    }

    /**
     * @return Connection default connection value.
     */
    protected function defaultConnection()
    {
163
        return Yii::$app->get('sphinx');
164 165 166 167
    }

    /**
     * Creates a Sphinx command that can be used to execute this query.
168 169 170
     * @param Connection $connection the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return Command the created Sphinx command instance.
171 172 173 174 175 176 177 178 179 180 181 182
     */
    public function createCommand($connection = null)
    {
        $this->setConnection($connection);
        $connection = $this->getConnection();
        list ($sql, $params) = $connection->getQueryBuilder()->build($this);

        return $connection->createCommand($sql, $params);
    }

    /**
     * Executes the query and returns all results as an array.
183 184 185
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return array the query results. If the query results in nothing, an empty array will be returned.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
     */
    public function all($db = null)
    {
        $rows = $this->createCommand($db)->queryAll();
        $rows = $this->fillUpSnippets($rows);
        if ($this->indexBy === null) {
            return $rows;
        }
        $result = [];
        foreach ($rows as $row) {
            if (is_string($this->indexBy)) {
                $key = $row[$this->indexBy];
            } else {
                $key = call_user_func($this->indexBy, $row);
            }
            $result[$key] = $row;
        }

        return $result;
    }

    /**
     * Executes the query and returns a single row of result.
209 210
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
211
     * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
212
     * results in nothing.
213 214 215 216 217 218 219 220 221 222 223 224 225 226
     */
    public function one($db = null)
    {
        $row = $this->createCommand($db)->queryOne();
        if ($row !== false) {
            list ($row) = $this->fillUpSnippets([$row]);
        }

        return $row;
    }

    /**
     * Returns the query result as a scalar value.
     * The value returned will be the first column in the first row of the query results.
227 228
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
229
     * @return string|boolean the value of the first column in the first row of the query result.
230
     * False is returned if the query result is empty.
231 232 233 234 235 236 237 238
     */
    public function scalar($db = null)
    {
        return $this->createCommand($db)->queryScalar();
    }

    /**
     * Executes the query and returns the first column of the result.
239 240 241
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return array the first column of the query result. An empty array is returned if the query results in nothing.
242 243 244 245 246 247 248 249
     */
    public function column($db = null)
    {
        return $this->createCommand($db)->queryColumn();
    }

    /**
     * Returns the number of records.
250 251 252 253 254
     * @param string $q the COUNT expression. Defaults to '*'.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return integer number of records
255 256 257 258 259 260 261 262 263 264
     */
    public function count($q = '*', $db = null)
    {
        $this->select = ["COUNT($q)"];

        return $this->createCommand($db)->queryScalar();
    }

    /**
     * Returns the sum of the specified column values.
265 266 267 268 269
     * @param string $q the column name or expression.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return integer the sum of the specified column values
270 271 272 273 274 275 276 277 278 279
     */
    public function sum($q, $db = null)
    {
        $this->select = ["SUM($q)"];

        return $this->createCommand($db)->queryScalar();
    }

    /**
     * Returns the average of the specified column values.
280 281 282 283 284
     * @param string $q the column name or expression.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return integer the average of the specified column values.
285 286 287 288 289 290 291 292 293 294
     */
    public function average($q, $db = null)
    {
        $this->select = ["AVG($q)"];

        return $this->createCommand($db)->queryScalar();
    }

    /**
     * Returns the minimum of the specified column values.
295 296 297 298 299
     * @param string $q the column name or expression.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return integer the minimum of the specified column values.
300 301 302 303 304 305 306 307 308 309
     */
    public function min($q, $db = null)
    {
        $this->select = ["MIN($q)"];

        return $this->createCommand($db)->queryScalar();
    }

    /**
     * Returns the maximum of the specified column values.
310 311 312 313 314
     * @param string $q the column name or expression.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return integer the maximum of the specified column values.
315 316 317 318 319 320 321 322 323 324
     */
    public function max($q, $db = null)
    {
        $this->select = ["MAX($q)"];

        return $this->createCommand($db)->queryScalar();
    }

    /**
     * Returns a value indicating whether the query result contains any row of data.
325 326 327
     * @param Connection $db the Sphinx connection used to generate the SQL statement.
     * If this parameter is not given, the `sphinx` application component will be used.
     * @return boolean whether the query result contains any row of data.
328 329 330 331 332 333 334 335 336 337
     */
    public function exists($db = null)
    {
        $this->select = [new Expression('1')];

        return $this->scalar($db) !== false;
    }

    /**
     * Sets the SELECT part of the query.
338 339 340 341 342 343
     * @param string|array $columns the columns to be selected.
     * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
     * The method will automatically quote the column names unless a column contains some parenthesis
     * (which means the column contains a Sphinx expression).
     * @param string $option additional option that should be appended to the 'SELECT' keyword.
     * @return static the query object itself
344 345 346 347 348 349 350 351 352 353 354 355 356 357
     */
    public function select($columns, $option = null)
    {
        if (!is_array($columns)) {
            $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        $this->select = $columns;
        $this->selectOption = $option;

        return $this;
    }

    /**
     * Sets the value indicating whether to SELECT DISTINCT or not.
358 359
     * @param boolean $value whether to SELECT DISTINCT or not.
     * @return static the query object itself
360 361 362 363 364 365 366 367 368 369
     */
    public function distinct($value = true)
    {
        $this->distinct = $value;

        return $this;
    }

    /**
     * Sets the FROM part of the query.
370 371 372 373 374
     * @param string|array $tables the table(s) to be selected from. This can be either a string (e.g. `'idx_user'`)
     * or an array (e.g. `['idx_user', 'idx_user_delta']`) specifying one or several index names.
     * The method will automatically quote the table names unless it contains some parenthesis
     * (which means the table is given as a sub-query or Sphinx expression).
     * @return static the query object itself
375 376 377 378 379 380 381 382 383 384 385 386 387 388
     */
    public function from($tables)
    {
        if (!is_array($tables)) {
            $tables = preg_split('/\s*,\s*/', trim($tables), -1, PREG_SPLIT_NO_EMPTY);
        }
        $this->from = $tables;

        return $this;
    }

    /**
     * Sets the fulltext query text. This text will be composed into
     * MATCH operator inside the WHERE clause.
389
     * Note: this value will be processed by [[Connection::escapeMatchValue()]],
390
     * if you need to compose complex match condition use [[Expression]]:
391
     * ~~~
392 393 394 395
     * $query = new Query;
     * $query->from('my_index')
     *     ->match(new Expression(':match', ['match' => '@(content) ' . Yii::$app->sphinx->escapeMatchValue($matchValue)]))
     *     ->all();
396
     * ~~~
397
     *
398
     * @param string $query fulltext query text.
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
     * @return static the query object itself
     */
    public function match($query)
    {
        $this->match = $query;
        return $this;
    }

    /**
     * Sets the WHERE part of the query.
     *
     * The method requires a $condition parameter, and optionally a $params parameter
     * specifying the values to be bound to the query.
     *
     * The $condition parameter should be either a string (e.g. 'id=1') or an array.
     * If the latter, it must be in one of the following two formats:
     *
     * - hash format: `['column1' => value1, 'column2' => value2, ...]`
     * - operator format: `[operator, operand1, operand2, ...]`
     *
     * A condition in hash format represents the following SQL expression in general:
420
     * `column1=value1 AND column2=value2 AND ...`. In case when a value is an array or a Query object,
421 422 423 424 425 426
     * an `IN` expression will be generated. And if a value is null, `IS NULL` will be used
     * in the generated expression. Below are some examples:
     *
     * - `['type' => 1, 'status' => 2]` generates `(type = 1) AND (status = 2)`.
     * - `['id' => [1, 2, 3], 'status' => 2]` generates `(id IN (1, 2, 3)) AND (status = 2)`.
     * - `['status' => null] generates `status IS NULL`.
427
     * - `['id' => $query]` generates `id IN (...sub-query...)`
428 429 430 431 432
     *
     * A condition in operator format generates the SQL expression according to the specified operator, which
     * can be one of the followings:
     *
     * - `and`: the operands should be concatenated together using `AND`. For example,
433 434 435 436
     *   `['and', 'id=1', 'id=2']` will generate `id=1 AND id=2`. If an operand is an array,
     *   it will be converted into a string using the rules described here. For example,
     *   `['and', 'type=1', ['or', 'id=1', 'id=2']]` will generate `type=1 AND (id=1 OR id=2)`.
     *   The method will NOT do any quoting or escaping.
437 438 439 440
     *
     * - `or`: similar to the `and` operator except that the operands are concatenated using `OR`.
     *
     * - `between`: operand 1 should be the column name, and operand 2 and 3 should be the
441 442
     *   starting and ending values of the range that the column is in.
     *   For example, `['between', 'id', 1, 10]` will generate `id BETWEEN 1 AND 10`.
443 444
     *
     * - `not between`: similar to `between` except the `BETWEEN` is replaced with `NOT BETWEEN`
445
     *   in the generated condition.
446
     *
447
     * - `in`: operand 1 should be a column or DB expression with parenthesis. Operand 2 can be an array
448 449 450 451 452 453 454
     *   or a Query object. If the former, the array represents the range of the values that the column
     *   or DB expression should be in. If the latter, a sub-query will be generated to represent the range.
     *   For example, `['in', 'id', [1, 2, 3]]` will generate `id IN (1, 2, 3)`;
     *   `['in', 'id', (new Query)->select('id')->from('user'))]` will generate
     *   `id IN (SELECT id FROM user)`. The method will properly quote the column name and escape values in the range.
     *   The `in` operator also supports composite columns. In this case, operand 1 should be an array of the columns,
     *   while operand 2 should be an array of arrays or a `Query` object representing the range of the columns.
455 456 457 458
     *
     * - `not in`: similar to the `in` operator except that `IN` is replaced with `NOT IN` in the generated condition.
     *
     * - `like`: operand 1 should be a column or DB expression, and operand 2 be a string or an array representing
459 460 461 462 463 464 465 466
     *   the values that the column or DB expression should be like.
     *   For example, `['like', 'name', '%tester%']` will generate `name LIKE '%tester%'`.
     *   When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated
     *   using `AND`. For example, `['like', 'name', ['%test%', '%sample%']]` will generate
     *   `name LIKE '%test%' AND name LIKE '%sample%'`.
     *   The method will properly quote the column name and escape values in the range.
     *   Sometimes, you may want to add the percentage characters to the matching value by yourself, you may supply
     *   a third operand `false` to do so. For example, `['like', 'name', '%tester', false]` will generate `name LIKE '%tester'`.
467 468
     *
     * - `or like`: similar to the `like` operator except that `OR` is used to concatenate the `LIKE`
469
     *   predicates when operand 2 is an array.
470 471
     *
     * - `not like`: similar to the `like` operator except that `LIKE` is replaced with `NOT LIKE`
472
     *   in the generated condition.
473 474
     *
     * - `or not like`: similar to the `not like` operator except that `OR` is used to concatenate
475
     *   the `NOT LIKE` predicates.
476
     *
477 478 479
     * @param string|array $condition the conditions that should be put in the WHERE part.
     * @param array $params the parameters (name => value) to be bound to the query.
     * @return static the query object itself
480 481 482 483 484 485 486 487 488 489 490 491 492
     * @see andWhere()
     * @see orWhere()
     */
    public function where($condition, $params = [])
    {
        $this->where = $condition;
        $this->addParams($params);
        return $this;
    }

    /**
     * Adds an additional WHERE condition to the existing one.
     * The new condition and the existing one will be joined using the 'AND' operator.
493 494 495 496
     * @param string|array $condition the new WHERE condition. Please refer to [[where()]]
     * on how to specify this parameter.
     * @param array $params the parameters (name => value) to be bound to the query.
     * @return static the query object itself
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
     * @see where()
     * @see orWhere()
     */
    public function andWhere($condition, $params = [])
    {
        if ($this->where === null) {
            $this->where = $condition;
        } else {
            $this->where = ['and', $this->where, $condition];
        }
        $this->addParams($params);
        return $this;
    }

    /**
     * Adds an additional WHERE condition to the existing one.
     * The new condition and the existing one will be joined using the 'OR' operator.
514 515 516 517
     * @param string|array $condition the new WHERE condition. Please refer to [[where()]]
     * on how to specify this parameter.
     * @param array $params the parameters (name => value) to be bound to the query.
     * @return static the query object itself
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
     * @see where()
     * @see andWhere()
     */
    public function orWhere($condition, $params = [])
    {
        if ($this->where === null) {
            $this->where = $condition;
        } else {
            $this->where = ['or', $this->where, $condition];
        }
        $this->addParams($params);
        return $this;
    }

    /**
     * Sets the GROUP BY part of the query.
534 535 536 537 538
     * @param string|array $columns the columns to be grouped by.
     * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
     * The method will automatically quote the column names unless a column contains some parenthesis
     * (which means the column contains a DB expression).
     * @return static the query object itself
539 540 541 542 543 544 545 546 547 548 549 550 551 552
     * @see addGroupBy()
     */
    public function groupBy($columns)
    {
        if (!is_array($columns)) {
            $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        $this->groupBy = $columns;

        return $this;
    }

    /**
     * Adds additional group-by columns to the existing ones.
553 554 555 556 557
     * @param string|array $columns additional columns to be grouped by.
     * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
     * The method will automatically quote the column names unless a column contains some parenthesis
     * (which means the column contains a DB expression).
     * @return static the query object itself
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
     * @see groupBy()
     */
    public function addGroupBy($columns)
    {
        if (!is_array($columns)) {
            $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        if ($this->groupBy === null) {
            $this->groupBy = $columns;
        } else {
            $this->groupBy = array_merge($this->groupBy, $columns);
        }

        return $this;
    }

    /**
     * Sets the parameters to be bound to the query.
576 577
     * @param array $params list of query parameter values indexed by parameter placeholders.
     * For example, `[':name' => 'Dan', ':age' => 31]`.
578 579 580 581 582 583 584 585 586 587 588 589
     * @return static the query object itself
     * @see addParams()
     */
    public function params($params)
    {
        $this->params = $params;

        return $this;
    }

    /**
     * Adds additional parameters to be bound to the query.
590 591
     * @param array $params list of query parameter values indexed by parameter placeholders.
     * For example, `[':name' => 'Dan', ':age' => 31]`.
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
     * @return static the query object itself
     * @see params()
     */
    public function addParams($params)
    {
        if (!empty($params)) {
            if (empty($this->params)) {
                $this->params = $params;
            } else {
                foreach ($params as $name => $value) {
                    if (is_integer($name)) {
                        $this->params[] = $value;
                    } else {
                        $this->params[$name] = $value;
                    }
                }
            }
        }

        return $this;
    }

    /**
     * Sets the query options.
616
     * @param array $options query options in format: optionName => optionValue
617 618 619 620 621 622 623 624 625 626 627 628
     * @return static the query object itself
     * @see addOptions()
     */
    public function options($options)
    {
        $this->options = $options;

        return $this;
    }

    /**
     * Adds additional query options.
629
     * @param array $options query options in format: optionName => optionValue
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
     * @return static the query object itself
     * @see options()
     */
    public function addOptions($options)
    {
        if (is_array($this->options)) {
            $this->options = array_merge($this->options, $options);
        } else {
            $this->options = $options;
        }

        return $this;
    }

    /**
     * Sets the WITHIN GROUP ORDER BY part of the query.
646 647 648 649 650 651
     * @param string|array $columns the columns (and the directions) to find best row within a group.
     * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
     * (e.g. `['id' => Query::SORT_ASC, 'name' => Query::SORT_DESC]`).
     * The method will automatically quote the column names unless a column contains some parenthesis
     * (which means the column contains a DB expression).
     * @return static the query object itself
652 653 654 655 656 657 658 659 660 661 662
     * @see addWithin()
     */
    public function within($columns)
    {
        $this->within = $this->normalizeOrderBy($columns);

        return $this;
    }

    /**
     * Adds additional WITHIN GROUP ORDER BY columns to the query.
663 664 665 666 667 668
     * @param string|array $columns the columns (and the directions) to find best row within a group.
     * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
     * (e.g. `['id' => Query::SORT_ASC, 'name' => Query::SORT_DESC]`).
     * The method will automatically quote the column names unless a column contains some parenthesis
     * (which means the column contains a DB expression).
     * @return static the query object itself
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
     * @see within()
     */
    public function addWithin($columns)
    {
        $columns = $this->normalizeOrderBy($columns);
        if ($this->within === null) {
            $this->within = $columns;
        } else {
            $this->within = array_merge($this->within, $columns);
        }

        return $this;
    }

    /**
     * Sets the PHP callback, which should be used to retrieve the source data
     * for the snippets building.
686 687
     * @param callable $callback PHP callback, which should be used to fetch source data for the snippets.
     * @return static the query object itself
688 689 690 691 692 693 694 695 696 697 698
     * @see snippetCallback
     */
    public function snippetCallback($callback)
    {
        $this->snippetCallback = $callback;

        return $this;
    }

    /**
     * Sets the call snippets query options.
699
     * @param array $options call snippet options in format: option_name => option_value
700 701 702 703 704 705 706 707 708 709 710 711 712
     * @return static the query object itself
     * @see snippetCallback
     */
    public function snippetOptions($options)
    {
        $this->snippetOptions = $options;

        return $this;
    }

    /**
     * Fills the query result rows with the snippets built from source determined by
     * [[snippetCallback]] result.
713
     * @param array $rows raw query result rows.
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
     * @return array|ActiveRecord[] query result rows with filled up snippets.
     */
    protected function fillUpSnippets($rows)
    {
        if ($this->snippetCallback === null) {
            return $rows;
        }
        $snippetSources = call_user_func($this->snippetCallback, $rows);
        $snippets = $this->callSnippets($snippetSources);
        $snippetKey = 0;
        foreach ($rows as $key => $row) {
            $rows[$key]['snippet'] = $snippets[$snippetKey];
            $snippetKey++;
        }

        return $rows;
    }

    /**
     * Builds a snippets from provided source data.
734
     * @param array $source the source data to extract a snippet from.
735
     * @throws InvalidCallException in case [[match]] is not specified.
736
     * @return array snippets list.
737 738 739 740 741 742 743 744
     */
    protected function callSnippets(array $source)
    {
        return $this->callSnippetsInternal($source, $this->from[0]);
    }

    /**
     * Builds a snippets from provided source data by the given index.
745 746 747
     * @param array $source the source data to extract a snippet from.
     * @param string $from name of the source index.
     * @return array snippets list.
748 749 750 751 752 753 754 755 756 757 758 759 760 761
     * @throws InvalidCallException in case [[match]] is not specified.
     */
    protected function callSnippetsInternal(array $source, $from)
    {
        $connection = $this->getConnection();
        $match = $this->match;
        if ($match === null) {
            throw new InvalidCallException('Unable to call snippets: "' . $this->className() . '::match" should be specified.');
        }

        return $connection->createCommand()
            ->callSnippets($from, $source, $match, $this->snippetOptions)
            ->queryColumn();
    }
762
}