Entity
in package
implements
EntityInterface, JsonSerializable
Interfaces, Classes, Traits and Enums
- EntityInterface
- Interface EntityInterface.
- JsonSerializable
Table of Contents
- $data : mixed
- getBody() : string
- Get the body portion of the entity.
- getData() : array<string|int, mixed>
- Get the data associated with the entity.
- getDatum() : mixed
- Get a datum value or default value.
- getProperties() : array<string|int, mixed>
- getProperty() : mixed
- Get the value of a property or default if property does not exist.
- getTitle() : string
- Get the title of the entity.
- getType() : string
- Get the entity type.
- jsonSerialize() : mixed
- {@inheritdoc}
- setBody() : EntityInterface
- setData() : EntityInterface
- setProperties() : EntityInterface
- setTitle() : EntityInterface
- setType() : EntityInterface
Properties
$data
protected
mixed
$data
= []
Methods
getBody()
Get the body portion of the entity.
public
getBody() : string
Return values
string —The body.
getData()
Get the data associated with the entity.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —All existing data.
getDatum()
Get a datum value or default value.
public
getDatum(string $datum, mixed $default) : mixed
Parameters
- $datum : string
-
The data key.
- $default : mixed
-
The value to use if $datum does not exist.
Return values
mixed —The value or default value.
getProperties()
public
getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProperty()
Get the value of a property or default if property does not exist.
public
getProperty(string $property, mixed $default) : mixed
Parameters
- $property : string
-
The name of the property.
- $default : mixed
-
The default value if property does not exist.
Return values
mixed —The value or default value.
getTitle()
Get the title of the entity.
public
getTitle() : string
Return values
string —The title of the entity.
getType()
Get the entity type.
public
getType() : string
Return values
string —The entity type.
jsonSerialize()
{@inheritdoc}
public
jsonSerialize() : mixed
Return values
mixed —setBody()
public
setBody(string $body) : EntityInterface
Parameters
- $body : string
Return values
EntityInterface —setData()
public
setData(array<string|int, mixed> $data) : EntityInterface
Parameters
- $data : array<string|int, mixed>
Return values
EntityInterface —setProperties()
public
setProperties(array<string|int, mixed> $properties) : EntityInterface
Parameters
- $properties : array<string|int, mixed>
Return values
EntityInterface —setTitle()
public
setTitle(string $title) : EntityInterface
Parameters
- $title : string
Return values
EntityInterface —setType()
public
setType(string $type) : EntityInterface
Parameters
- $type : string