Documentation

EntityInterface
in

Interface EntityInterface.

Table of Contents

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.
setBody()  : EntityInterface
setData()  : EntityInterface
setProperties()  : EntityInterface
setTitle()  : EntityInterface
setType()  : EntityInterface

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,  $default) : mixed
Parameters
$datum : string

The data key.

$default :

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,  $default) : mixed
Parameters
$property : string

The name of the property.

$default :

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.

Search results