Documentation

UpdateStatement extends Query
in package

Represents the UPDATE query

Table of Contents

Properties

$ctes  : mixed
$entityManager  : mixed
$from  : mixed
$isReturning  : mixed
$joins  : mixed
$precedence  : mixed
$returning  : mixed
$type  : Type|null
$values  : mixed
$where  : mixed

Methods

__construct()  : mixed
Construct a UPDATE query from a SelectStatement (it keeps the FROM, JOIN and WHERE clauses)
accept()  : mixed
Visit the current Node
as()  : AliasOperator
Construct an alias for the current node
asc()  : AscOperator
Construct an ascending order for the current node
caseWhen()  : WhenNode
Construct a CASE WHEN expression (without value)
cast()  : Cast
Cast the current node to a given type
coalesce()  : mixed
desc()  : DescOperator
Construct a descending order for the current node
eq()  : EqualityOperator|IsNullOperator
Construct a '=' boolean expression
false()  : EqualityOperator|IsNullOperator
Construct a Node corresponding to a non tautology
firstValue()  : mixed
Construct a FIRST_VALUE function from the current node
getCtes()  : array<string|int, mixed>
Getter of the CTE list
getFrom()  : mixed
Getter of the FROM clause table
getJoins()  : mixed
Getter of the JOIN clause list
getPrecedence()  : int
getReturning()  : array<string|int, mixed>
Getter of the RETURNING clause
getType()  : Type|null
Get the type of the Node
getValues()  : array<string|int, mixed>
Getter of SET clause associated array
getWhere()  : mixed
Getter of the WHERE clause condition
grouping()  : Grouping
Construct a Grouping node
in()  : InOperator|NotInOperator
Construct a 'IN' boolean expression
isReturning()  : bool
Check if the query has a RETURNING clause
json()  : mixed
lastValue()  : mixed
Construct a LAST_VALUE function from the current node
neq()  : NotEqualityOperator|IsNotNullOperator
Construct a '!=' boolean expression
nodeArray()  : array<string|int, mixed>
transform any object into a array of Node
notIn()  : NotInOperator|InOperator
Construct a 'NOT IN' boolean expression
of()  : Literal|Node
Transform any object into a Node (does nothing on a Node)
repeat()  : Repeat
Repeat the current node $times times
returning()  : UpdateStatement
Add a RETURNING clause to the query
set()  : static
Add or change the SET clause for a given column
setType()  : void
Set the type of the Node
standardizeArray()  : array<string|int, mixed>
Transform any object into a array
table()  : Table
Construct a Table node
toSql()  : mixed
transform the node into a SQL query string
true()  : EqualityOperator|IsNullOperator
Construct a Node corresponding to a tautology
tuple()  : ExpressionList
Construct a Tuple node
typed()  : Node
Set the type of the Node and return the Node
union()  : Union
Union the current query with another one
when()  : WhenNode
Construct a CASE expression from the current node and define the first WHEN clause with a given condition
with()  : UpdateStatement
Add a CTE to the query

Properties

$precedence

private static mixed $precedence = [[\PhpParser\Node\Expr\Cast::class, \FND\QueryBuilder\Nodes\FunctionCall::class, \FND\QueryBuilder\Nodes\Literal::class], [\FND\QueryBuilder\Nodes\ExpressionList::class], [\FND\QueryBuilder\Nodes\Column::class], [\FND\QueryBuilder\Nodes\BinaryOperators\MulOperator::class, \FND\QueryBuilder\Nodes\BinaryOperators\DivOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\AddOperator::class, \FND\QueryBuilder\Nodes\BinaryOperators\SubOperator::class], [\FND\QueryBuilder\Nodes\UnaryOperators\IsNullOperator::class, \FND\QueryBuilder\Nodes\UnaryOperators\IsNotNullOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\InOperator::class, \FND\QueryBuilder\Nodes\BinaryOperators\NotInOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\MatchOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\LesserOrEqualOperator::class, \FND\QueryBuilder\Nodes\BinaryOperators\LesserThanOperator::class, \FND\QueryBuilder\Nodes\BinaryOperators\GreaterOrEqualOperator::class, \FND\QueryBuilder\Nodes\BinaryOperators\GreaterThanOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\EqualityOperator::class, \FND\QueryBuilder\Nodes\BinaryOperators\NotEqualityOperator::class], [\FND\QueryBuilder\Nodes\NotOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\AndOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\OrOperator::class], [\FND\QueryBuilder\Nodes\BinaryOperators\AliasOperator::class]]

Methods

__construct()

Construct a UPDATE query from a SelectStatement (it keeps the FROM, JOIN and WHERE clauses)

public __construct(mixed $selectStatement[, mixed $entityManager = NULL ]) : mixed
Parameters
$selectStatement : mixed

the SELECT query

$entityManager : mixed = NULL

the entity manager to execute the query

accept()

Visit the current Node

public accept(mixed $visitor) : mixed
Parameters
$visitor : mixed

a visitor

Return values
mixed —

