|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * expression-types.php. |
| 5 | + * |
| 6 | + * |
| 7 | + * Copyright (c) 2010-2013, Justin Swanhart |
| 8 | + * with contributions by André Rothe <[email protected], [email protected]> |
| 9 | + * and David Négrier <[email protected]> |
| 10 | + * |
| 11 | + * All rights reserved. |
| 12 | + * |
| 13 | + * Redistribution and use in source and binary forms, with or without modification, |
| 14 | + * are permitted provided that the following conditions are met: |
| 15 | + * |
| 16 | + * * Redistributions of source code must retain the above copyright notice, |
| 17 | + * this list of conditions and the following disclaimer. |
| 18 | + * * Redistributions in binary form must reproduce the above copyright notice, |
| 19 | + * this list of conditions and the following disclaimer in the documentation |
| 20 | + * and/or other materials provided with the distribution. |
| 21 | + * |
| 22 | + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY |
| 23 | + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 24 | + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| 25 | + * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 26 | + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED |
| 27 | + * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
| 28 | + * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 29 | + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
| 30 | + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH |
| 31 | + * DAMAGE. |
| 32 | + */ |
| 33 | + |
| 34 | +namespace SQLParser\Node; |
| 35 | + |
| 36 | +use Doctrine\DBAL\Connection; |
| 37 | +use Mouf\MoufInstanceDescriptor; |
| 38 | +use Mouf\MoufManager; |
| 39 | +use SQLParser\Node\Traverser\NodeTraverser; |
| 40 | +use SQLParser\Node\Traverser\VisitorInterface; |
| 41 | + |
| 42 | +/** |
| 43 | + * This class represents a node that is an SQL function call. |
| 44 | + * |
| 45 | + * @author David Négrier <[email protected]> |
| 46 | + */ |
| 47 | +class SimpleFunction implements NodeInterface |
| 48 | +{ |
| 49 | + private $baseExpression; |
| 50 | + |
| 51 | + /** |
| 52 | + * Returns the base expression (the string that generated this expression). |
| 53 | + * |
| 54 | + * @return string |
| 55 | + */ |
| 56 | + public function getBaseExpression() |
| 57 | + { |
| 58 | + return $this->baseExpression; |
| 59 | + } |
| 60 | + |
| 61 | + /** |
| 62 | + * Sets the base expression (the string that generated this expression). |
| 63 | + * |
| 64 | + * @param string $baseExpression |
| 65 | + */ |
| 66 | + public function setBaseExpression($baseExpression) |
| 67 | + { |
| 68 | + $this->baseExpression = $baseExpression; |
| 69 | + } |
| 70 | + |
| 71 | + private $subTree; |
| 72 | + |
| 73 | + public function getSubTree() |
| 74 | + { |
| 75 | + return $this->subTree; |
| 76 | + } |
| 77 | + |
| 78 | + /** |
| 79 | + * Sets the subtree. |
| 80 | + * |
| 81 | + * @Important |
| 82 | + * |
| 83 | + * @param array<NodeInterface>|NodeInterface $subTree |
| 84 | + */ |
| 85 | + public function setSubTree($subTree) |
| 86 | + { |
| 87 | + $this->subTree = $subTree; |
| 88 | + $this->subTree = NodeFactory::simplify($this->subTree); |
| 89 | + } |
| 90 | + |
| 91 | + private $alias; |
| 92 | + |
| 93 | + public function getAlias() |
| 94 | + { |
| 95 | + return $this->alias; |
| 96 | + } |
| 97 | + |
| 98 | + /** |
| 99 | + * Sets the alias. |
| 100 | + * |
| 101 | + * @Important |
| 102 | + * |
| 103 | + * @param string $alias |
| 104 | + */ |
| 105 | + public function setAlias($alias) |
| 106 | + { |
| 107 | + $this->alias = $alias; |
| 108 | + } |
| 109 | + |
| 110 | + private $direction; |
| 111 | + |
| 112 | + public function getDiretion() |
| 113 | + { |
| 114 | + return $this->direction; |
| 115 | + } |
| 116 | + |
| 117 | + /** |
| 118 | + * Sets the direction. |
| 119 | + * |
| 120 | + * @Important |
| 121 | + * |
| 122 | + * @param string $direction |
| 123 | + */ |
| 124 | + public function setDirection($direction) |
| 125 | + { |
| 126 | + $this->direction = $direction; |
| 127 | + } |
| 128 | + |
| 129 | + private $brackets = false; |
| 130 | + |
| 131 | + /** |
| 132 | + * Returns true if the expression is between brackets. |
| 133 | + * |
| 134 | + * @return bool |
| 135 | + */ |
| 136 | + public function hasBrackets() |
| 137 | + { |
| 138 | + return $this->brackets; |
| 139 | + } |
| 140 | + |
| 141 | + /** |
| 142 | + * Returns a Mouf instance descriptor describing this object. |
| 143 | + * |
| 144 | + * @param MoufManager $moufManager |
| 145 | + * |
| 146 | + * @return MoufInstanceDescriptor |
| 147 | + */ |
| 148 | + public function toInstanceDescriptor(MoufManager $moufManager) |
| 149 | + { |
| 150 | + $instanceDescriptor = $moufManager->createInstance(get_called_class()); |
| 151 | + $instanceDescriptor->getProperty('baseExpression')->setValue(NodeFactory::nodeToInstanceDescriptor($this->baseExpression, $moufManager)); |
| 152 | + $instanceDescriptor->getProperty('subTree')->setValue(NodeFactory::nodeToInstanceDescriptor($this->subTree, $moufManager)); |
| 153 | + $instanceDescriptor->getProperty('alias')->setValue(NodeFactory::nodeToInstanceDescriptor($this->alias, $moufManager)); |
| 154 | + $instanceDescriptor->getProperty('direction')->setValue(NodeFactory::nodeToInstanceDescriptor($this->direction, $moufManager)); |
| 155 | + |
| 156 | + return $instanceDescriptor; |
| 157 | + } |
| 158 | + |
| 159 | + /** |
| 160 | + * Renders the object as a SQL string. |
| 161 | + * |
| 162 | + * @param Connection $dbConnection |
| 163 | + * @param array $parameters |
| 164 | + * @param number $indent |
| 165 | + * @param int $conditionsMode |
| 166 | + * |
| 167 | + * @return string |
| 168 | + */ |
| 169 | + public function toSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY) |
| 170 | + { |
| 171 | + $sql = ''; |
| 172 | + if (!empty($this->baseExpression)) { |
| 173 | + $sql .= $this->baseExpression.'('; |
| 174 | + } |
| 175 | + $sql .= NodeFactory::toSql($this->subTree, $dbConnection, $parameters, ' ', false, $indent, $conditionsMode); |
| 176 | + if (!empty($this->baseExpression)) { |
| 177 | + $sql .= ')'; |
| 178 | + } |
| 179 | + |
| 180 | + if ($this->alias) { |
| 181 | + $sql .= ' AS '.$this->alias; |
| 182 | + } |
| 183 | + if ($this->direction) { |
| 184 | + $sql .= ' '.$this->direction; |
| 185 | + } |
| 186 | + |
| 187 | + return $sql; |
| 188 | + } |
| 189 | + |
| 190 | + /** |
| 191 | + * Walks the tree of nodes, calling the visitor passed in parameter. |
| 192 | + * |
| 193 | + * @param VisitorInterface $visitor |
| 194 | + */ |
| 195 | + public function walk(VisitorInterface $visitor) { |
| 196 | + $node = $this; |
| 197 | + $result = $visitor->enterNode($node); |
| 198 | + if ($result instanceof NodeInterface) { |
| 199 | + $node = $result; |
| 200 | + } |
| 201 | + if ($result !== NodeTraverser::DONT_TRAVERSE_CHILDREN) { |
| 202 | + foreach ($this->subTree as $key => $operand) { |
| 203 | + $result2 = $operand->walk($visitor); |
| 204 | + if ($result2 === NodeTraverser::REMOVE_NODE) { |
| 205 | + unset($this->subTree[$key]); |
| 206 | + } elseif ($result2 instanceof NodeInterface) { |
| 207 | + $this->subTree[$key] = $result2; |
| 208 | + } |
| 209 | + } |
| 210 | + } |
| 211 | + return $visitor->leaveNode($node); |
| 212 | + } |
| 213 | +} |
0 commit comments