Documentation

selectParams
in package
implements Stringable

IP-Listen Objekt

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Interfaces, Classes, Traits and Enums

Stringable

Table of Contents

$distinct  : bool
SELECT DISTINCT flag
$fetchAll  : bool
Fetch all mode
$fetchStyle  : int
Fetch style
$item  : string
Select item string
$join  : string
JOIN clause
$params  : array<string|int, mixed>
Select params
$returnResult  : bool
Return raw result flag
$table  : string
Database table name
$where  : string
Where clause
__construct()  : mixed
Constructor method, as of FPCM 4.1 the destination table(s) can be set directly
__toString()  : string
Magic toString function
getDistinct()  : bool
return Distinct select mode
getFetchAll()  : bool
Returns fetch mode
getFetchStyle()  : int
Returns fetch style
getItem()  : string
Returns items
getJoin()  : string
Returns join clause
getParams()  : array<string|int, mixed>
Return select params
getQuery()  : string
Return query string
getReturnResult()  : bool
Returns mode of result return
getTable()  : string|array<string|int, mixed>
Returns database name(s)
getWhere()  : string
Returns where clause
setDistinct()  : $this
Set distinct select mode
setFetchAll()  : $this
Set fetch mode to all or single mode
setFetchStyle()  : $this
Set fetch style
setItem()  : $this
Set select items
setJoin()  : $this
Set JOIN clause
setParams()  : $this
Set select data params for where clause
setReturnResult()  : $this
Set return of raw result
setTable()  : $this
Set database table name(s)
setWhere()  : $this
Set Where clause

Properties

$distinct

SELECT DISTINCT flag

private bool $distinct = false

$fetchStyle

Fetch style

private int $fetchStyle = 5
Tags
since
4.2.1

$params

Select params

private array<string|int, mixed> $params = []

$returnResult

Return raw result flag

private bool $returnResult = false

Methods

__construct()

Constructor method, as of FPCM 4.1 the destination table(s) can be set directly

public __construct([string|array<string|int, mixed> $table = '' ]) : mixed
Parameters
$table : string|array<string|int, mixed> = ''

(@since 4.1)

Return values
mixed

__toString()

Magic toString function

public __toString() : string
Tags
since
4.5-b8
Return values
string

getDistinct()

return Distinct select mode

public getDistinct() : bool
Return values
bool

getFetchAll()

Returns fetch mode

public getFetchAll() : bool
Return values
bool

getFetchStyle()

Returns fetch style

public getFetchStyle() : int
Tags
since
4.2.1
Return values
int

getItem()

Returns items

public getItem() : string
Return values
string

getJoin()

Returns join clause

public getJoin() : string
Return values
string

getParams()

Return select params

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

getQuery()

Return query string

public final getQuery() : string
Tags
since
4.5
Return values
string

getReturnResult()

Returns mode of result return

public getReturnResult() : bool
Return values
bool

getTable()

Returns database name(s)

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

getWhere()

Returns where clause

public getWhere() : string
Return values
string

setDistinct()

Set distinct select mode

public setDistinct(bool $distinct) : $this
Parameters
$distinct : bool
Return values
$this

setFetchAll()

Set fetch mode to all or single mode

public setFetchAll(bool $fetchAll) : $this
Parameters
$fetchAll : bool
Return values
$this

setFetchStyle()

Set fetch style

public setFetchStyle(int $fetchStyle) : $this
Parameters
$fetchStyle : int
Tags
since
4.2.1
Return values
$this

setItem()

Set select items

public setItem(string $item) : $this
Parameters
$item : string
Return values
$this

setJoin()

Set JOIN clause

public setJoin(string $join) : $this
Parameters
$join : string
Return values
$this

setParams()

Set select data params for where clause

public setParams(array<string|int, mixed> $params) : $this
Parameters
$params : array<string|int, mixed>
Return values
$this

setReturnResult()

Set return of raw result

public setReturnResult(bool $returnResult) : $this
Parameters
$returnResult : bool
Return values
$this

setTable()

Set database table name(s)

public setTable(string|array<string|int, mixed> $table) : $this
Parameters
$table : string|array<string|int, mixed>
Return values
$this

setWhere()

Set Where clause

public setWhere(string $where) : $this
Parameters
$where : string
Return values
$this

Search results