Documentation

EvaluateOutput extends Message
in package

EvaluateOutput is the output message for the EvaluateExpr method.

Generated from protobuf message exprml.v1.EvaluateOutput

Table of Contents

Methods

__construct()  : mixed
Constructor.
clearErrorPath()  : mixed
clearValue()  : mixed
getErrorMessage()  : string
Error message if status is not OK.
getErrorPath()  : Path|null
Error path if status is not OK.
getStatus()  : int
Status of the evaluation.
getValue()  : Value|null
Result of the evaluation.
hasErrorPath()  : mixed
hasValue()  : mixed
setErrorMessage()  : $this
Error message if status is not OK.
setErrorPath()  : $this
Error path if status is not OK.
setStatus()  : $this
Status of the evaluation.
setValue()  : $this
Result of the evaluation.

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type int $status
      Status of the evaluation.
@type string $error_message
      Error message if status is not OK.
@type \Exprml\PB\Exprml\V1\Expr\Path $error_path
      Error path if status is not OK.
@type \Exprml\PB\Exprml\V1\Value $value
      Result of the evaluation.

}

getErrorMessage()

Error message if status is not OK.

public getErrorMessage() : string

Generated from protobuf field string error_message = 2 [json_name = "errorMessage"];

Return values
string

getErrorPath()

Error path if status is not OK.

public getErrorPath() : Path|null

Generated from protobuf field .exprml.v1.Expr.Path error_path = 3 [json_name = "errorPath"];

Return values
Path|null

getStatus()

Status of the evaluation.

public getStatus() : int

Generated from protobuf field .exprml.v1.EvaluateOutput.Status status = 1 [json_name = "status"];

Return values
int

getValue()

Result of the evaluation.

public getValue() : Value|null

Generated from protobuf field .exprml.v1.Value value = 4 [json_name = "value"];

Return values
Value|null

setErrorMessage()

Error message if status is not OK.

public setErrorMessage(string $var) : $this

Generated from protobuf field string error_message = 2 [json_name = "errorMessage"];

Parameters
$var : string
Return values
$this

setErrorPath()

Error path if status is not OK.

public setErrorPath(Path $var) : $this

Generated from protobuf field .exprml.v1.Expr.Path error_path = 3 [json_name = "errorPath"];

Parameters
$var : Path
Return values
$this

setStatus()

Status of the evaluation.

public setStatus(int $var) : $this

Generated from protobuf field .exprml.v1.EvaluateOutput.Status status = 1 [json_name = "status"];

Parameters
$var : int
Return values
$this

setValue()

Result of the evaluation.

public setValue(Value $var) : $this

Generated from protobuf field .exprml.v1.Value value = 4 [json_name = "value"];

Parameters
$var : Value
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results