Helix\Asana\User::_getMap()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	User::__toString()	0	2	1

<?php

namespace Helix\Asana;

use Helix\Asana\Base\AbstractEntity;
use Helix\Asana\User\Photo;
use Helix\Asana\User\TaskList;

/**
 * A user.
 *
 * @see https://developers.asana.com/docs/asana-users
 * @see https://developers.asana.com/docs/user
 *
 * @immutable Users cannot be altered via the API.
 *
 * @method string       getEmail        ()
 * @method string       getName         ()
 * @method null|Photo   getPhoto        ()
 * @method Workspace[]  getWorkspaces   ()
 */
class User extends AbstractEntity {

    const TYPE = 'user';

    protected static $map = [
        'photo' => Photo::class,
        'workspaces' => [Workspace::class]
    ];

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

    /**
     * @param Workspace $workspace
     * @return $this
     */
    public function addToWorkspace (Workspace $workspace) {
        $this->api->post("{$workspace}/addUser", ['user' => $this->getGid()]);
        $this->_merge('workspaces', [$workspace]);
        return $this;
    }

    /**
     * @param Workspace $workspace
     * @return Portfolio[]
     */
    public function getFavoritePortfolios (Workspace $workspace) {
        return $this->getFavorites(Portfolio::class, Portfolio::TYPE, $workspace);
    }

    /**
     * @param Workspace $workspace
     * @return Project[]
     */
    public function getFavoriteProjects (Workspace $workspace) {
        return $this->getFavorites(Project::class, Project::TYPE, $workspace);
    }

    /**
     * @param Workspace $workspace
     * @return Tag[]
     */
    public function getFavoriteTags (Workspace $workspace) {
        return $this->getFavorites(Tag::class, Tag::TYPE, $workspace);
    }

    /**
     * @param Workspace $workspace
     * @return Team[]
     */
    public function getFavoriteTeams (Workspace $workspace) {
        return $this->getFavorites(Team::class, Team::TYPE, $workspace);
    }

    /**
     * @param Workspace $workspace
     * @return User[]
     */
    public function getFavoriteUsers (Workspace $workspace) {
        return $this->getFavorites(self::class, self::TYPE, $workspace);
    }

    /**
     * @param string $class
     * @param string $resourceType
     * @param Workspace $workspace
     * @return array
     */
    protected function getFavorites (string $class, string $resourceType, Workspace $workspace) {
        return $this->loadAll($class, "{$this}/favorites", [
            'resource_type' => $resourceType,
            'workspace' => $workspace->getGid()
        ]);
    }

    /**
     * Returns all incomplete tasks in the given workspace that are assigned to the user.
     *
     * @see https://developers.asana.com/docs/#get-multiple-tasks
     *
     * @param Workspace $workspace
     * @return Task[]
     */
    public function getIncompleteTasks (Workspace $workspace) {
        return $this->loadAll(Task::class, 'tasks', [
            'assignee' => $this->getGid(),
            'workspace' => $workspace->getGid(),
            'completed_since' => 'now'
        ]);
    }

    /**
     * @param Workspace $workspace
     * @return Portfolio[]
     */
    public function getPortfolios (Workspace $workspace) {
        return $this->loadAll(Portfolio::class, "portfolios", [
            'workspace' => $workspace->getGid(),
            'owner' => $this->getGid()
        ]);
    }

    /**
     * @param Workspace $workspace
     * @return TaskList
     */
    public function getTaskList (Workspace $workspace) {
        return $this->load(TaskList::class, "{$this}/user_task_list", [
            'workspace' => $workspace->getGid()
        ]);
    }

    /**
     * Returns all tasks in the given workspace that are assigned to the user.
     *
     * @see https://developers.asana.com/docs/#get-multiple-tasks
     *
     * @param Workspace $workspace
     * @param string[] $filter
     * @return Task[]
     */
    public function getTasks (Workspace $workspace, array $filter = []) {
        $filter['assignee'] = $this->getGid();
        $filter['workspace'] = $workspace->getGid();
        return $this->loadAll(Task::class, 'tasks', $filter);
    }

    /**
     * @param Workspace $organization
     * @return Team[]
     */
    public function getTeams (Workspace $organization) {
        return $this->loadAll(Team::class, "{$this}/teams", [
            'organization' => $organization->getGid()
        ]);
    }

    public function getUrl (): string {
        return "https://app.asana.com/0/{$this->getGid()}/list";
    }

    /**
     * @param Workspace $workspace
     * @return $this
     */
    public function removeFromWorkspace (Workspace $workspace) {
        $this->api->post("{$workspace}/removeUser", ['user' => $this->getGid()]);
        $this->_remove('workspaces', [$workspace]);
        return $this;
    }
}