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

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Query\Expr;
  7. use function strtoupper;
  9. /**
  10.  * Expression class for DQL join.
  11.  *
  12.  * @link    www.doctrine-project.org
  13.  */
  14. class Join
  15. {
  16.     public const INNER_JOIN = 'INNER';
  17.     public const LEFT_JOIN  = 'LEFT';
  19.     public const ON   = 'ON';
  20.     public const WITH = 'WITH';
  22.     /** @var string */
  23.     protected $joinType;
  25.     /** @var string */
  26.     protected $join;
  28.     /** @var string|null */
  29.     protected $alias;
  31.     /** @var string|null */
  32.     protected $conditionType;
  34.     /** @var string|Comparison|Composite|null */
  35.     protected $condition;
  37.     /** @var string|null */
  38.     protected $indexBy;
  40.     /**
  41.      * @param string                           $joinType      The condition type constant. Either INNER_JOIN or LEFT_JOIN.
  42.      * @param string                           $join          The relationship to join.
  43.      * @param string|null                      $alias         The alias of the join.
  44.      * @param string|null                      $conditionType The condition type constant. Either ON or WITH.
  45.      * @param string|Comparison|Composite|null $condition     The condition for the join.
  46.      * @param string|null                      $indexBy       The index for the join.
  47.      */
  48.     public function __construct($joinType, $join, $alias = null, $conditionType = null, $condition = null, $indexBy = null)
  49.     {
  50.         $this->joinType      = $joinType;
  51.         $this->join          = $join;
  52.         $this->alias         = $alias;
  53.         $this->conditionType = $conditionType;
  54.         $this->condition     = $condition;
  55.         $this->indexBy       = $indexBy;
  56.     }
  58.     /**
  59.      * @return string
  60.      */
  61.     public function getJoinType()
  62.     {
  63.         return $this->joinType;
  64.     }
  66.     /**
  67.      * @return string
  68.      */
  69.     public function getJoin()
  70.     {
  71.         return $this->join;
  72.     }
  74.     /**
  75.      * @return string|null
  76.      */
  77.     public function getAlias()
  78.     {
  79.         return $this->alias;
  80.     }
  82.     /**
  83.      * @return string|null
  84.      */
  85.     public function getConditionType()
  86.     {
  87.         return $this->conditionType;
  88.     }
  90.     /**
  91.      * @return string|Comparison|Composite|null
  92.      */
  93.     public function getCondition()
  94.     {
  95.         return $this->condition;
  96.     }
  98.     /**
  99.      * @return string|null
  100.      */
  101.     public function getIndexBy()
  102.     {
  103.         return $this->indexBy;
  104.     }
  106.     /**
  107.      * @return string
  108.      */
  109.     public function __toString()
  110.     {
  111.         return strtoupper($this->joinType) . ' JOIN ' . $this->join
  112.              . ($this->alias ? ' ' . $this->alias : '')
  113.              . ($this->indexBy ? ' INDEX BY ' . $this->indexBy : '')
  114.              . ($this->condition ? ' ' . strtoupper($this->conditionType) . ' ' . $this->condition : '');
  115.     }
  116. }