Orpheus

SqlUpdateRequest extends AbstractSqlRequest
in package
Uses FieldListFacet, WhereFacet

The main SQL Update Request class

This class handles sql UPDATE request to the DBMS server.

Table of Contents

Properties

$class  : string|null
The class
$idField  : string
The ID field
$parameters  : array<string|int, string>
The SQL Query Parameters
$sqlAdapter  : AbstractSqlAdapter
The SQL Adapter

Methods

__construct()  : mixed
Constructor
__toString()  : string
Get object as string
escapeIdentifier()  : string
Escape an SQL identifier using SQL Adapter
escapeValue()  : string
Escape an SQL value using SQL Adapter
fields()  : mixed|$this
Set/Get the field list to get
formatCondition()  : string
from()  : static|string
Set/Get the table parameter
fromOffset()  : mixed|$this
Set/Get the offset from which we are getting results
getClone()  : static
Get a clone of current request
getEntityName()  : string
Get the name to use in SQL Query
getIdField()  : string
get the ID field
getQuery()  : string
Get the query as string
getSqlAdapter()  : AbstractSqlAdapter
Get the SQL Adapter
maxRows()  : mixed|SqlSelectRequest
Set/Get the number of expected result (as limit)
number()  : mixed|SqlSelectRequest
Set/Get the number of expected result (as limit)
orderBy()  : mixed|static
Set/Get the order by filter
output()  : mixed
Set/Get the output parameter
run()  : string|int
Run the query and return results
setSqlAdapter()  : static
Set the SQL Adapter
where()  : static
Set the where clause
get()  : mixed
Get a parameter for this query
set()  : static
Set a parameter for this query
sget()  : mixed
Set/Get a parameter for this query If there is a value (non-null), we set it, or we get it

Properties

$parameters

The SQL Query Parameters

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

Methods

__toString()

Get object as string

public __toString() : string
Tags
throws
Exception
Return values
string

escapeIdentifier()

Escape an SQL identifier using SQL Adapter

public escapeIdentifier(string $identifier) : string
Parameters
$identifier : string
Return values
string

escapeValue()

Escape an SQL value using SQL Adapter

public escapeValue(mixed $value) : string
Parameters
$value : mixed
Return values
string

fields()

Set/Get the field list to get

public fields([array<string|int, mixed>|null $fields = null ]) : mixed|$this
Parameters
$fields : array<string|int, mixed>|null = null

List of fields and values

Return values
mixed|$this

formatCondition()

public formatCondition(array<string|int, mixed>|string $condition, string|mixed|null $operator, mixed|null $value[, bool $escapeValue = true ]) : string
Parameters
$condition : array<string|int, mixed>|string

The condition or the field

$operator : string|mixed|null

Value or operator

$value : mixed|null

The value to use

$escapeValue : bool = true

Should the value be escaped ?

Return values
string

from()

Set/Get the table parameter

public from([string|null $table = null ]) : static|string
Parameters
$table : string|null = null
Return values
static|string

fromOffset()

Set/Get the offset from which we are getting results

public fromOffset([int|null $offset = null ]) : mixed|$this
Parameters
$offset : int|null = null
Return values
mixed|$this

getClone()

Get a clone of current request

public getClone([bool $withParameters = true ]) : static
Parameters
$withParameters : bool = true

True to also copy parameters, default to true

Return values
static

getEntityName()

Get the name to use in SQL Query

public getEntityName() : string
Return values
string

getIdField()

get the ID field

public getIdField() : string
Return values
string

getQuery()

Get the query as string

public getQuery() : string
Return values
string

orderBy()

Set/Get the order by filter

public orderBy([string|null $fields = null ]) : mixed|static
Parameters
$fields : string|null = null
Return values
mixed|static

output()

Set/Get the output parameter

public output([string|null $output = null ]) : mixed
Parameters
$output : string|null = null

run()

Run the query and return results

public run() : string|int
Return values
string|int

where()

Set the where clause

public where(array<string|int, mixed>|string $condition[, string|null $operator = null ][, string|null $value = null ][, bool $escapeValue = true ]) : static

If only $condition is provided, this is used as complete string, e.g. where("id = 5") If $equality & $value are provided, it uses it with $condition as a field (identifier), e.g. where('id', '=', '5') where identifier and value are escaped with escapeIdentifier() & escapeValue() If $equality is provided but $value is not, $equality is the value and where are using a smart comparator, e.g. where('id', '5') All examples return the same results. Smart comparator is IN for array values and = for all others.

Parameters
$condition : array<string|int, mixed>|string
$operator : string|null = null
$value : string|null = null
$escapeValue : bool = true
Return values
static

get()

Get a parameter for this query

protected get(string $parameter[, mixed $default = null ]) : mixed
Parameters
$parameter : string
$default : mixed = null

set()

Set a parameter for this query

protected set(string $parameter, mixed $value) : static
Parameters
$parameter : string
$value : mixed
Return values
static

sget()

Set/Get a parameter for this query If there is a value (non-null), we set it, or we get it

protected sget(string $parameter[, mixed $value = null ]) : mixed
Parameters
$parameter : string
$value : mixed = null
Tags
noinspection

PhpMixedReturnTypeCanBeReducedInspection


							

							
						

					

					
					
				
				

			

			

				
				

					On this page
					
					
				

			
			

		

		

			

				

					
Search results