TaskList
+ Inheritance diagram for TaskList:

Description

A user's task list in a given workspace.

Immutable:
User task lists cannot be altered via the API.
See also
https://developers.asana.com/docs/asana-user-task-lists
https://developers.asana.com/docs/user-task-list

Public Properties

final const TYPE = 'user_task_list'
 
- Public Properties inherited from AbstractEntity
const TYPE = ''
 All entity classes must redeclare this to match their resource_type. More...
 

Protected Properties

final const DIR = 'user_task_lists'
 
const MAP
 
- Protected Properties inherited from AbstractEntity
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

Generator< TaskgetIterator (array $filter=Task::GET_INCOMPLETE)
 
magic string getName ()
 
magic User getOwner ()
 
magic Workspace getWorkspace ()
 
Task[] selectTasks (callable $filter, array $apiFilter=Task::GET_INCOMPLETE)
 
- Public Methods inherited from AbstractEntity
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...
 
- Public Methods inherited from TaskIteratorTrait
Task[] getTasks (array $filter=Task::GET_INCOMPLETE)
 

Additional Inherited Members

- Protected Methods inherited from AbstractEntity
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

◆ MAP

const MAP
protected
Initial value:
= [
'owner' => User::class,
'workspace' => Workspace::class
]

Methods

◆ getIterator()

Generator<Task> getIterator ( array  $filter = Task::GET_INCOMPLETE)
Parameters
array$filter
Returns
Generator<Task>

Reimplemented from TaskIteratorTrait.

◆ getName()

magic string getName ( )
Returns
string

◆ getOwner()

magic User getOwner ( )
Returns
User

◆ getWorkspace()

magic Workspace getWorkspace ( )
Returns
Workspace

◆ selectTasks()

Task [] selectTasks ( callable  $filter,
array  $apiFilter = Task::GET_INCOMPLETE 
)
Parameters
callable$filterfn( Task $task ): bool
array$apiFilterGiven to the API to reduce network load.
Returns
Task[]

Reimplemented from TaskIteratorTrait.