Phalcon Query Language (PHQL)

Phalcon Query Language, PhalconQL or simply PHQL is a high-level, object-oriented SQL dialect that allows to write queries using a standardized SQL-like language. PHQL is implemented as a parser (written in C) that translates syntax in that of the target RDBMS.

To achieve the highest performance possible, Phalcon provides a parser that uses the same technology as SQLite. This technology provides a small in-memory parser with a very low memory footprint that is also thread-safe.

The parser first checks the syntax of the pass PHQL statement, then builds an intermediate representation of the statement and finally it converts it to the respective SQL dialect of the target RDBMS.

In PHQL, we’ve implemented a set of features to make your access to databases more secure:

  • Bound parameters are part of the PHQL language helping you to secure your code
  • PHQL only allows one SQL statement to be executed per call preventing injections
  • PHQL ignores all SQL comments which are often used in SQL injections
  • PHQL only allows data manipulation statements, avoiding altering or dropping tables/databases by mistake or externally without authorization
  • PHQL implements a high-level abstraction allowing you to handle tables as models and fields as class attributes

Usage Example

To better explain how PHQL works consider the following example. We have two models Cars and Brands:

  1. <?php
  3. use Phalcon\Mvc\Model;
  5. class Cars extends Model
  6. {
  7.     public $id;
  9.     public $name;
  11.     public $brand_id;
  13.     public $price;
  15.     public $year;
  17.     public $style;
  19.     /**
  20.      * This model is mapped to the table sample_cars
  21.      */
  22.     public function getSource()
  23.     {
  24.         return 'sample_cars';
  25.     }
  27.     /**
  28.      * A car only has a Brand, but a Brand have many Cars
  29.      */
  30.     public function initialize()
  31.     {
  32.         $this->belongsTo('brand_id', 'Brands', 'id');
  33.     }
  34. }

And every Car has a Brand, so a Brand has many Cars:

  1. <?php
  3. use Phalcon\Mvc\Model;
  5. class Brands extends Model
  6. {
  7.     public $id;
  9.     public $name;
  11.     /**
  12.      * The model Brands is mapped to the 'sample_brands' table
  13.      */
  14.     public function getSource()
  15.     {
  16.         return 'sample_brands';
  17.     }
  19.     /**
  20.      * A Brand can have many Cars
  21.      */
  22.     public function initialize()
  23.     {
  24.         $this->hasMany('id', 'Cars', 'brand_id');
  25.     }
  26. }

Creating PHQL Queries

PHQL queries can be created just by instantiating the class Phalcon\Mvc\Model\Query:

  1. <?php
  3. use Phalcon\Mvc\Model\Query;
  5. // Instantiate the Query
  6. $query = new Query(
  7.     'SELECT * FROM Cars',
  8.     $this->getDI()
  9. );
  11. // Execute the query returning a result if any
  12. $cars = $query->execute();

From a controller or a view, it’s easy to create/execute them using an injected models manager (Phalcon\Mvc\Model\Manager):

  1. <?php
  3. // Executing a simple query
  4. $query = $this->modelsManager->createQuery('SELECT * FROM Cars');
  5. $cars  = $query->execute();
  7. // With bound parameters
  8. $query = $this->modelsManager->createQuery('SELECT * FROM Cars WHERE name = :name:');
  9. $cars  = $query->execute(
  10.     [
  11.         'name' => 'Audi',
  12.     ]
  13. );

Or simply execute it:

  1. <?php
  3. // Executing a simple query
  4. $cars = $this->modelsManager->executeQuery(
  5.     'SELECT * FROM Cars'
  6. );
  8. // Executing with bound parameters
  9. $cars = $this->modelsManager->executeQuery(
  10.     'SELECT * FROM Cars WHERE name = :name:',
  11.     [
  12.         'name' => 'Audi',
  13.     ]
  14. );

Selecting Records

