<?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>.
 */

/**
 * LikeExpression = ["NOT"] "LIKE" Expression ["ESCAPE" string]
 *
 * @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_LikeExpression extends Doctrine_Query_Production
{
    protected $_not;

    protected $_expression;

    protected $_escapeString;


    public function syntax($paramHolder)
    {
        // LikeExpression = ["NOT"] "LIKE" Expression ["ESCAPE" string]
        $this->_escapeString = null;
        $this->_not = false;

        if ($this->_isNextToken(Doctrine_Query_Token::T_NOT)) {
            $this->_parser->match(Doctrine_Query_Token::T_NOT);
            $this->_not = true;
        }

        $this->_parser->match(Doctrine_Query_Token::T_LIKE);

        $this->_expression = $this->AST('Expression', $paramHolder);

        if ($this->_isNextToken(Doctrine_Query_Token::T_ESCAPE)) {
            $this->_parser->match(Doctrine_Query_Token::T_ESCAPE);
            $this->_parser->match(Doctrine_Query_Token::T_STRING);

            $this->_escapeString = $this->_parser->token['value'];
        }
    }


    public function buildSql()
    {
        return (($this->_not) ? 'NOT ' : '') . 'LIKE ' . $this->_expression->buildSql()
             . (($this->_escapeString !== null) ? ' ESCAPE ' . $this->_escapeString : '');
    }


    /* Getters */
    public function isNot()
    {
        return $this->_not;
    }


    public function getExpression()
    {
        return $this->_expression;
    }


    public function getEscapeString()
    {
        return $this->_escapeString;
    }
}