Documentation

EntityRef extends Message
in package

Table of Contents

ALL_OPS  = 0b11111111
Bitmask for all the OP_ constants.
F_API  = 2 ** 30
Set when the request came from the JSON API.
F_VALIDATE  = 2 ** 29
Set on a request to validate the message.
OP_ADD  = 1
OP_BATCH  = 2 ** 6
OP_CREATE  = 2
OP_DELETE  = 2 ** 2
OP_GET  = 2 ** 3
OP_LOCK  = 2 ** 7
OP_QUERY  = 2 ** 4
OP_UPDATE  = 2 ** 5
$code  : string
$uuid  : string
__construct()  : mixed
__toString()  : string
copy()  : $this
Selectively copy information from a data array.
fromArray()  : static
Populate the message with data from an array of request data.
fromMixed()  : EntityRef
fromRequest()  : static
Create a message from the request payload, bypassing some middleware.
getOpFlags()  : int
sameAs()  : bool
toOpFlags()  : int
Convert a method name to an operation bitmask.
validate()  : self
Make sure the reference is valid.

Constants

ALL_OPS

Bitmask for all the OP_ constants.

public mixed ALL_OPS = 0b11111111

F_API

Set when the request came from the JSON API.

public mixed F_API = 2 ** 30

F_VALIDATE

Set on a request to validate the message.

public mixed F_VALIDATE = 2 ** 29

OP_BATCH

public mixed OP_BATCH = 2 ** 6

OP_CREATE

public mixed OP_CREATE = 2

OP_DELETE

public mixed OP_DELETE = 2 ** 2

OP_LOCK

public mixed OP_LOCK = 2 ** 7

OP_QUERY

public mixed OP_QUERY = 2 ** 4

OP_UPDATE

public mixed OP_UPDATE = 2 ** 5

Properties

$code

public string $code

The entity code (unique in context, may be empty)

$uuid

public string $uuid

The UUID of the entity.

Methods

__construct()

public __construct([string|null $code = null ][, string|null $uuid = null ]) : mixed
Parameters
$code : string|null = null
$uuid : string|null = null
Return values
mixed —

__toString()

public __toString() : string
Return values
string —

copy()

Selectively copy information from a data array.

public copy(array<string|int, mixed> $data, int $opFlags) : $this
Parameters
$data : array<string|int, mixed>
$opFlags : int
Return values
$this —

fromArray()

Populate the message with data from an array of request data.

public static fromArray(array<string|int, mixed> $data[, int $opFlags = self::OP_ADD ]) : static
Parameters
$data : array<string|int, mixed>

Data generated by the request.

$opFlags : int = self::OP_ADD

Bitmask of the request operation (may include FM_VALIDATE)

Tags
inheritdoc
Return values
static —

Message initialized with relevant data.

fromMixed()

public static fromMixed(mixed $data, int $opFlags) : EntityRef
Parameters
$data : mixed
$opFlags : int
Return values
EntityRef —

fromRequest()

Create a message from the request payload, bypassing some middleware.

public static fromRequest(Request $request, int $opFlags) : static
Parameters
$request : Request
$opFlags : int
Tags
throws
Breaker
Return values
static —

getOpFlags()

public getOpFlags() : int
Return values
int —

toOpFlags()

Convert a method name to an operation bitmask.

public static toOpFlags(string $method[, array<string|int, mixed> $options = [] ]) : int
Parameters
$method : string

The method name.

$options : array<string|int, mixed> = []

Options are: add Bitmask of flags to add to the result. allowZero boolean, if not set an exception is thrown when there is no matching flag. disallow Bitmask of methods to ignore.

Tags
throws
Breaker
Return values
int —

Operation bitmask, zero if not recognized or disallowed.

validate()

Make sure the reference is valid.

public validate([int $opFlags = null ][, string $codeFormat = '' ]) : self
Parameters
$opFlags : int = null

Operation bitmask.

$codeFormat : string = ''

Regular expression for validating code property, blank if not used.

Tags
throws
Breaker
Return values
self —

Search results