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

Open in your IDE?
  1. <?php
  3. /*
  4.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  5.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  6.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  7.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  8.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  9.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  10.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  11.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  12.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  13.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  14.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  15.  *
  16.  * This software consists of voluntary contributions made by many individuals
  17.  * and is licensed under the MIT license. For more information, see
  18.  * <http://www.doctrine-project.org>.
  19.  */
  21. namespace Doctrine\ORM\Query\Expr;
  23. use function count;
  24. use function implode;
  26. /**
  27.  * Expression class for building DQL Order By parts.
  28.  *
  29.  * @link    www.doctrine-project.org
  30.  */
  31. class OrderBy
  32. {
  33.     /** @var string */
  34.     protected $preSeparator = '';
  36.     /** @var string */
  37.     protected $separator = ', ';
  39.     /** @var string */
  40.     protected $postSeparator = '';
  42.     /** @var string[] */
  43.     protected $allowedClasses = [];
  45.     /** @psalm-var list<string> */
  46.     protected $parts = [];
  48.     /**
  49.      * @param string|null $sort
  50.      * @param string|null $order
  51.      */
  52.     public function __construct($sort = null, $order = null)
  53.     {
  54.         if ($sort) {
  55.             $this->add($sort, $order);
  56.         }
  57.     }
  59.     /**
  60.      * @param string      $sort
  61.      * @param string|null $order
  62.      *
  63.      * @return void
  64.      */
  65.     public function add($sort, $order = null)
  66.     {
  67.         $order         = ! $order ? 'ASC' : $order;
  68.         $this->parts[] = $sort . ' ' . $order;
  69.     }
  71.     /**
  72.      * @return int
  73.      */
  74.     public function count()
  75.     {
  76.         return count($this->parts);
  77.     }
  79.     /**
  80.      * @psalm-return list<string>
  81.      */
  82.     public function getParts()
  83.     {
  84.         return $this->parts;
  85.     }
  87.     /**
  88.      * @return string
  89.      */
  90.     public function __toString()
  91.     {
  92.         return $this->preSeparator . implode($this->separator, $this->parts) . $this->postSeparator;
  93.     }
  94. }