Documentation

Join
in package

Expression class for DQL join.

Tags
link
www.doctrine-project.org

Table of Contents

Constants

INNER_JOIN  = 'INNER'
LEFT_JOIN  = 'LEFT'
ON  = 'ON'
WITH  = 'WITH'

Properties

$alias  : string|null
$condition  : string|Comparison|Composite|Func|null
$conditionType  : string|null
$indexBy  : string|null
$join  : string
$joinType  : string

Methods

__construct()  : mixed
__toString()  : string
getAlias()  : string|null
getCondition()  : string|Comparison|Composite|Func|null
getConditionType()  : string|null
getIndexBy()  : string|null
getJoin()  : string
getJoinType()  : string

Constants

INNER_JOIN

public mixed INNER_JOIN = 'INNER'

LEFT_JOIN

public mixed LEFT_JOIN = 'LEFT'

ON

public mixed ON = 'ON'

WITH

public mixed WITH = 'WITH'

Properties

$alias

protected string|null $alias

$conditionType

protected string|null $conditionType
Tags
psalm-var

self::ON|self::WITH|null

$indexBy

protected string|null $indexBy

$join

protected string $join

$joinType

protected string $joinType
Tags
psalm-var

self::INNER_JOIN|self::LEFT_JOIN

Methods

__construct()

public __construct(string $joinType, string $join[, string|null $alias = null ][, string|null $conditionType = null ][, string|Comparison|Composite|Func|null $condition = null ][, string|null $indexBy = null ]) : mixed
Parameters
$joinType : string

The condition type constant. Either INNER_JOIN or LEFT_JOIN.

$join : string

The relationship to join.

$alias : string|null = null

The alias of the join.

$conditionType : string|null = null

The condition type constant. Either ON or WITH.

$condition : string|Comparison|Composite|Func|null = null

The condition for the join.

$indexBy : string|null = null

The index for the join.

Tags
psalm-param

self::INNER_JOIN|self::LEFT_JOIN $joinType

psalm-param

self::ON|self::WITH|null $conditionType

__toString()

public __toString() : string
Return values
string

getAlias()

public getAlias() : string|null
Return values
string|null

getConditionType()

public getConditionType() : string|null
Tags
psalm-return

self::ON|self::WITH|null

Return values
string|null

getIndexBy()

public getIndexBy() : string|null
Return values
string|null

getJoin()

public getJoin() : string
Return values
string

getJoinType()

public getJoinType() : string
Tags
psalm-return

self::INNER_JOIN|self::LEFT_JOIN

Return values
string

        
On this page

Search results