doctrine2/lib/Doctrine/Query/Production/OrderByClause.php

<?php
/*
 *  $Id$
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.phpdoctrine.org>.
 */

/**
 * OrderByClause = "ORDER" "BY" OrderByItem {"," OrderByItem}
 *
 * @package     Doctrine
 * @subpackage  Query
 * @author      Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author      Janne Vanhala <jpvanhal@cc.hut.fi>
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link        http://www.phpdoctrine.org
 * @since       2.0
 * @version     $Revision$
 */
class Doctrine_Query_Production_OrderByClause extends Doctrine_Query_Production
{
    protected $_orderByItems = array();


    public function syntax($paramHolder)
    {
        $this->_parser->match(Doctrine_Query_Token::T_ORDER);
        $this->_parser->match(Doctrine_Query_Token::T_BY);

        $this->_orderByItems[] = $this->AST('OrderByItem', $paramHolder);

        while ($this->_isNextToken(',')) {
            $this->_parser->match(',');
            $this->_orderByItems[] = $this->AST('OrderByItem', $paramHolder);
        }
    }


    public function buildSql()
    {
        $str = 'ORDER BY ';

        for ($i = 0, $l = count($this->_orderByItems); $i < $l; $i++) {
            if ($i != 0) {
                $str .= ', ';
            }

            $str .= ( $this->_orderByItems[$i] instanceof Doctrine_Query_Production ) ?
                $this->_orderByItems[$i]->buildSql() : $this->_orderByItems[$i];
        }

        return $str;
    }
    
    /**
     * Visitor support
     *
     * @param object $visitor
     */
    public function accept($visitor)
    {
        foreach ($this->_orderByItems as $item) {
            $item->accept($visitor);
        }
        $visitor->visitOrderByClause($this);
    }
    
    /* Getters */
    
    public function getOrderByItems()
    {
        return $this->_orderByItems;
    }
}