tflori/orm

just another orm...

View the Project on GitHub tflori/orm

Build Status Test Coverage Maintainability Latest Stable Version Total Downloads

» API Reference » ORM\QueryBuilder\MakesJoins

ORM\QueryBuilder\MakesJoins

Table of Contents

Abstract

Methods

ORM\QueryBuilder\MakesJoins::fullJoin

public function fullJoin(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface
Full (outer) join $tableName with $options

When no expression got provided self get returned. If you want to get a parenthesis the parameter empty can be set to false.

ATTENTION: here the default value of empty got changed - defaults to yes

Returns $this|ORM\QueryBuilder\ParenthesisInterface  
Parameters
Parameter Type Description  
$tableName string Table to join  
$expression **string bool** Expression, single column name or boolean to create an empty join
$alias string Alias for the table  
$args array Arguments for expression  

ORM\QueryBuilder\MakesJoins::fullJoin

↑ top

ORM\QueryBuilder\MakesJoins::join

public function join(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface
(Inner) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Returns $this|ORM\QueryBuilder\ParenthesisInterface  
Parameters
Parameter Type Description  
$tableName string Table to join  
$expression **string bool** Expression, single column name or boolean to create an empty join
$alias string Alias for the table  
$args array Arguments for expression  

ORM\QueryBuilder\MakesJoins::join

↑ top

ORM\QueryBuilder\MakesJoins::leftJoin

public function leftJoin(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface
Left (outer) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Returns $this|ORM\QueryBuilder\ParenthesisInterface  
Parameters
Parameter Type Description  
$tableName string Table to join  
$expression **string bool** Expression, single column name or boolean to create an empty join
$alias string Alias for the table  
$args array Arguments for expression  

ORM\QueryBuilder\MakesJoins::leftJoin

↑ top

ORM\QueryBuilder\MakesJoins::rightJoin

public function rightJoin(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface
Right (outer) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Returns $this|ORM\QueryBuilder\ParenthesisInterface  
Parameters
Parameter Type Description  
$tableName string Table to join  
$expression **string bool** Expression, single column name or boolean to create an empty join
$alias string Alias for the table  
$args array Arguments for expression  

ORM\QueryBuilder\MakesJoins::rightJoin

↑ top