vendor/doctrine/orm/lib/Doctrine/ORM/Query/Expr/Join.php line 31

Open in your IDE?
  1. <?php
  2. /*
  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.
  14.  *
  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>.
  18.  */
  20. namespace Doctrine\ORM\Query\Expr;
  22. /**
  23.  * Expression class for DQL join.
  24.  *
  25.  * @link    www.doctrine-project.org
  26.  * @since   2.0
  27.  * @author  Guilherme Blanco <[email protected]>
  28.  * @author  Jonathan Wage <[email protected]>
  29.  * @author  Roman Borschel <[email protected]>
  30.  */
  31. class Join
  32. {
  33.     const INNER_JOIN    = 'INNER';
  34.     const LEFT_JOIN     = 'LEFT';
  36.     const ON            = 'ON';
  37.     const WITH          = 'WITH';
  39.     /**
  40.      * @var string
  41.      */
  42.     protected $joinType;
  44.     /**
  45.      * @var string
  46.      */
  47.     protected $join;
  49.     /**
  50.      * @var string
  51.      */
  52.     protected $alias;
  54.     /**
  55.      * @var string
  56.      */
  57.     protected $conditionType;
  59.     /**
  60.      * @var string
  61.      */
  62.     protected $condition;
  64.     /**
  65.      * @var string
  66.      */
  67.     protected $indexBy;
  69.     /**
  70.      * @param string      $joinType      The condition type constant. Either INNER_JOIN or LEFT_JOIN.
  71.      * @param string      $join          The relationship to join.
  72.      * @param string|null $alias         The alias of the join.
  73.      * @param string|null $conditionType The condition type constant. Either ON or WITH.
  74.      * @param string|null $condition     The condition for the join.
  75.      * @param string|null $indexBy       The index for the join.
  76.      */
  77.     public function __construct($joinType, $join, $alias = null, $conditionType = null, $condition = null, $indexBy = null)
  78.     {
  79.         $this->joinType       = $joinType;
  80.         $this->join           = $join;
  81.         $this->alias          = $alias;
  82.         $this->conditionType  = $conditionType;
  83.         $this->condition      = $condition;
  84.         $this->indexBy        = $indexBy;
  85.     }
  87.     /**
  88.      * @return string 
  89.      */
  90.     public function getJoinType()
  91.     {
  92.         return $this->joinType;
  93.     }
  95.     /**
  96.      * @return string
  97.      */
  98.     public function getJoin()
  99.     {
  100.         return $this->join;
  101.     }
  103.     /**
  104.      * @return string
  105.      */
  106.     public function getAlias()
  107.     {
  108.         return $this->alias;
  109.     }
  111.     /**
  112.      * @return string
  113.      */
  114.     public function getConditionType()
  115.     {
  116.         return $this->conditionType;
  117.     }
  119.     /**
  120.      * @return string
  121.      */
  122.     public function getCondition()
  123.     {
  124.         return $this->condition;
  125.     }
  127.     /**
  128.      * @return string
  129.      */
  130.     public function getIndexBy()
  131.     {
  132.         return $this->indexBy;
  133.     }
  135.     /**
  136.      * @return string
  137.      */
  138.     public function __toString()
  139.     {
  140.         return strtoupper($this->joinType) . ' JOIN ' . $this->join
  141.              . ($this->alias ? ' ' . $this->alias : '')
  142.              . ($this->indexBy ? ' INDEX BY ' . $this->indexBy : '')
  143.              . ($this->condition ? ' ' . strtoupper($this->conditionType) . ' ' . $this->condition : '');
  144.     }
  145. }