As the familiar SQL, PHQL allows querying of records using the SELECT statement we know, except that instead of specifying tables, we use the models classes:

  1. <?php
  3. $query = $manager->createQuery(
  4.     'SELECT * FROM Cars ORDER BY Cars.name'
  5. );
  7. $query = $manager->createQuery(
  8.     'SELECT Cars.name FROM Cars ORDER BY Cars.name'
  9. );

Classes in namespaces are also allowed:

  1. <?php
  3. $phql  = 'SELECT * FROM Formula\Cars ORDER BY Formula\Cars.name';
  4. $query = $manager->createQuery($phql);
  6. $phql  = 'SELECT Formula\Cars.name FROM Formula\Cars ORDER BY Formula\Cars.name';
  7. $query = $manager->createQuery($phql);
  9. $phql  = 'SELECT c.name FROM Formula\Cars c ORDER BY c.name';
  10. $query = $manager->createQuery($phql);

Most of the SQL standard is supported by PHQL, even nonstandard directives such as LIMIT:

  1. <?php
  3. $phql = 'SELECT c.name FROM Cars AS c WHERE c.brand_id = 21 ORDER BY c.name LIMIT 100';
  5. $query = $manager->createQuery($phql);

Result Types

Depending on the type of columns we query, the result type will vary. If you retrieve a single whole object, then the object returned is a Phalcon\Mvc\Model\Resultset\Simple. This kind of resultset is a set of complete model objects:

  1. <?php
  3. $phql = 'SELECT c.* FROM Cars AS c ORDER BY c.name';
  5. $cars = $manager->executeQuery($phql);
  7. foreach ($cars as $car) {
  8.     echo 'Name: ', $car->name, "\n";
  9. }

This is exactly the same as:

  1. <?php
  3. $cars = Cars::find(
  4.     [
  5.         'order' => 'name'
  6.     ]
  7. );
  9. foreach ($cars as $car) {
  10.     echo 'Name: ', $car->name, "\n";
  11. }

Complete objects can be modified and re-saved in the database because they represent a complete record of the associated table. There are other types of queries that do not return complete objects, for example:

  1. <?php
  3. $phql = 'SELECT c.id, c.name FROM Cars AS c ORDER BY c.name';
  5. $cars = $manager->executeQuery($phql);
  7. foreach ($cars as $car) {
  8.     echo 'Name: ', $car->name, "\n";
  9. }

We are only requesting some fields in the table, therefore those cannot be considered an entire object, so the returned object isstill a resultset of type Phalcon\Mvc\Model\Resultset\Simple. However, each element is a standard object that only contain the two columns that were requested.

These values that don’t represent complete objects are what we call scalars. PHQL allows you to query all types of scalars: fields, functions, literals, expressions, etc..:

  1. <?php
  3. $phql = "SELECT CONCAT(c.id, ' ', c.name) AS id_name FROM Cars AS c ORDER BY c.name";
  5. $cars = $manager->executeQuery($phql);
  7. foreach ($cars as $car) {
  8.     echo $car->id_name, "\n";
  9. }

As we can query complete objects or scalars, we can also query both at once:

  1. <?php
  3. $phql = 'SELECT c.price*0.16 AS taxes, c.* FROM Cars AS c ORDER BY c.name';
  5. $result = $manager->executeQuery($phql);

The result in this case is an object Phalcon\Mvc\Model\Resultset\Complex. This allows access to both complete objects and scalars at once:

  1. <?php
  3. foreach ($result as $row) {
  4.     echo 'Name: ', $row->cars->name, "\n";
  5.     echo 'Price: ', $row->cars->price, "\n";
  6.     echo 'Taxes: ', $row->taxes, "\n";
  7. }

