doctrine2/lib/Doctrine/Query/Production/Function.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>.
 */

/**
 * Function = identifier "(" [Expression {"," Expression}] ")"
 *
 * @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_Function extends Doctrine_Query_Production
{
    protected $_functionName;

    protected $_arguments = array();


    public function syntax($paramHolder)
    {
        // Function = identifier "(" [Expression {"," Expression}] ")"
        $this->_parser->match(Doctrine_Query_Token::T_IDENTIFIER);
        $this->_functionName = $this->_parser->token['value'];

        $this->_parser->match('(');

        if ( ! $this->_isNextToken(')')) {
            $this->_arguments[] = $this->AST('Expression', $paramHolder);

            while ($this->_isNextToken(',')) {
                $this->_parser->match(',');

                $this->_arguments[] = $this->AST('Expression', $paramHolder);
            }
        }

        $this->_parser->match(')');
    }


    public function buildSql()
    {
        return $this->_functionName . '(' . implode(', ', $this->_mapArguments()) . ')';
    }


    protected function _mapArguments()
    {
        return array_map(array(&$this, '_mapArgument'), $this->_arguments);
    }


    protected function _mapArgument($value)
    {
        return $value->buildSql();
    }
    
    /**
     * Visitor support
     *
     * @param object $visitor
     */
    public function accept($visitor)
    {
        foreach ($this->_arguments as $argument) {
            $argument->accept($visitor);
        }
        $visitor->visitFunction($this);
    }
    
    /* Getters */
    
    public function getFunctionName()
    {
        return $this->_functionName;
    }
    
    public function getArguments()
    {
        return $this->_arguments;
    }
}