AbstractEntity
+ Inheritance diagram for AbstractEntity:

Description

Public Properties

const TYPE = ''
 All entity classes must redeclare this to match their resource_type. More...
 

Protected Properties

const DIR = ''
 All entity classes must redeclare this to match their REST directory. More...
 
const OPT_FIELDS = []
 
- Protected Properties inherited from Data
readonly Api Api $api
 
array array self[] AbstractEntity[] $data = []
 
array bool[] $diff = []
 
const MAP = []
 

Public Methods

string __toString ()
 The entity's canonical REST path. More...
 
null string getGid ()
 
bool hasGid ()
 
$this reload ()
 Fully reloads the entity from Asana. More...
 
- Public Methods inherited from Data
mixed __call (string $method, array $args)
 Magic method handler. More...
 
 __construct (Api|self $caller, array $data=[])
 
array __serialize ()
 
void __unserialize (array $data)
 
bool isDiff ()
 Whether the instance has changes. More...
 
array jsonSerialize ()
 
bool offsetExists (mixed $offset)
 
mixed offsetGet (mixed $offset)
 
void offsetSet (mixed $offset, mixed $value)
 
void offsetUnset (mixed $offset)
 
array toArray (bool $diff=false)
 Dehydrated data. More...
 
- Public Methods inherited from ImmutableArrayTrait
void offsetSet (mixed $offset, mixed $value)
 Throws unless overridden. More...
 

Protected Methods

mixed _get (string $field)
 Lazy-loads missing fields. More...
 
void _reload (string $field)
 
void _setData (array $data)
 
- Protected Methods inherited from Data
bool _has (string $field)
 Magic method: hasField() More...
 
_hydrate (string $class, $item)
 Sub-data factory that draws from the entity pool. More...
 
bool _is (string $field)
 Magic method: isField() More...
 
bool _of (string $resourceSubtype)
 Magic method: ofResourceSubtypeValue() More...
 
array _select (string|iterable $subject, callable $filter,... $args)
 Magic method: selectField(callable $filter) More...
 
$this _set (string $field, $value)
 Magic method: setField(mixed $value) More...
 
void _setField (string $field, $value)
 Sets a value, hydrating if mapped, and clears the diff. More...
 

Properties

◆ DIR

const DIR = ''
protected

All entity classes must redeclare this to match their REST directory.

◆ TYPE

const TYPE = ''

All entity classes must redeclare this to match their resource_type.

Methods

◆ __toString()

string __toString ( )
final

The entity's canonical REST path.

Returns
string

◆ _get()

mixed _get ( string  $field)
finalprotected

Lazy-loads missing fields.

Parameters
string$field
Returns
mixed

Reimplemented from Data.

◆ _reload()

void _reload ( string  $field)
finalprotected
Parameters
string$field
Returns
void

◆ _setData()

void _setData ( array  $data)
protected
Parameters
array$data
Returns
void

Reimplemented from Data.

Reimplemented in Task, Story, Project, Status, and Section.

◆ getGid()

null string getGid ( )
final
Returns
null|string

◆ hasGid()

bool hasGid ( )
final
Returns
bool

◆ reload()

$this reload ( )

Fully reloads the entity from Asana.

Returns
$this
Exceptions
RuntimeExceptionEntity was deleted upstream.