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

  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.     /**
  23.      * @var string
  24.      * @psalm-var self::INNER_JOIN|self::LEFT_JOIN
  25.      */
  26.     protected $joinType;
  28.     /** @var string */
  29.     protected $join;
  31.     /** @var string|null */
  32.     protected $alias;
  34.     /**
  35.      * @var string|null
  36.      * @psalm-var self::ON|self::WITH|null
  37.      */
  38.     protected $conditionType;
  40.     /** @var string|Comparison|Composite|Func|null */
  41.     protected $condition;
  43.     /** @var string|null */
  44.     protected $indexBy;
  46.     /**
  47.      * @param string                                $joinType      The condition type constant. Either INNER_JOIN or LEFT_JOIN.
  48.      * @param string                                $join          The relationship to join.
  49.      * @param string|null                           $alias         The alias of the join.
  50.      * @param string|null                           $conditionType The condition type constant. Either ON or WITH.
  51.      * @param string|Comparison|Composite|Func|null $condition     The condition for the join.
  52.      * @param string|null                           $indexBy       The index for the join.
  53.      * @psalm-param self::INNER_JOIN|self::LEFT_JOIN $joinType
  54.      * @psalm-param self::ON|self::WITH|null $conditionType
  55.      */
  56.     public function __construct($joinType, $join, $alias = null, $conditionType = null, $condition = null, $indexBy = null)
  57.     {
  58.         $this->joinType      = $joinType;
  59.         $this->join          = $join;
  60.         $this->alias         = $alias;
  61.         $this->conditionType = $conditionType;
  62.         $this->condition     = $condition;
  63.         $this->indexBy       = $indexBy;
  64.     }
  66.     /**
  67.      * @return string
  68.      * @psalm-return self::INNER_JOIN|self::LEFT_JOIN
  69.      */
  70.     public function getJoinType()
  71.     {
  72.         return $this->joinType;
  73.     }
  75.     /** @return string */
  76.     public function getJoin()
  77.     {
  78.         return $this->join;
  79.     }
  81.     /** @return string|null */
  82.     public function getAlias()
  83.     {
  84.         return $this->alias;
  85.     }
  87.     /**
  88.      * @return string|null
  89.      * @psalm-return self::ON|self::WITH|null
  90.      */
  91.     public function getConditionType()
  92.     {
  93.         return $this->conditionType;
  94.     }
  96.     /** @return string|Comparison|Composite|Func|null */
  97.     public function getCondition()
  98.     {
  99.         return $this->condition;
  100.     }
  102.     /** @return string|null */
  103.     public function getIndexBy()
  104.     {
  105.         return $this->indexBy;
  106.     }
  108.     /** @return string */
  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. }