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

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