PHP Interface Neos\Eel\FlowQuery\OperationInterface

Mostra file Open project: neos/flow-development-collection

Public Methods

Method	Description
canEvaluate ( $context ) : boolean	This method is called to determine whether the operation can work with the $context objects. It can be implemented to implement runtime conditions.
evaluate ( FlowQuery $flowQuery, array $arguments ) : mixed \| null	Evaluate the operation on the objects inside $flowQuery->getContext(), taking the $arguments into account.
getPriority ( ) : integer
getShortName ( ) : string
isFinal ( ) : boolean

Method Details

canEvaluate() public method

This method is called to determine whether the operation can work with the $context objects. It can be implemented to implement runtime conditions.

public canEvaluate ( $context ) : boolean
return	boolean	TRUE if the operation can be applied onto the $context, FALSE otherwise

evaluate() public method

The resulting operation results should be stored using $flowQuery->setContext(). If the operation is final, evaluate should directly return the operation result.

public evaluate ( FlowQuery $flowQuery, array $arguments ) : mixed \| null
$flowQuery	FlowQuery	the FlowQuery object
$arguments	array	the arguments for this operation
return	mixed \| null	if the operation is final, the return value

getPriority() public static method

public static getPriority ( ) : integer
return	integer	the priority of the operation

getShortName() public static method

public static getShortName ( ) : string
return	string	the short name of the operation

isFinal() public static method

public static isFinal ( ) : boolean
return	boolean	TRUE if the operation is final, FALSE otherwise