\Orpheus\SQLRequestSQLRequest

The main SQL Request class

This class handles sql request to the DMBS server.

Summary

Methods

Properties

Constants

__toString()
getClone()
getSQLAdapter()
setSQLAdapter()
setIDField()
from()
output()
getQuery()
escapeIdentifier()
escapeValue()
select()

No public properties found

No constants found

__construct()
set()
get()
sget()
run()

$sqlAdapter
$idField
$class
$parameters

N/A

No private methods found

No private properties found

N/A

abstract

File: orpheus-sqladapter\src\SQLRequest\SQLRequest.php
Package: Default
Class hierarchy: \Orpheus\SQLRequest\SQLRequest

Properties

$sqlAdapter

$sqlAdapter : \Orpheus\SQLAdapter\SQLAdapter

The SQL Adapter

Type

\Orpheus\SQLAdapter\SQLAdapter

$idField

$idField : string

The ID field

Type

string

$class

$class : string

The class

Type

string

$parameters

$parameters : array<mixed,string>

The SQL Query Parameters

Type

array<mixed,string>

Methods

__toString()

__toString() : string

Get object as string

Returns

string

getClone()

getClone(string  $withParameters = true) : \Orpheus\SQLRequest\SQLRequest

Get a clone of current request

Parameters

string

$withParameters

True to also copy parameters, default to true

Returns

\Orpheus\SQLRequest\SQLRequest

getSQLAdapter()

getSQLAdapter() : \Orpheus\SQLAdapter\SQLAdapter

Get the SQL Adapter

Returns

\Orpheus\SQLAdapter\SQLAdapter

setSQLAdapter()

setSQLAdapter(\Orpheus\SQLAdapter\SQLAdapter  $sqlAdapter)

Set the SQL Adapter

Parameters

\Orpheus\SQLAdapter\SQLAdapter

$sqlAdapter

setIDField()

setIDField(string  $idField)

Set the ID field

Parameters

string

$idField

from()

from(string  $table = null) : mixed|\Orpheus\SQLRequest\SQLRequest

Set/Get the table parameter

Parameters

string

$table

Returns

mixed|\Orpheus\SQLRequest\SQLRequest

output()

output(string  $output = null) : mixed|\Orpheus\SQLRequest\SQLRequest

Set/Get the ouput parameter

Parameters

string

$output

Returns

mixed|\Orpheus\SQLRequest\SQLRequest

getQuery()

getQuery() : string

Get the query as string

Throws

\Orpheus\SQLRequest\Exception

Returns

string

escapeIdentifier()

escapeIdentifier(string  $identifier) : string

Escape an SQL identifier using SQL Adapter

Parameters

string

$identifier

Returns

string

escapeValue()

escapeValue(string  $value) : string

Escape an SQL value using SQL Adapter

Parameters

string

$value

Returns

string

select()

select(\Orpheus\SQLAdapter\SQLAdapter  $sqlAdapter = null, string  $idField = 'id', string  $class = null) : \Orpheus\SQLRequest\SQLSelectRequest

Create a select request

Parameters

\Orpheus\SQLAdapter\SQLAdapter	$sqlAdapter
string	$idField	The ID field
string	$class	The class used to instanciate entries

Returns

\Orpheus\SQLRequest\SQLSelectRequest

__construct()

__construct(\Orpheus\SQLAdapter\SQLAdapter  $sqlAdapter, string  $idField, string  $class = null)

Constructor

Parameters

\Orpheus\SQLAdapter\SQLAdapter	$sqlAdapter
string	$idField
string	$class

set()

set(string  $parameter, mixed  $value) : \Orpheus\SQLRequest\SQLRequest

Set a parameter for this query

Parameters

string	$parameter
mixed	$value

Returns

\Orpheus\SQLRequest\SQLRequest

get()

get(string  $parameter, mixed  $default = null) : mixed

Get a parameter for this query

Parameters

string	$parameter
mixed	$default

Returns

mixed

sget()

sget(string  $parameter, mixed  $value = null) : mixed

Set/Get a parameter for this query

Parameters

string	$parameter
mixed	$value

Returns

mixed —

If there is a value (non-null), we set it or we get it

run()

run()

Run the query and return results