Base.php 2.7KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <?php
  2. /*
  3. * $Id$
  4. *
  5. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  6. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  7. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  8. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  9. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16. *
  17. * This software consists of voluntary contributions made by many individuals
  18. * and is licensed under the LGPL. For more information, see
  19. * <http://www.doctrine-project.org>.
  20. */
  21. namespace Doctrine\ORM\Query\Expr;
  22. /**
  23. * Abstract base Expr class for building DQL parts
  24. *
  25. * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
  26. * @link www.doctrine-project.org
  27. * @since 2.0
  28. * @version $Revision$
  29. * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
  30. * @author Jonathan Wage <jonwage@gmail.com>
  31. * @author Roman Borschel <roman@code-factory.org>
  32. */
  33. abstract class Base
  34. {
  35. protected $_preSeparator = '(';
  36. protected $_separator = ', ';
  37. protected $_postSeparator = ')';
  38. protected $_allowedClasses = array();
  39. protected $_parts = array();
  40. public function __construct($args = array())
  41. {
  42. $this->addMultiple($args);
  43. }
  44. public function addMultiple($args = array())
  45. {
  46. foreach ((array) $args as $arg) {
  47. $this->add($arg);
  48. }
  49. }
  50. public function add($arg)
  51. {
  52. if ( $arg !== null || ($arg instanceof self && $arg->count() > 0)) {
  53. // If we decide to keep Expr\Base instances, we can use this check
  54. if ( ! is_string($arg)) {
  55. $class = get_class($arg);
  56. if ( ! in_array($class, $this->_allowedClasses)) {
  57. throw new \InvalidArgumentException("Expression of type '$class' not allowed in this context.");
  58. }
  59. }
  60. $this->_parts[] = $arg;
  61. }
  62. }
  63. public function count()
  64. {
  65. return count($this->_parts);
  66. }
  67. public function __toString()
  68. {
  69. if ($this->count() == 1) {
  70. return (string) $this->_parts[0];
  71. }
  72. return $this->_preSeparator . implode($this->_separator, $this->_parts) . $this->_postSeparator;
  73. }
  74. }