Documentation

Join
in package

Join class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
6.5.0

Table of Contents

Properties

$allowedJoins  : array<string|int, mixed>
Allowed JOIN keywords
$columns  : array<string|int, mixed>
Columns
$foreignTable  : string|null
Foreign table
$join  : string
Join type
$sql  : AbstractSql|null
SQL object

Methods

__construct()  : mixed
Constructor
__toString()  : string
Return JOIN as string
getColumns()  : array<string|int, mixed>
Get columns
getForeignTable()  : string
Get foreign table
getJoin()  : string
Get JOIN type
render()  : string
Render JOIN

Properties

$allowedJoins

Allowed JOIN keywords

protected static array<string|int, mixed> $allowedJoins = ['JOIN', 'LEFT JOIN', 'RIGHT JOIN', 'FULL JOIN', 'OUTER JOIN', 'LEFT OUTER JOIN', 'RIGHT OUTER JOIN', 'FULL OUTER JOIN', 'INNER JOIN', 'LEFT INNER JOIN', 'RIGHT INNER JOIN', 'FULL INNER JOIN']

$columns

Columns

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

$foreignTable

Foreign table

protected string|null $foreignTable = null

$join

Join type

protected string $join = 'JOIN'

Methods

__construct()

Constructor

public __construct(AbstractSql $sql, mixed $foreignTable, array<string|int, mixed> $columns[, string $join = 'JOIN' ]) : mixed

Instantiate the JOIN object

Parameters
$sql : AbstractSql
$foreignTable : mixed
$columns : array<string|int, mixed>
$join : string = 'JOIN'
Tags
throws
Exception

__toString()

Return JOIN as string

public __toString() : string
Return values
string

getColumns()

Get columns

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

getForeignTable()

Get foreign table

public getForeignTable() : string
Return values
string

getJoin()

Get JOIN type

public getJoin() : string
Return values
string

render()

Render JOIN

public render() : string
Return values
string

        
On this page

Search results