vendor/doctrine/orm/lib/Doctrine/ORM/Query/Expr/OrderBy.php line 15

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Query\Expr;
  7. use function count;
  8. use function implode;
  10. /**
  11.  * Expression class for building DQL Order By parts.
  12.  *
  13.  * @link    www.doctrine-project.org
  14.  */
  15. class OrderBy
  16. {
  17.     /** @var string */
  18.     protected $preSeparator = '';
  20.     /** @var string */
  21.     protected $separator = ', ';
  23.     /** @var string */
  24.     protected $postSeparator = '';
  26.     /** @var string[] */
  27.     protected $allowedClasses = [];
  29.     /** @psalm-var list<string> */
  30.     protected $parts = [];
  32.     /**
  33.      * @param string|null $sort
  34.      * @param string|null $order
  35.      */
  36.     public function __construct($sort = null, $order = null)
  37.     {
  38.         if ($sort) {
  39.             $this->add($sort, $order);
  40.         }
  41.     }
  43.     /**
  44.      * @param string      $sort
  45.      * @param string|null $order
  46.      *
  47.      * @return void
  48.      */
  49.     public function add($sort, $order = null)
  50.     {
  51.         $order         = ! $order ? 'ASC' : $order;
  52.         $this->parts[] = $sort . ' ' . $order;
  53.     }
  55.     /**
  56.      * @return int
  57.      * @psalm-return 0|positive-int
  58.      */
  59.     public function count()
  60.     {
  61.         return count($this->parts);
  62.     }
  64.     /** @psalm-return list<string> */
  65.     public function getParts()
  66.     {
  67.         return $this->parts;
  68.     }
  70.     /** @return string */
  71.     public function __toString()
  72.     {
  73.         return $this->preSeparator . implode($this->separator, $this->parts) . $this->postSeparator;
  74.     }
  75. }