W3cubDocs

/CakePHP 4.1

Class UnaryExpression

An expression object that represents an expression with only a single operand.

Namespace: Cake\Database\Expression

Constants summary

  • int
    POSTFIX
    1
  • int
    PREFIX
    0

Properties summary

  • $_mode protected
    int

    Where to place the operator

  • $_operator protected
    string

    The operator this unary expression represents

  • $_value protected
    mixed

    Holds the value which the unary expression operates

Method Summary

  • __clone() public

    Perform a deep clone of the inner expression.

  • __construct() public

    Constructor

  • sql() public

    Converts the expression to its string representation

  • traverse() public

    Iterates over each part of the expression recursively for every level of the expressions tree and executes the $visitor callable passing as first parameter the instance of the expression currently being iterated.

Method Detail

__clone() public 

__clone()

Perform a deep clone of the inner expression.

__construct() public 

__construct(string $operator, mixed $value, mixed $mode)

Constructor

Parameters

string $operator

The operator to used for the expression

mixed $value

the value to use as the operand for the expression

int $mode optional

either UnaryExpression::PREFIX or UnaryExpression::POSTFIX

sql() public 

sql(\Cake\Database\ValueBinder $generator)

Converts the expression to its string representation

Parameters

\Cake\Database\ValueBinder $generator

Placeholder generator object

Returns

string

traverse() public 

traverse(\Closure $visitor)

Iterates over each part of the expression recursively for every level of the expressions tree and executes the $visitor callable passing as first parameter the instance of the expression currently being iterated.

Parameters

\Closure $visitor

The callable to apply to all nodes.

Returns

$this

Property Detail

$_mode protected

Where to place the operator

Type

int

$_operator protected

The operator this unary expression represents

Type

string

$_value protected

Holds the value which the unary expression operates

Type

mixed

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Database.Expression.UnaryExpression.html