`Scalars are mapped as properties of each ‘row’, while complete objects are mapped as properties with the name of its related model.

Joins

It’s easy to request records from multiple models using PHQL. Most kinds of Joins are supported. As we defined relationships in the models, PHQL adds these conditions automatically:

  1. <?php
  3. $phql = 'SELECT Cars.name AS car_name, Brands.name AS brand_name FROM Cars JOIN Brands';
  5. $rows = $manager->executeQuery($phql);
  7. foreach ($rows as $row) {
  8.     echo $row->car_name, "\n";
  9.     echo $row->brand_name, "\n";
  10. }

By default, an INNER JOIN is assumed. You can specify the type of JOIN in the query:

  1. <?php
  3. $phql = 'SELECT Cars.*, Brands.* FROM Cars INNER JOIN Brands';
  4. $rows = $manager->executeQuery($phql);
  6. $phql = 'SELECT Cars.*, Brands.* FROM Cars LEFT JOIN Brands';
  7. $rows = $manager->executeQuery($phql);
  9. $phql = 'SELECT Cars.*, Brands.* FROM Cars LEFT OUTER JOIN Brands';
  10. $rows = $manager->executeQuery($phql);
  12. $phql = 'SELECT Cars.*, Brands.* FROM Cars CROSS JOIN Brands';
  13. $rows = $manager->executeQuery($phql);

It is also possible to manually set the conditions of the JOIN:

  1. <?php
  3. $phql = 'SELECT Cars.*, Brands.* FROM Cars INNER JOIN Brands ON Brands.id = Cars.brands_id';
  5. $rows = $manager->executeQuery($phql);

Also, the joins can be created using multiple tables in the FROM clause:

  1. <?php
  3. $phql = 'SELECT Cars.*, Brands.* FROM Cars, Brands WHERE Brands.id = Cars.brands_id';
  5. $rows = $manager->executeQuery($phql);
  7. foreach ($rows as $row) {
  8.     echo 'Car: ', $row->cars->name, "\n";
  9.     echo 'Brand: ', $row->brands->name, "\n";
  10. }

If an alias is used to rename the models in the query, those will be used to name the attributes in the every row of the result:

  1. <?php
  3. $phql = 'SELECT c.*, b.* FROM Cars c, Brands b WHERE b.id = c.brands_id';
  5. $rows = $manager->executeQuery($phql);
  7. foreach ($rows as $row) {
  8.     echo 'Car: ', $row->c->name, "\n";
  9.     echo 'Brand: ', $row->b->name, "\n";
  10. }

When the joined model has a many-to-many relation to the from model, the intermediate model is implicitly added to the generated query:

  1. <?php
  3. $phql = 'SELECT Artists.name, Songs.name FROM Artists ' .
  4.         'JOIN Songs WHERE Artists.genre = "Trip-Hop"';
  6. $result = $this->modelsManager->executeQuery($phql);

This code executes the following SQL in MySQL:

  1. SELECT `artists`.`name`, `songs`.`name` FROM `artists`
  2. INNER JOIN `albums` ON `albums`.`artists_id` = `artists`.`id`
  3. INNER JOIN `songs` ON `albums`.`songs_id` = `songs`.`id`
  4. WHERE `artists`.`genre` = 'Trip-Hop'

Aggregations

The following examples show how to use aggregations in PHQL:

  1. <?php
  3. // How much are the prices of all the cars?
  4. $phql = 'SELECT SUM(price) AS summatory FROM Cars';
  5. $row  = $manager->executeQuery($phql)->getFirst();
  6. echo $row['summatory'];
  8. // How many cars are by each brand?
  9. $phql = 'SELECT Cars.brand_id, COUNT(*) FROM Cars GROUP BY Cars.brand_id';
  10. $rows = $manager->executeQuery($phql);
  11. foreach ($rows as $row) {
  12.     echo $row->brand_id, ' ', $row['1'], "\n";
  13. }
  15. // How many cars are by each brand?
  16. $phql = 'SELECT Brands.name, COUNT(*) FROM Cars JOIN Brands GROUP BY 1';
  17. $rows = $manager->executeQuery($phql);
  18. foreach ($rows as $row) {
  19.     echo $row->name, ' ', $row['1'], "\n";
  20. }
  22. $phql = 'SELECT MAX(price) AS maximum, MIN(price) AS minimum FROM Cars';
  23. $rows = $manager->executeQuery($phql);
  24. foreach ($rows as $row) {
  25.     echo $row['maximum'], ' ', $row['minimum'], "\n";
  26. }
  28. // Count distinct used brands
  29. $phql = 'SELECT COUNT(DISTINCT brand_id) AS brandId FROM Cars';
  30. $rows = $manager->executeQuery($phql);
  31. foreach ($rows as $row) {
  32.     echo $row->brandId, "\n";
  33. }

Conditions

Conditions allow us to filter the set of records we want to query. The WHERE clause allows to do that:

  1. <?php
  3. // Simple conditions
  4. $phql = 'SELECT * FROM Cars WHERE Cars.name = "Lamborghini Espada"';
  5. $cars = $manager->executeQuery($phql);
  7. $phql = 'SELECT * FROM Cars WHERE Cars.price > 10000';
  8. $cars = $manager->executeQuery($phql);
  10. $phql = 'SELECT * FROM Cars WHERE TRIM(Cars.name) = "Audi R8"';
  11. $cars = $manager->executeQuery($phql);
  13. $phql = 'SELECT * FROM Cars WHERE Cars.name LIKE "Ferrari%"';
  14. $cars = $manager->executeQuery($phql);
  16. $phql = 'SELECT * FROM Cars WHERE Cars.name NOT LIKE "Ferrari%"';
  17. $cars = $manager->executeQuery($phql);
  19. $phql = 'SELECT * FROM Cars WHERE Cars.price IS NULL';
  20. $cars = $manager->executeQuery($phql);
  22. $phql = 'SELECT * FROM Cars WHERE Cars.id IN (120, 121, 122)';
  23. $cars = $manager->executeQuery($phql);
  25. $phql = 'SELECT * FROM Cars WHERE Cars.id NOT IN (430, 431)';
  26. $cars = $manager->executeQuery($phql);
  28. $phql = 'SELECT * FROM Cars WHERE Cars.id BETWEEN 1 AND 100';
  29. $cars = $manager->executeQuery($phql);

Also, as part of PHQL, prepared parameters automatically escape the input data, introducing more security:

  1. <?php
  3. $phql = 'SELECT * FROM Cars WHERE Cars.name = :name:';
  4. $cars = $manager->executeQuery(
  5.     $phql,
  6.     [
  7.         'name' => 'Lamborghini Espada'
  8.     ]
  9. );
  11. $phql = 'SELECT * FROM Cars WHERE Cars.name = ?0';
  12. $cars = $manager->executeQuery(
  13.     $phql,
  14.     [
  15.         0 => 'Lamborghini Espada'
  16.     ]
  17. );

Inserting Data

With PHQL it’s possible to insert data using the familiar INSERT statement:

  1. <?php
  3. // Inserting without columns
  4. $phql = 'INSERT INTO Cars VALUES (NULL, "Lamborghini Espada", '
  5.       . '7, 10000.00, 1969, "Grand Tourer")';
  6. $manager->executeQuery($phql);
  8. // Specifying columns to insert
  9. $phql = 'INSERT INTO Cars (name, brand_id, year, style) '
  10.       . 'VALUES ("Lamborghini Espada", 7, 1969, "Grand Tourer")';
  11. $manager->executeQuery($phql);
  13. // Inserting using placeholders
  14. $phql = 'INSERT INTO Cars (name, brand_id, year, style) '
  15.       . 'VALUES (:name:, :brand_id:, :year:, :style)';
  16. $manager->executeQuery(
  17.     $phql,
  18.     [
  19.         'name'     => 'Lamborghini Espada',
  20.         'brand_id' => 7,
  21.         'year'     => 1969,
  22.         'style'    => 'Grand Tourer',
  23.     ]
  24. );

Phalcon doesn’t only transform the PHQL statements into SQL. All events and business rules defined in the model are executed as if we created individual objects manually. Let’s add a business rule on the model cars. A car cannot cost less than $ 10,000:

  1. <?php
  3. use Phalcon\Mvc\Model;
  4. use Phalcon\Mvc\Model\Message;
  6. class Cars extends Model
  7. {
  8.     public function beforeCreate()
  9.     {
  10.         if ($this->price < 10000) {
  11.             $this->appendMessage(
  12.                 new Message('A car cannot cost less than $ 10,000')
  13.             );
  15.             return false;
  16.         }
  17.     }
  18. }

If we made the following INSERT in the models Cars, the operation will not be successful because the price does not meet the business rule that we implemented. By checking the status of the insertion we can print any validation messages generated internally:

  1. <?php
  3. $phql = "INSERT INTO Cars VALUES (NULL, 'Nissan Versa', 7, 9999.00, 2015, 'Sedan')";
  5. $result = $manager->executeQuery($phql);
  7. if ($result->success() === false) {
  8.     foreach ($result->getMessages() as $message) {
  9.         echo $message->getMessage();
  10.     }
  11. }

Updating Data

Updating rows is very similar than inserting rows. As you may know, the instruction to update records is UPDATE. When a record is updated the events related to the update operation will be executed for each row.

  1. <?php
  3. // Updating a single column
  4. $phql = 'UPDATE Cars SET price = 15000.00 WHERE id = 101';
  5. $manager->executeQuery($phql);
  7. // Updating multiples columns
  8. $phql = 'UPDATE Cars SET price = 15000.00, type = "Sedan" WHERE id = 101';
  9. $manager->executeQuery($phql);
  11. // Updating multiples rows
  12. $phql = 'UPDATE Cars SET price = 7000.00, type = "Sedan" WHERE brands_id > 5';
  13. $manager->executeQuery($phql);
  15. // Using placeholders
  16. $phql = 'UPDATE Cars SET price = ?0, type = ?1 WHERE brands_id > ?2';
  17. $manager->executeQuery(
  18.     $phql,
  19.     [
  20.         0 => 7000.00,
  21.         1 => 'Sedan',
  22.         2 => 5,
  23.     ]
  24. );

An UPDATE statement performs the update in two phases:

  • First, if the UPDATE has a WHERE clause it retrieves all the objects that match these criteria,
  • Second, based on the queried objects it updates/changes the requested attributes storing them to the relational database
    This way of operation allows that events, virtual foreign keys and validations take part of the updating process.In summary, the following code:
  1. <?php
  3. $phql = 'UPDATE Cars SET price = 15000.00 WHERE id > 101';
  5. $result = $manager->executeQuery($phql);
  7. if ($result->success() === false) {
  8.     $messages = $result->getMessages();
  10.     foreach ($messages as $message) {
  11.         echo $message->getMessage();
  12.     }
  13. }

is somewhat equivalent to:

  1. <?php
  3. $messages = null;
  5. $process = function () use (&$messages) {
  6.     $cars = Cars::find('id > 101');
  8.     foreach ($cars as $car) {
  9.         $car->price = 15000;
  11.         if ($car->save() === false) {
  12.             $messages = $car->getMessages();
  14.             return false;
  15.         }
  16.     }
  18.     return true;
  19. };
  21. $success = $process();

Deleting Data

When a record is deleted the events related to the delete operation will be executed for each row:

  1. <?php
  3. // Deleting a single row
  4. $phql = 'DELETE FROM Cars WHERE id = 101';
  5. $manager->executeQuery($phql);
  7. // Deleting multiple rows
  8. $phql = 'DELETE FROM Cars WHERE id > 100';
  9. $manager->executeQuery($phql);
  11. // Using placeholders
  12. $phql = 'DELETE FROM Cars WHERE id BETWEEN :initial: AND :final:';
  13. $manager->executeQuery(
  14.     $phql,
  15.     [
  16.         'initial' => 1,
  17.         'final'   => 100,
  18.     ]
  19. );

DELETE operations are also executed in two phases like UPDATEs. To check if the deletion produces any validation messages you should check the status code returned:

  1. <?php
  3. // Deleting multiple rows
  4. $phql = 'DELETE FROM Cars WHERE id > 100';
  6. $result = $manager->executeQuery($phql);
  8. if ($result->success() === false) {
  9.     $messages = $result->getMessages();
  11.     foreach ($messages as $message) {
  12.         echo $message->getMessage();
  13.     }
  14. }

Creating queries using the Query Builder

A builder is available to create PHQL queries without the need to write PHQL statements, also providing IDE facilities:

  1. <?php
  3. // Getting a whole set
  4. $robots = $this->modelsManager->createBuilder()
  5.     ->from('Robots')
  6.     ->join('RobotsParts')
  7.     ->orderBy('Robots.name')
  8.     ->getQuery()
  9.     ->execute();
  11. // Getting the first row
  12. $robots = $this->modelsManager->createBuilder()
  13.     ->from('Robots')
  14.     ->join('RobotsParts')
  15.     ->orderBy('Robots.name')
  16.     ->getQuery()
  17.     ->getSingleResult();

That is the same as:

  1. <?php
  3. $phql = 'SELECT Robots.* FROM Robots JOIN RobotsParts p ORDER BY Robots.name LIMIT 20';
  5. $result = $manager->executeQuery($phql);

More examples of the builder:

  1. <?php
  3. // 'SELECT Robots.* FROM Robots';
  4. $builder->from('Robots');
  6. // 'SELECT Robots.*, RobotsParts.* FROM Robots, RobotsParts';
  7. $builder->from(
  8.     [
  9.         'Robots',
  10.         'RobotsParts',
  11.     ]
  12. );
  14. // 'SELECT * FROM Robots';
  15. $phql = $builder->columns('*')
  16.                 ->from('Robots');
  18. // 'SELECT id FROM Robots';
  19. $builder->columns('id')
  20.         ->from('Robots');
  22. // 'SELECT id, name FROM Robots';
  23. $builder->columns(['id', 'name'])
  24.         ->from('Robots');
  26. // 'SELECT Robots.* FROM Robots WHERE Robots.name = 'Voltron'';
  27. $builder->from('Robots')
  28.         ->where("Robots.name = 'Voltron'");
  30. // 'SELECT Robots.* FROM Robots WHERE Robots.id = 100';
  31. $builder->from('Robots')
  32.         ->where(100);
  34. // 'SELECT Robots.* FROM Robots WHERE Robots.type = 'virtual' AND Robots.id > 50';
  35. $builder->from('Robots')
  36.         ->where("type = 'virtual'")
  37.         ->andWhere('id > 50');
  39. // 'SELECT Robots.* FROM Robots WHERE Robots.type = 'virtual' OR Robots.id > 50';
  40. $builder->from('Robots')
  41.         ->where("type = 'virtual'")
  42.         ->orWhere('id > 50');
  44. // 'SELECT Robots.* FROM Robots GROUP BY Robots.name';
  45. $builder->from('Robots')
  46.         ->groupBy('Robots.name');
  48. // 'SELECT Robots.* FROM Robots GROUP BY Robots.name, Robots.id';
  49. $builder->from('Robots')
  50.         ->groupBy(['Robots.name', 'Robots.id']);
  52. // 'SELECT Robots.name, SUM(Robots.price) FROM Robots GROUP BY Robots.name';
  53. $builder->columns(['Robots.name', 'SUM(Robots.price)'])
  54.     ->from('Robots')
  55.     ->groupBy('Robots.name');
  57. // 'SELECT Robots.name, SUM(Robots.price) FROM Robots GROUP BY Robots.name HAVING SUM(Robots.price) > 1000';
  58. $builder->columns(['Robots.name', 'SUM(Robots.price)'])
  59.     ->from('Robots')
  60.     ->groupBy('Robots.name')
  61.     ->having('SUM(Robots.price) > 1000');
  63. // 'SELECT Robots.* FROM Robots JOIN RobotsParts';
  64. $builder->from('Robots')
  65.     ->join('RobotsParts');
  67. // 'SELECT Robots.* FROM Robots JOIN RobotsParts AS p';
  68. $builder->from('Robots')
  69.     ->join('RobotsParts', null, 'p');
  71. // 'SELECT Robots.* FROM Robots JOIN RobotsParts ON Robots.id = RobotsParts.robots_id AS p';
  72. $builder->from('Robots')
  73.     ->join('RobotsParts', 'Robots.id = RobotsParts.robots_id', 'p');
  75. // 'SELECT Robots.* FROM Robots
  76. // JOIN RobotsParts ON Robots.id = RobotsParts.robots_id AS p
  77. // JOIN Parts ON Parts.id = RobotsParts.parts_id AS t';
  78. $builder->from('Robots')
  79.     ->join('RobotsParts', 'Robots.id = RobotsParts.robots_id', 'p')
  80.     ->join('Parts', 'Parts.id = RobotsParts.parts_id', 't');
  82. // 'SELECT r.* FROM Robots AS r';
  83. $builder->addFrom('Robots', 'r');
  85. // 'SELECT Robots.*, p.* FROM Robots, Parts AS p';
  86. $builder->from('Robots')
  87.     ->addFrom('Parts', 'p');
  89. // 'SELECT r.*, p.* FROM Robots AS r, Parts AS p';
  90. $builder->from(['r' => 'Robots'])
  91.         ->addFrom('Parts', 'p');
  93. // 'SELECT r.*, p.* FROM Robots AS r, Parts AS p';
  94. $builder->from(['r' => 'Robots', 'p' => 'Parts']);
  96. // 'SELECT Robots.* FROM Robots LIMIT 10';
  97. $builder->from('Robots')
  98.     ->limit(10);
  100. // 'SELECT Robots.* FROM Robots LIMIT 10 OFFSET 5';
  101. $builder->from('Robots')
  102.         ->limit(10, 5);
  104. // 'SELECT Robots.* FROM Robots WHERE id BETWEEN 1 AND 100';
  105. $builder->from('Robots')
  106.         ->betweenWhere('id', 1, 100);
  108. // 'SELECT Robots.* FROM Robots WHERE id IN (1, 2, 3)';
  109. $builder->from('Robots')
  110.         ->inWhere('id', [1, 2, 3]);
  112. // 'SELECT Robots.* FROM Robots WHERE id NOT IN (1, 2, 3)';
  113. $builder->from('Robots')
  114.         ->notInWhere('id', [1, 2, 3]);
  116. // 'SELECT Robots.* FROM Robots WHERE name LIKE '%Art%';
  117. $builder->from('Robots')
  118.         ->where('name LIKE :name:', ['name' => '%' . $name . '%']);
  120. // 'SELECT r.* FROM Store\Robots WHERE r.name LIKE '%Art%';
  121. $builder->from(['r' => 'Store\Robots'])
  122.         ->where('r.name LIKE :name:', ['name' => '%' . $name . '%']);

Bound Parameters

Bound parameters in the query builder can be set as the query is constructed or past all at once when executing:

  1. <?php
  3. // Passing parameters in the query construction
  4. $robots = $this->modelsManager->createBuilder()
  5.     ->from('Robots')
  6.     ->where('name = :name:', ['name' => $name])
  7.     ->andWhere('type = :type:', ['type' => $type])
  8.     ->getQuery()
  9.     ->execute();
  11. // Passing parameters in query execution
  12. $robots = $this->modelsManager->createBuilder()
  13.     ->from('Robots')
  14.     ->where('name = :name:')
  15.     ->andWhere('type = :type:')
  16.     ->getQuery()
  17.     ->execute(['name' => $name, 'type' => $type]);

Disallow literals in PHQL

Literals can be disabled in PHQL, this means that directly using strings, numbers and boolean values in PHQL strings will be disallowed. If PHQL statements are created embedding external data on them, this could open the application to potential SQL injections:

  1. <?php
  3. $login  = 'voltron';
  4. $phql   = "SELECT * FROM Models\Users WHERE login = '$login'";
  5. $result = $manager->executeQuery($phql);

If $login is changed to ' OR '' = ', the produced PHQL is:

  1. SELECT * FROM Models\Users WHERE login = '' OR '' = ''

Which is always true no matter what the login stored in the database is.

If literals are disallowed strings can be used as part of a PHQL statement, thus an exception will be thrown forcing the developer to use bound parameters. The same query can be written in a secure way like this:

  1. <?php
  3. $type   = 'virtual';
  4. $phql   = 'SELECT Robots.* FROM Robots WHERE Robots.type = :type:';
  5. $result = $manager->executeQuery(
  6.     $phql,
  7.     [
  8.         'type' => $type,
  9.     ]
  10. );

You can disallow literals in the following way:

  1. <?php
  3. use Phalcon\Mvc\Model;
  5. Model::setup(
  6.     [
  7.         'phqlLiterals' => false
  8.     ]
  9. );

Bound parameters can be used even if literals are allowed or not. Disallowing them is just another security decision a developer could take in web applications.

Escaping Reserved Words

PHQL has a few reserved words, if you want to use any of them as attributes or models names, you need to escape those words using the cross-database escaping delimiters [ and ]:

  1. <?php
  3. $phql   = 'SELECT * FROM [Update]';
  4. $result = $manager->executeQuery($phql);
  6. $phql   = 'SELECT id, [Like] FROM Posts';
  7. $result = $manager->executeQuery($phql);

The delimiters are dynamically translated to valid delimiters depending on the database system where the application is currently running on.

PHQL Lifecycle

Being a high-level language, PHQL gives developers the ability to personalize and customize different aspects in order to suit their needs. The following is the life cycle of each PHQL statement executed:

  • The PHQL is parsed and converted into an Intermediate Representation (IR) which is independent of the SQL implemented by database system
  • The IR is converted to valid SQL according to the database system associated to the model
  • PHQL statements are parsed once and cached in memory. Further executions of the same statement result in a slightly faster execution

Using Raw SQL

A database system could offer specific SQL extensions that aren’t supported by PHQL, in this case, a raw SQL can be appropriate:

  1. <?php
  3. use Phalcon\Mvc\Model;
  4. use Phalcon\Mvc\Model\Resultset\Simple as Resultset;
  6. class Robots extends Model
  7. {
  8.     public static function findByCreateInterval()
  9.     {
  10.         // A raw SQL statement
  11.         $sql = 'SELECT * FROM robots WHERE id > 0';
  13.         // Base model
  14.         $robot = new Robots();
  16.         // Execute the query
  17.         return new Resultset(
  18.             null,
  19.             $robot,
  20.             $robot->getReadConnection()->query($sql)
  21.         );
  22.     }
  23. }

If raw SQL queries are common in your application a generic method could be added to your model:

  1. <?php
  3. use Phalcon\Mvc\Model;
  4. use Phalcon\Mvc\Model\Resultset\Simple as Resultset;
  6. class Robots extends Model
  7. {
  8.     public static function findByRawSql($conditions, $params = null)
  9.     {
  10.         // A raw SQL statement
  11.         $sql = 'SELECT * FROM robots WHERE $conditions';
  13.         // Base model
  14.         $robot = new Robots();
  16.         // Execute the query
  17.         return new Resultset(
  18.             null,
  19.             $robot,
  20.             $robot->getReadConnection()->query($sql, $params)
  21.         );
  22.     }
  23. }

The above findByRawSql could be used as follows:

  1. <?php
  3. $robots = Robots::findByRawSql(
  4.     'id > ?',
  5.     [
  6.         10
  7.     ]
  8. );

Troubleshooting

Some things to keep in mind when using PHQL:

  • Classes are case-sensitive, if a class is not defined with the same name as it was created this could lead to an unexpected behavior in operating systems with case-sensitive file systems such as Linux.
  • Correct charset must be defined in the connection to bind parameters with success.
  • Aliased classes aren’t replaced by full namespaced classes since this only occurs in PHP code and not inside strings.
  • If column renaming is enabled avoid using column aliases with the same name as columns to be renamed, this may confuse the query resolver.