vendor/contao/core-bundle/src/Resources/contao/library/Contao/Model/QueryBuilder.php line 29

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao\Model;
  13. use Contao\Database;
  14. use Contao\DcaExtractor;
  16. /**
  17.  * The class reads the relation metadata from the DCA and creates the necessary
  18.  * JOIN queries to retrieve an object from the database.
  19.  */
  20. class QueryBuilder
  21. {
  22.     /**
  23.      * Build a query based on the given options
  24.      *
  25.      * @param array $arrOptions The options array
  26.      *
  27.      * @return string The query string
  28.      */
  29.     public static function find(array $arrOptions)
  30.     {
  31.         $objBase = DcaExtractor::getInstance($arrOptions['table']);
  33.         if (!$objBase->hasRelations())
  34.         {
  35.             $strQuery = "SELECT * FROM " . $arrOptions['table'];
  36.         }
  37.         else
  38.         {
  39.             $arrJoins = array();
  40.             $arrFields = array($arrOptions['table'] . ".*");
  41.             $intCount = 0;
  43.             foreach ($objBase->getRelations() as $strKey=>$arrConfig)
  44.             {
  45.                 // Automatically join the single-relation records
  46.                 if (($arrConfig['load'] ?? null) == 'eager' || ($arrOptions['eager'] ?? null))
  47.                 {
  48.                     if ($arrConfig['type'] == 'hasOne' || $arrConfig['type'] == 'belongsTo')
  49.                     {
  50.                         ++$intCount;
  51.                         $objRelated = DcaExtractor::getInstance($arrConfig['table']);
  53.                         foreach (array_keys($objRelated->getFields()) as $strField)
  54.                         {
  55.                             $arrFields[] = 'j' . $intCount . '.' . Database::quoteIdentifier($strField) . ' AS ' . $strKey . '__' . $strField;
  56.                         }
  58.                         $arrJoins[] = " LEFT JOIN " . $arrConfig['table'] . " j$intCount ON " . $arrOptions['table'] . "." . Database::quoteIdentifier($strKey) . "=j$intCount." . $arrConfig['field'];
  59.                     }
  60.                 }
  61.             }
  63.             // Generate the query
  64.             $strQuery = "SELECT " . implode(', ', $arrFields) . " FROM " . $arrOptions['table'] . implode("", $arrJoins);
  65.         }
  67.         // Where condition
  68.         if (isset($arrOptions['column']))
  69.         {
  70.             $strQuery .= " WHERE " . (\is_array($arrOptions['column']) ? implode(" AND ", $arrOptions['column']) : $arrOptions['table'] . '.' . Database::quoteIdentifier($arrOptions['column']) . "=?");
  71.         }
  73.         // Group by
  74.         if (isset($arrOptions['group']))
  75.         {
  76.             trigger_deprecation('contao/core-bundle', '4.4', 'Using the "group" option has been deprecated and will no longer work in Contao 5.0. See https://github.com/contao/contao/issues/1680.');
  77.             $strQuery .= " GROUP BY " . $arrOptions['group'];
  78.         }
  80.         // Having (see #6446)
  81.         if (isset($arrOptions['having']))
  82.         {
  83.             $strQuery .= " HAVING " . $arrOptions['having'];
  84.         }
  86.         // Order by
  87.         if (isset($arrOptions['order']))
  88.         {
  89.             $strQuery .= " ORDER BY " . $arrOptions['order'];
  90.         }
  92.         return $strQuery;
  93.     }
  95.     /**
  96.      * Build a query based on the given options to count the number of records
  97.      *
  98.      * @param array $arrOptions The options array
  99.      *
  100.      * @return string The query string
  101.      */
  102.     public static function count(array $arrOptions)
  103.     {
  104.         $strQuery = "SELECT COUNT(*) AS count FROM " . $arrOptions['table'];
  106.         if (isset($arrOptions['column']))
  107.         {
  108.             $strQuery .= " WHERE " . (\is_array($arrOptions['column']) ? implode(" AND ", $arrOptions['column']) : $arrOptions['table'] . '.' . Database::quoteIdentifier($arrOptions['column']) . "=?");
  109.         }
  111.         return $strQuery;
  112.     }
  113. }
  115. class_alias(QueryBuilder::class, 'Model\QueryBuilder');