the result string of the visit

caseWhen()

Construct a CASE WHEN expression (without value)

public static caseWhen(mixed $condition) : WhenNode
Parameters
$condition : mixed

the first WHEN clause condition

Return values
WhenNode —

the CASE WHEN expression

cast()

Cast the current node to a given type

public cast(Type $type) : Cast
Parameters
$type : Type

the type to cast to

Return values
Cast —

the cast node

coalesce()

public coalesce(mixed $args) : mixed
Parameters
$args : mixed

firstValue()

Construct a FIRST_VALUE function from the current node

public firstValue([mixed $groups = [] ][, mixed $orders = [] ][, mixed $rows = [] ][, mixed $nullsDirective = 0 ]) : mixed
Parameters
$groups : mixed = []

values to partitioned by (for window functions)

$orders : mixed = []

values to order with (for window functions)

$rows : mixed = []

values to bound with (for window functions)

$nullsDirective : mixed = 0

getCtes()

Getter of the CTE list

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

the CTE list

getFrom()

Getter of the FROM clause table

public getFrom() : mixed
Return values
mixed —

the table

getJoins()

Getter of the JOIN clause list

public getJoins() : mixed
Return values
mixed —

the JOIN clause list

getPrecedence()

public getPrecedence() : int
Return values
int

getReturning()

Getter of the RETURNING clause

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

the list of columns to return

getType()

Get the type of the Node

public getType() : Type|null
Return values
Type|null —

the type

getValues()

Getter of SET clause associated array

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

the SET clause associated array

getWhere()

Getter of the WHERE clause condition

public getWhere() : mixed
Return values
mixed —

the WHERE clause condition

grouping()

Construct a Grouping node

public static grouping(mixed $node) : Grouping
Parameters
$node : mixed

a node

Return values
Grouping —

the new Grouping node

isReturning()

Check if the query has a RETURNING clause

public isReturning() : bool
Return values
bool —

true if the query has a RETURNING clause

lastValue()

Construct a LAST_VALUE function from the current node

public lastValue([mixed $groups = [] ][, mixed $orders = [] ][, mixed $rows = [] ][, mixed $nullsDirective = 0 ]) : mixed
Parameters
$groups : mixed = []

values to partitioned by (for window functions)

$orders : mixed = []

values to order with (for window functions)

$rows : mixed = []

values to bound with (for window functions)

$nullsDirective : mixed = 0

nodeArray()

transform any object into a array of Node

public static nodeArray(mixed $args) : array<string|int, mixed>
Parameters
$args : mixed

any object

Return values
array<string|int, mixed> —

an array of Node

of()

Transform any object into a Node (does nothing on a Node)

public static of(mixed $value) : Literal|Node
Parameters
$value : mixed

any value

Return values
Literal|Node —

a Node

repeat()

Repeat the current node $times times

public repeat(mixed $times) : Repeat
Parameters
$times : mixed

the number of times to repeat the current node

Return values
Repeat —

the repeated node

returning()

Add a RETURNING clause to the query

public returning(array<string|int, mixed> $columns) : UpdateStatement
Parameters
$columns : array<string|int, mixed>

the list of columns to return

Return values
UpdateStatement —

the current instance

set()

Add or change the SET clause for a given column

public set(mixed $column, mixed $value) : static
Parameters
$column : mixed

the column name

$value : mixed

the value expresion

Return values
static —

return the current UPDATE query

setType()

Set the type of the Node

public setType(Type $type) : void
Parameters
$type : Type

the type

standardizeArray()

Transform any object into a array

public static standardizeArray(mixed $args) : array<string|int, mixed>
Parameters
$args : mixed

the object

Return values
array<string|int, mixed> —

the array

table()

Construct a Table node

public static table(mixed $name) : Table
Parameters
$name : mixed

the table name

Return values
Table —

the table

toSql()

transform the node into a SQL query string

public toSql([mixed $connection = NULL ]) : mixed
Parameters
$connection : mixed = NULL

the DB connection concerned (to select the right visitor)

Return values
mixed —

the SQL string

tuple()

Construct a Tuple node

public static tuple(mixed $array) : ExpressionList
Parameters
$array : mixed

a list

Return values
ExpressionList —

the new Tuple node

typed()

Set the type of the Node and return the Node

public typed(Type $type) : Node
Parameters
$type : Type

the type

Return values
Node —

the current Node

union()

Union the current query with another one

public union(mixed $query[, mixed $all = false ]) : Union
Parameters
$query : mixed

mixed

$all : mixed = false

boolean

Return values
Union —

the union node

when()

Construct a CASE expression from the current node and define the first WHEN clause with a given condition

public when(mixed $condition) : WhenNode
Parameters
$condition : mixed
Return values
WhenNode —

the case node

with()

Add a CTE to the query

public with(mixed $name, mixed $query) : UpdateStatement
Parameters
$name : mixed

the name of the CTE

$query : mixed

the query of the CTE

Return values
UpdateStatement —

the new SELECT statement


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results