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

   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  */
  19
  20 namespace Doctrine\ORM\Query\Expr;
  21
  22 /**
  23  * Expression class for building DQL Order By parts
  24  *
  25  *
  26  * @link    www.doctrine-project.org
  27  * @since   2.0
  28  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
  29  * @author  Jonathan Wage <jonwage@gmail.com>
  30  * @author  Roman Borschel <roman@code-factory.org>
  31  */
  32 class OrderBy
  33 {
  34     /**
  35      * @var string
  36      */
  37     protected $preSeparator = '';
  38
  39     /**
  40      * @var string
  41      */
  42     protected $separator = ', ';
  43
  44     /**
  45      * @var string
  46      */
  47     protected $postSeparator = '';
  48
  49     /**
  50      * @var array
  51      */
  52     protected $allowedClasses = array();
  53
  54     /**
  55      * @var array
  56      */
  57     protected $parts = array();
  58
  59     /**
  60      * @param string $sort
  61      * @param string $order
  62      */
  63     public function __construct($sort = null, $order = null)
  64     {
  65         if ($sort) {
  66             $this->add($sort, $order);
  67         }
  68     }
  69
  70     /**
  71      * @param string $sort
  72      * @param string $order
  73      */
  74     public function add($sort, $order = null)
  75     {
  76         $order = ! $order ? 'ASC' : $order;
  77         $this->parts[] = $sort . ' '. $order;
  78     }
  79
  80     /**
  81      * @return integer
  82      */
  83     public function count()
  84     {
  85         return count($this->parts);
  86     }
  87
  88     /**
  89      * @return array
  90      */
  91     public function getParts()
  92     {
  93         return $this->parts;
  94     }
  95
  96     /**
  97      * @return string
  98      */
  99     public function __tostring()
 100     {
 101         return $this->preSeparator . implode($this->separator, $this->parts) . $this->postSeparator;
 102     }
 103 }