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

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.  * @author Leo Feyer <https://github.com/leofeyer>
  21.  */
  22. class QueryBuilder
  23. {
  24.     /**
  25.      * Build a query based on the given options
  26.      *
  27.      * @param array $arrOptions The options array
  28.      *
  29.      * @return string The query string
  30.      */
  31.     public static function find(array $arrOptions)
  32.     {
  33.         $objBase = DcaExtractor::getInstance($arrOptions['table']);
  35.         if (!$objBase->hasRelations())
  36.         {
  37.             $strQuery = "SELECT * FROM " . $arrOptions['table'];
  38.         }
  39.         else
  40.         {
  41.             $arrJoins = array();
  42.             $arrFields = array($arrOptions['table'] . ".*");
  43.             $intCount = 0;
  45.             foreach ($objBase->getRelations() as $strKey=>$arrConfig)
  46.             {
  47.                 // Automatically join the single-relation records
  48.                 if (($arrConfig['load'] ?? null) == 'eager' || ($arrOptions['eager'] ?? null))
  49.                 {
  50.                     if ($arrConfig['type'] == 'hasOne' || $arrConfig['type'] == 'belongsTo')
  51.                     {
  52.                         ++$intCount;
  53.                         $objRelated = DcaExtractor::getInstance($arrConfig['table']);
  55.                         foreach (array_keys($objRelated->getFields()) as $strField)
  56.                         {
  57.                             $arrFields[] = 'j' . $intCount . '.' . Database::quoteIdentifier($strField) . ' AS ' . $strKey . '__' . $strField;
  58.                         }
  60.                         $arrJoins[] = " LEFT JOIN " . $arrConfig['table'] . " j$intCount ON " . $arrOptions['table'] . "." . Database::quoteIdentifier($strKey) . "=j$intCount." . $arrConfig['field'];
  61.                     }
  62.                 }
  63.             }
  65.             // Generate the query
  66.             $strQuery = "SELECT " . implode(', ', $arrFields) . " FROM " . $arrOptions['table'] . implode("", $arrJoins);
  67.         }
  69.         // Where condition
  70.         if (isset($arrOptions['column']))
  71.         {
  72.             $strQuery .= " WHERE " . (\is_array($arrOptions['column']) ? implode(" AND ", $arrOptions['column']) : $arrOptions['table'] . '.' . Database::quoteIdentifier($arrOptions['column']) . "=?");
  73.         }
  75.         // Group by
  76.         if (isset($arrOptions['group']))
  77.         {
  78.             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.');
  79.             $strQuery .= " GROUP BY " . $arrOptions['group'];
  80.         }
  82.         // Having (see #6446)
  83.         if (isset($arrOptions['having']))
  84.         {
  85.             $strQuery .= " HAVING " . $arrOptions['having'];
  86.         }
  88.         // Order by
  89.         if (isset($arrOptions['order']))
  90.         {
  91.             $strQuery .= " ORDER BY " . $arrOptions['order'];
  92.         }
  94.         return $strQuery;
  95.     }
  97.     /**
  98.      * Build a query based on the given options to count the number of records
  99.      *
  100.      * @param array $arrOptions The options array
  101.      *
  102.      * @return string The query string
  103.      */
  104.     public static function count(array $arrOptions)
  105.     {
  106.         $strQuery = "SELECT COUNT(*) AS count FROM " . $arrOptions['table'];
  108.         if (isset($arrOptions['column']))
  109.         {
  110.             $strQuery .= " WHERE " . (\is_array($arrOptions['column']) ? implode(" AND ", $arrOptions['column']) : $arrOptions['table'] . '.' . Database::quoteIdentifier($arrOptions['column']) . "=?");
  111.         }
  113.         return $strQuery;
  114.     }
  115. }
  117. class_alias(QueryBuilder::class, 'Model\QueryBuilder');