Helix\Asana\User\TaskList

Complexity

Total Complexity

6

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes	9
Bugs	0	Features	2

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	2	1
A	getCacheKeys()	0	7	1
A	getIncompleteTasks()	0	2	1
A	getTasks()	0	2	1
A	selectTasks()	0	2	1
A	getIterator()	0	2	1

<?php

namespace Helix\Asana\User;

use Helix\Asana\Base\AbstractEntity;
use Helix\Asana\Task;
use Helix\Asana\User;
use Helix\Asana\Workspace;
use IteratorAggregate;
use Traversable;

/**
 * A user's task list in a given workspace.
 *
 * @see https://developers.asana.com/docs/asana-user-task-lists
 * @see https://developers.asana.com/docs/user-task-list
 *
 * @immutable User task lists are read-only through the API.
 *
 * @method string       getName         ()
 * @method User         getOwner        ()
 * @method Workspace    getWorkspace    ()
 */
class TaskList extends AbstractEntity implements IteratorAggregate {

    const TYPE = 'user_task_list';

    protected static $map = [
        'owner' => User::class,
        'workspace' => Workspace::class
    ];

    final public function __toString (): string {
        return "user_task_lists/{$this->getGid()}";
    }

    public function getCacheKeys () {
        $keys = parent::getCacheKeys();

        /** @see User::getTaskList() */
        $keys[] = "{$this->getOwner()}/user_task_list?workspace={$this->getWorkspace()->getGid()}";

        return $keys;
    }

    /**
     * @return Task[]
     */
    public function getIncompleteTasks () {
        return $this->getTasks(['completed_since' => 'now']);
    }

    /**
     * @param array $filter
     * @return Traversable|Task[]
     */
    public function getIterator (array $filter = []) {
        return $this->_loadEach(Task::class, "{$this}/tasks");
    }

    /**
     * All of the user's tasks.
     *
     * @see https://developers.asana.com/docs/get-tasks-from-a-user-task-list
     *
     * @param array $filter
     * @return Task[]
     */
    public function getTasks (array $filter = []) {
        return iterator_to_array($this->getIterator($filter));
    }

    /**
     * @param callable $filter `fn( Task $task ): bool`
     * @param array $apiFilter Given to the API to reduce network load.
     * @return Task[]
     */
    public function selectTasks (callable $filter, array $apiFilter) {
        return $this->_select($this->getIterator($apiFilter), $filter);
    }
}