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.
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>.
20 namespace Doctrine\Common\Collections\Expr;
23 * Walks an expression graph and turns it into a PHP closure.
25 * This closure can be used with {@Collection#filter()} and is used internally
26 * by {@ArrayCollection#select()}.
28 * @author Benjamin Eberlei <kontakt@beberlei.de>
31 class ClosureExpressionVisitor extends ExpressionVisitor
34 * Accesses the field of a given object. This field has to be public
35 * directly or indirectly (through an accessor get*, is*, or a magic
36 * method, __get, __call).
38 * @param object $object
39 * @param string $field
43 public static function getObjectFieldValue($object, $field)
45 if (is_array($object)) {
46 return $object[$field];
49 $accessors = array('get', 'is');
51 foreach ($accessors as $accessor) {
54 if ( ! method_exists($object, $accessor)) {
58 return $object->$accessor();
61 // __call should be triggered for get.
62 $accessor = $accessors[0] . $field;
64 if (method_exists($object, '__call')) {
65 return $object->$accessor();
68 if ($object instanceof \ArrayAccess) {
69 return $object[$field];
72 return $object->$field;
76 * Helper for sorting arrays of objects based on multiple fields + orientations.
79 * @param int $orientation
80 * @param \Closure $next
84 public static function sortByField($name, $orientation = 1, \Closure $next = null)
92 return function ($a, $b) use ($name, $next, $orientation) {
93 $aValue = ClosureExpressionVisitor::getObjectFieldValue($a, $name);
94 $bValue = ClosureExpressionVisitor::getObjectFieldValue($b, $name);
96 if ($aValue === $bValue) {
100 return (($aValue > $bValue) ? 1 : -1) * $orientation;
107 public function walkComparison(Comparison $comparison)
109 $field = $comparison->getField();
110 $value = $comparison->getValue()->getValue(); // shortcut for walkValue()
112 switch ($comparison->getOperator()) {
114 return function ($object) use ($field, $value) {
115 return ClosureExpressionVisitor::getObjectFieldValue($object, $field) === $value;
118 case Comparison::NEQ:
119 return function ($object) use ($field, $value) {
120 return ClosureExpressionVisitor::getObjectFieldValue($object, $field) !== $value;
124 return function ($object) use ($field, $value) {
125 return ClosureExpressionVisitor::getObjectFieldValue($object, $field) < $value;
128 case Comparison::LTE:
129 return function ($object) use ($field, $value) {
130 return ClosureExpressionVisitor::getObjectFieldValue($object, $field) <= $value;
134 return function ($object) use ($field, $value) {
135 return ClosureExpressionVisitor::getObjectFieldValue($object, $field) > $value;
138 case Comparison::GTE:
139 return function ($object) use ($field, $value) {
140 return ClosureExpressionVisitor::getObjectFieldValue($object, $field) >= $value;
144 return function ($object) use ($field, $value) {
145 return in_array(ClosureExpressionVisitor::getObjectFieldValue($object, $field), $value);
148 case Comparison::NIN:
149 return function ($object) use ($field, $value) {
150 return ! in_array(ClosureExpressionVisitor::getObjectFieldValue($object, $field), $value);
153 case Comparison::CONTAINS:
154 return function ($object) use ($field, $value) {
155 return false !== strpos(ClosureExpressionVisitor::getObjectFieldValue($object, $field), $value);
159 throw new \RuntimeException("Unknown comparison operator: " . $comparison->getOperator());
166 public function walkValue(Value $value)
168 return $value->getValue();
174 public function walkCompositeExpression(CompositeExpression $expr)
176 $expressionList = array();
178 foreach ($expr->getExpressionList() as $child) {
179 $expressionList[] = $this->dispatch($child);
182 switch($expr->getType()) {
183 case CompositeExpression::TYPE_AND:
184 return $this->andExpressions($expressionList);
186 case CompositeExpression::TYPE_OR:
187 return $this->orExpressions($expressionList);
190 throw new \RuntimeException("Unknown composite " . $expr->getType());
195 * @param array $expressions
199 private function andExpressions($expressions)
201 return function ($object) use ($expressions) {
202 foreach ($expressions as $expression) {
203 if ( ! $expression($object)) {
212 * @param array $expressions
216 private function orExpressions($expressions)
218 return function ($object) use ($expressions) {
219 foreach ($expressions as $expression) {
220 if ($expression($object)) {