CompositeExpression.php 3.52 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?php
/*
 * 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
Benjamin Eberlei's avatar
Benjamin Eberlei committed
16
 * and is licensed under the MIT license. For more information, see
17 18 19 20 21 22 23 24
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\DBAL\Query\Expression;

/**
 * Composite expression is responsible to build a group of similar expression.
 *
Benjamin Morel's avatar
Benjamin Morel committed
25 26 27 28
 * @link   www.doctrine-project.org
 * @since  2.1
 * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author Benjamin Eberlei <kontakt@beberlei.de>
29 30 31 32
 */
class CompositeExpression implements \Countable
{
    /**
Benjamin Morel's avatar
Benjamin Morel committed
33
     * Constant that represents an AND composite expression.
34 35
     */
    const TYPE_AND = 'AND';
36

37
    /**
Benjamin Morel's avatar
Benjamin Morel committed
38
     * Constant that represents an OR composite expression.
39 40
     */
    const TYPE_OR  = 'OR';
41

42
    /**
Benjamin Morel's avatar
Benjamin Morel committed
43 44 45
     * The instance type of composite expression.
     *
     * @var string
46 47
     */
    private $type;
48

49
    /**
Benjamin Morel's avatar
Benjamin Morel committed
50 51 52
     * Each expression part of the composite expression.
     *
     * @var array
53
     */
54
    private $parts = [];
55

56 57
    /**
     * Constructor.
58
     *
Benjamin Morel's avatar
Benjamin Morel committed
59 60
     * @param string $type  Instance type of composite expression.
     * @param array  $parts Composition of expressions to be joined on composite expression.
61
     */
62
    public function __construct($type, array $parts = [])
63 64
    {
        $this->type = $type;
65

66 67
        $this->addMultiple($parts);
    }
68

69 70
    /**
     * Adds multiple parts to composite expression.
71
     *
72
     * @param array $parts
73
     *
Benjamin Morel's avatar
Benjamin Morel committed
74
     * @return \Doctrine\DBAL\Query\Expression\CompositeExpression
75
     */
76
    public function addMultiple(array $parts = [])
77 78 79 80
    {
        foreach ((array) $parts as $part) {
            $this->add($part);
        }
81

82 83
        return $this;
    }
84

85 86
    /**
     * Adds an expression to composite expression.
87
     *
88
     * @param mixed $part
Benjamin Morel's avatar
Benjamin Morel committed
89 90
     *
     * @return \Doctrine\DBAL\Query\Expression\CompositeExpression
91 92 93
     */
    public function add($part)
    {
94 95
        if (empty($part)) {
            return $this;
96
        }
97

98 99 100 101 102 103
        if ($part instanceof self && 0 === count($part)) {
            return $this;
        }

        $this->parts[] = $part;

104 105
        return $this;
    }
106

107 108
    /**
     * Retrieves the amount of expressions on composite expression.
109 110
     *
     * @return integer
111 112 113 114 115
     */
    public function count()
    {
        return count($this->parts);
    }
116

117
    /**
Benjamin Morel's avatar
Benjamin Morel committed
118
     * Retrieves the string representation of this composite expression.
119
     *
120 121 122 123
     * @return string
     */
    public function __toString()
    {
124
        if ($this->count() === 1) {
125 126
            return (string) $this->parts[0];
        }
127

128 129
        return '(' . implode(') ' . $this->type . ' (', $this->parts) . ')';
    }
130

131
    /**
Benjamin Morel's avatar
Benjamin Morel committed
132
     * Returns the type of this composite expression (AND/OR).
133
     *
134 135 136 137 138 139
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }
Benjamin Eberlei's avatar
Benjamin Eberlei committed
140
}