Documentation

CustomGroupJoinable extends Joinable
in package

Table of Contents

Constants

JOIN_SIDE_INNER  = 'INNER'
JOIN_SIDE_LEFT  = 'LEFT'
JOIN_TYPE_MANY_TO_ONE  = 'n_to_1'
JOIN_TYPE_ONE_TO_MANY  = '1_to_n'
JOIN_TYPE_ONE_TO_ONE  = '1_to_1'

Properties

$alias  : string
$baseColumn  : string
$baseTable  : string
$columns  : string
$conditions  : array<string|int, string>
$deprecatedBy  : bool
$entity  : string
$joinSide  : string
$joinType  : int
$serialize  : int
$targetColumn  : string
$targetTable  : string

Methods

__construct()  : mixed
addCondition()  : $this
getAlias()  : string
getBaseColumn()  : string
getBaseTable()  : string
getConditionsForJoin()  : array<string|int, mixed>
Gets conditions required when joining to a base table
getEntity()  : string|null
getEntityFields()  : array<string|int, mixed>
getJoinSide()  : string
getJoinType()  : int
getSerialize()  : int|null
getTargetColumn()  : string
getTargetTable()  : string
isDeprecatedBy()  : bool
setAlias()  : $this
setBaseColumn()  : $this
setBaseTable()  : $this
setConditions()  : $this
setDeprecatedBy()  : $this
setJoinSide()  : $this
setJoinType()  : $this
setSerialize()  : $this
toArray()  : array<string|int, mixed>
addExtraJoinConditions()  : void

Constants

JOIN_SIDE_INNER

public mixed JOIN_SIDE_INNER = 'INNER'

JOIN_SIDE_LEFT

public mixed JOIN_SIDE_LEFT = 'LEFT'

JOIN_TYPE_MANY_TO_ONE

public mixed JOIN_TYPE_MANY_TO_ONE = 'n_to_1'

JOIN_TYPE_ONE_TO_MANY

public mixed JOIN_TYPE_ONE_TO_MANY = '1_to_n'

JOIN_TYPE_ONE_TO_ONE

public mixed JOIN_TYPE_ONE_TO_ONE = '1_to_1'

Properties

$baseColumn

protected string $baseColumn

$conditions

protected array<string|int, string> $conditions = []

$deprecatedBy

protected bool $deprecatedBy = FALSE

$joinType

protected int $joinType = self::JOIN_TYPE_ONE_TO_ONE

$targetColumn

protected string $targetColumn

Name (or alias) of the target column)

$targetTable

protected string $targetTable

Methods

__construct()

public __construct(mixed $targetTable, mixed $alias, bool $isMultiRecord, string $entityName) : mixed
Parameters
$targetTable : mixed
$alias : mixed
$isMultiRecord : bool
$entityName : string

addCondition()

public addCondition(string $condition) : $this
Parameters
$condition : string
Return values
$this

getAlias()

public getAlias() : string
Return values
string

getBaseColumn()

public getBaseColumn() : string
Return values
string

getBaseTable()

public getBaseTable() : string
Return values
string

getConditionsForJoin()

Gets conditions required when joining to a base table

public getConditionsForJoin(string $baseTableAlias, string $targetTableAlias, array<string|int, mixed>|null $openJoin) : array<string|int, mixed>
Parameters
$baseTableAlias : string
$targetTableAlias : string
$openJoin : array<string|int, mixed>|null
Return values
array<string|int, mixed>

getEntityFields()

public getEntityFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getJoinSide()

public getJoinSide() : string
Return values
string

getJoinType()

public getJoinType() : int
Return values
int

getSerialize()

public getSerialize() : int|null
Return values
int|null

getTargetColumn()

public getTargetColumn() : string
Return values
string

getTargetTable()

public getTargetTable() : string
Return values
string

isDeprecatedBy()

public isDeprecatedBy() : bool
Return values
bool

setAlias()

public setAlias(string $alias) : $this
Parameters
$alias : string
Return values
$this

setBaseColumn()

public setBaseColumn(string $baseColumn) : $this
Parameters
$baseColumn : string
Return values
$this

setBaseTable()

public setBaseTable(string $baseTable) : $this
Parameters
$baseTable : string
Return values
$this

setConditions()

public setConditions(array<string|int, string> $conditions) : $this
Parameters
$conditions : array<string|int, string>
Return values
$this

setDeprecatedBy()

public setDeprecatedBy([string|null $deprecatedBy = NULL ]) : $this
Parameters
$deprecatedBy : string|null = NULL
Return values
$this

setJoinSide()

public setJoinSide(string $joinSide) : $this
Parameters
$joinSide : string
Return values
$this

setJoinType()

public setJoinType(int $joinType) : $this
Parameters
$joinType : int
Return values
$this

setSerialize()

public setSerialize(int|null $serialize) : $this
Parameters
$serialize : int|null
Return values
$this

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

addExtraJoinConditions()

protected addExtraJoinConditions(mixed &$conditions, string $baseTableAlias, string $targetTableAlias) : void
Parameters
$conditions : mixed
$baseTableAlias : string
$targetTableAlias : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results