Class Phalcon\Mvc\Model\Query\Builder

implements Phalcon\Mvc\Model\Query\BuilderInterface, Phalcon\DI\InjectionAwareInterface

Helps to create PHQL queries using an OO interface

$resultset = $this->modelsManager->createBuilder()
   ->from('Robots')
   ->join('RobotsParts')
   ->limit(20)
   ->orderBy('Robots.name')
   ->getQuery()
   ->execute();

Methods

public __construct ([array $params])

Phalcon\Mvc\Model\Query\Builder constructor

$params = array(
    'models'     => array('Users'),
    'columns'    => array('id', 'name', 'status'),
    'conditions' => array(
        array(
            "created > :min: AND created < :max:",
            array("min" => '2013-01-01',   'max' => '2014-01-01'),
            array("min" => PDO::PARAM_STR, 'max' => PDO::PARAM_STR),
        ),
    ),
    // or 'conditions' => "created > '2013-01-01' AND created < '2014-01-01'",
    'group'      => array('id', 'name'),
    'having'     => "name = 'Kamil'",
    'order'      => array('name', 'id'),
    'limit'      => 20,
    'offset'     => 20,
    // or 'limit' => array(20, 20),
);
$queryBuilder = new Phalcon\Mvc\Model\Query\Builder($params);

public Phalcon\Mvc\Model\Query\BuilderInterface distinct (unknown $distinct)

Sets SELECT DISTINCT / SELECT ALL flag

public bool getDistinct ()

Returns SELECT DISTINCT / SELECT ALL flag

public Phalcon\Mvc\Model\Query\Builder setDI (Phalcon\DiInterface $dependencyInjector)

Sets the DependencyInjector container

public Phalcon\DiInterface getDI ()

Returns the DependencyInjector container

public Phalcon\Mvc\Model\Query\Builder columns (string|array $columns)

Sets the columns to be queried

$builder->columns(array('id', 'name'));

public string|array getColumns ()

Return the columns to be queried

public Phalcon\Mvc\Model\Query\Builder from (string|array $models)

Sets the models who makes part of the query

$builder->from('Robots');
$builder->from(array('Robots', 'RobotsParts'));

public Phalcon\Mvc\Model\Query\Builder addFrom (string $model, [string $alias])

Add a model to take part of the query

$builder->addFrom('Robots', 'r');

public string|array getFrom ()

Return the models who makes part of the query

public Phalcon\Mvc\Model\Query\Builder join (string $model, [string $conditions], [string $alias])

Adds a join to the query

$builder->join('Robots');
$builder->join('Robots', 'r.id = RobotsParts.robots_id');
$builder->join('Robots', 'r.id = RobotsParts.robots_id', 'r');
$builder->join('Robots', 'r.id = RobotsParts.robots_id', 'r', 'LEFT');

public Phalcon\Mvc\Model\Query\Builder innerJoin (string $model, [string $conditions], [string $alias])

Adds a INNER join to the query

$builder->innerJoin('Robots');
$builder->innerJoin('Robots', 'r.id = RobotsParts.robots_id');
$builder->innerJoin('Robots', 'r.id = RobotsParts.robots_id', 'r');

public Phalcon\Mvc\Model\Query\Builder leftJoin (string $model, [string $conditions], [string $alias])

Adds a LEFT join to the query

$builder->leftJoin('Robots', 'r.id = RobotsParts.robots_id', 'r');

public Phalcon\Mvc\Model\Query\Builder rightJoin (string $model, [string $conditions], [string $alias])

Adds a RIGHT join to the query

$builder->rightJoin('Robots', 'r.id = RobotsParts.robots_id', 'r');

public Phalcon\Mvc\Model\Query\Builder where (string $conditions, [array $bindParams], [array $bindTypes])

Sets the query conditions

$builder->where('name = "Peter"');
$builder->where('name = :name: AND id > :id:', array('name' => 'Peter', 'id' => 100));

public Phalcon\Mvc\Model\Query\Builder andWhere (string $conditions, [array $bindParams], [array $bindTypes])

Appends a condition to the current conditions using a AND operator

$builder->andWhere('name = "Peter"');
$builder->andWhere('name = :name: AND id > :id:', array('name' => 'Peter', 'id' => 100));

public Phalcon\Mvc\Model\Query\Builder orWhere (string $conditions, [array $bindParams], [array $bindTypes])

Appends a condition to the current conditions using a OR operator

$builder->orWhere('name = "Peter"');
$builder->orWhere('name = :name: AND id > :id:', array('name' => 'Peter', 'id' => 100));

public Phalcon\Mvc\Model\Query\Builder betweenWhere (string $expr, mixed $minimum, mixed $maximum)

Appends a BETWEEN condition to the current conditions

$builder->betweenWhere('price', 100.25, 200.50);

public Phalcon\Mvc\Model\Query\Builder notBetweenWhere (string $expr, mixed $minimum, mixed $maximum)

Appends a NOT BETWEEN condition to the current conditions

$builder->notBetweenWhere('price', 100.25, 200.50);

public Phalcon\Mvc\Model\Query\Builder inWhere (string $expr, array $values)

Appends an IN condition to the current conditions

$builder->inWhere('id', [1, 2, 3]);

public Phalcon\Mvc\Model\Query\Builder notInWhere (string $expr, array $values)

Appends a NOT IN condition to the current conditions

$builder->notInWhere('id', [1, 2, 3]);

public string|array getWhere ()

Return the conditions for the query

public Phalcon\Mvc\Model\Query\Builder orderBy (string $orderBy)

Sets a ORDER BY condition clause

$builder->orderBy('Robots.name');
$builder->orderBy(array('1', 'Robots.name'));

public string|array getOrderBy ()

Returns the set ORDER BY clause

public Phalcon\Mvc\Model\Query\Builder having (string $having)

Sets a HAVING condition clause. You need to escape PHQL reserved words using [ and ] delimiters

$builder->having('SUM(Robots.price) > 0');

public string|array getHaving ()

Return the current having clause

public Phalcon\Mvc\Model\Query\Builder limit (int $limit, [int $offset])

Sets a LIMIT clause, optionally a offset clause

$builder->limit(100);
$builder->limit(100, 20);

public string|array getLimit ()

Returns the current LIMIT clause

public Phalcon\Mvc\Model\Query\Builder offset (int $offset)

Sets an OFFSET clause

$builder->offset(30);

public string|array getOffset ()

Returns the current OFFSET clause

public Phalcon\Mvc\Model\Query\Builder groupBy (string $group)

Sets a GROUP BY clause

$builder->groupBy(array('Robots.name'));

public string getGroupBy ()

Returns the GROUP BY clause

public string getPhql ()

Returns a PHQL statement built based on the builder parameters

public Phalcon\Mvc\Model\Query getQuery ()

Returns the query built