final class FossabotRole extends FossabotDataModel implements FossabotRole (View source)

Fossabot role context data model. Defines the ID, name and type of role associated to the user.

Traits

Trait to consolidate the methods needs to implement the \Brandon14\FossabotCommander\Contracts\Stringable interface.

Trait to consolidate functionality of converting a class to JSON representation.

Properties

protected $data

Data model.

from  FossabotDataModel

Methods

string
toJson($options = 0)

{@inheritDoc}

__toString()

Magic method https://www.php.net/manual/en/language.oop5.magic.php#object. toString allows a class to decide how it will react when it is treated like a string.

string
toString()

{@inheritDoc}

bool
offsetExists(string $offset)

Whether an offset exists.

offsetGet(string $offset)

Offset to retrieve.

void
offsetSet(string $offset, mixed $value)

Offset to set.

void
offsetUnset(string $offset)

Offset to unset.

array
__serialize()

Serializes data.

void
__unserialize(array $data)

Unserializes data.

__get(string $name)

Gets property.

void
__set(string $name, mixed $value)

Sets property.

bool
__isset(string $name)

Checks for existence of property.

void
__unset(string $name)

Unsets property.

array
jsonSerialize()

Specify data which should be serialized to JSON.

toArray()

No description

createFromBody(array $body)

Creates a new Fossabot data model instance from a parsed array of API data.

string
id()

Role ID.

string
name()

Role name.

string
type()

Role type.

Details

string toJson($options = 0)

{@inheritDoc}

Parameters

$options

Return Value

string

__toString()

Magic method https://www.php.net/manual/en/language.oop5.magic.php#object. toString allows a class to decide how it will react when it is treated like a string.

string toString()

{@inheritDoc}

Return Value

string

bool offsetExists(string $offset)

Whether an offset exists.

Parameters

string $offset

Offset name

Return Value

bool

offsetGet(string $offset)

Offset to retrieve.

Parameters

string $offset

Offset name

void offsetSet(string $offset, mixed $value)

Offset to set.

Parameters

string $offset

Offset name

mixed $value

Property value

Return Value

void

Exceptions

ImmutableDataModelException

void offsetUnset(string $offset)

Offset to unset.

Parameters

string $offset

Offset name

Return Value

void

Exceptions

ImmutableDataModelException

array __serialize()

Serializes data.

Return Value

array

void __unserialize(array $data)

Unserializes data.

Parameters

array $data

Unserialized data

Return Value

void

__get(string $name)

Gets property.

Parameters

string $name

Offset name

void __set(string $name, mixed $value)

Sets property.

Parameters

string $name

Offset name

mixed $value

Offset value

Return Value

void

Exceptions

ImmutableDataModelException

bool __isset(string $name)

Checks for existence of property.

Parameters

string $name

Offset name

Return Value

bool

void __unset(string $name)

Unsets property.

Parameters

string $name

Offset name

Return Value

void

Exceptions

ImmutableDataModelException

array jsonSerialize()

Specify data which should be serialized to JSON.

Return Value

array

toArray()

No description

static FossabotDataModel createFromBody(array $body)

Creates a new Fossabot data model instance from a parsed array of API data.

Parameters

array $body

Parsed API body

Return Value

FossabotDataModel

string id()

Role ID.

Return Value

string

string name()

Role name.

Return Value

string

string type()

Role type.

Return Value

string