Task::getDependents() - Code Metrics - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Task::getDependents() A
last analyzed 2020-11-23 04:28 UTC

↳ Parent: Task

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php

namespace Helix\Asana;

use Helix\Asana\Base\AbstractEntity;
use Helix\Asana\Base\AbstractEntity\CrudTrait;
use Helix\Asana\Base\AbstractEntity\DateTrait;
use Helix\Asana\Base\AbstractEntity\PostMutatorTrait;
use Helix\Asana\Base\AbstractEntity\SyncTrait;
use Helix\Asana\Project\Section;
use Helix\Asana\Task\Attachment;
use Helix\Asana\Task\ExternalData;
use Helix\Asana\Task\FieldEntries;
use Helix\Asana\Task\Like;
use Helix\Asana\Task\Membership;
use Helix\Asana\Task\Story;
use Helix\Asana\Webhook\TaskWebhook;

/**
 * A task.
 *
 * @see https://developers.asana.com/docs/asana-tasks
 * @see https://developers.asana.com/docs/task
 *
 * @see Workspace::newTask()
 * @see Project::newTask()
 * @see Section::newTask()
 *
 * @method $this                setResourceSubtype          (string $type)          @depends create-only
 * @method $this                setWorkspace                (Workspace $workspace)  @depends create-only
 *
 * @method null|User            getAssignee                 ()
 * @method string               getAssigneeStatus           ()
 * @method bool                 isCompleted                 ()
 * @method string               getCompletedAt              () RFC3339x
 * @method string               getCreatedAt                () RFC3339x
 * @method null|FieldEntries    getCustomFields             () Premium feature.
 * @method User[]               getFollowers                ()
 * @method bool                 getIsRenderedAsSeparator    ()
 * @method bool                 isLiked                     () Whether you like the task.
 * @method Like[]               getLikes                    ()
 * @method Membership[]         getMemberships              ()
 * @method string               getModifiedAt               () RFC3339x
 * @method string               getName                     ()
 * @method string               getNotes                    ()
 * @method int                  getNumLikes                 ()
 * @method int                  getNumSubtasks              ()
 * @method null|Task            getParent                   ()
 * @method string               getResourceSubtype          ()
 * @method Tag[]                getTags                     ()
 * @method Workspace            getWorkspace                ()
 *
 * @method bool                 hasAssignee                 ()
 * @method bool                 hasCustomFields             () Premium feature.
 * @method bool                 hasFollowers                ()
 * @method bool                 hasLikes                    ()
 * @method bool                 hasMemberships              ()
 * @method bool                 hasName                     ()
 * @method bool                 hasNotes                    ()
 * @method bool                 hasParent                   ()
 * @method bool                 hasTags                     ()
 *
 * @method $this                setAssignee                 (?User $user)
 * @method $this                setAssigneeStatus           (string $status)
 * @method $this                setCompleted                (bool $completed)
 * @method $this                setIsRenderedAsSeparator    (bool $flag)
 * @method $this                setLiked                    (bool $liked) Like or unlike the task.
 * @method $this                setName                     (string $name)
 * @method $this                setNotes                    (string $notes)
 *
 * @method Attachment[]         selectAttachments           (callable $filter) `fn( Attachment $attachment): bool`
 * @method Task[]               selectDependencies          (callable $filter) `fn( Task $dependency ): bool`
 * @method Task[]               selectDependents            (callable $filter) `fn( Task $dependent ): bool`
 * @method User[]               selectFollowers             (callable $filter) `fn( User $user ): bool`
 * @method Story[]              selectComments              (callable $filter) `fn( Story $comment ): bool`
 * @method Like[]               selectLikes                 (callable $filter) `fn( Like $like ): bool`
 * @method Membership[]         selectMemberships           (callable $filter) `fn( Membership $membership ): bool`
 * @method Project[]            selectProjects              (callable $filter) `fn( Project $project ): bool`
 * @method Story[]              selectStories               (callable $filter) `fn( Story $story ): bool`
 * @method Task[]               selectSubTasks              (callable $filter) `fn( Task $subtask ): bool`
 * @method Tag[]                selectTags                  (callable $filter) `fn( Tag $tag ): bool`
 */
class Task extends AbstractEntity {

    use CrudTrait {
        create as private _create;
        update as private _update;
    }

    use DateTrait;
    use PostMutatorTrait;
    use SyncTrait;

    const DIR = 'tasks';
    const TYPE = 'task';

    const TYPE_DEFAULT = 'default_task';
    const TYPE_MILESTONE = 'milestone';

    const ASSIGN_INBOX = 'inbox';
    const ASSIGN_LATER = 'later';
    const ASSIGN_NEW = 'new';
    const ASSIGN_TODAY = 'today';
    const ASSIGN_UPCOMING = 'upcoming';

    const GET_INCOMPLETE = ['completed_since' => 'now'];

    protected const MAP = [
        'assignee' => User::class,
        'custom_fields' => FieldEntries::class,
        'external' => ExternalData::class, // opt-in
        'followers' => [User::class],
        'likes' => [Like::class],
        'memberships' => [Membership::class],
        'parent' => self::class,
        'tags' => [Tag::class],
        'workspace' => Workspace::class
    ];

    const OPT_FIELDS = [
        'memberships' => 'memberships.(project|section)'
    ];

    private function _onSave (): void {
        /** @var FieldEntries $fields */
        if ($fields = $this->data['custom_fields'] ?? null) {
            $fields->__unset(true);
        }
        /** @var ExternalData $external */
        if ($external = $this->data['external'] ?? null) {
            $external->diff = [];
        }
    }

    protected function _setData (array $data): void {
        // hearts were deprecated for likes.
        unset($data['hearted'], $data['hearts'], $data['num_hearts']);

        // redundant. memberships are used instead.
        unset($data['projects']);

        // time-based deadlines are a little passive-aggressive, don't you think?
        unset($data['due_at']);

        parent::_setData($data);
    }

    /**
     * Uploads a file attachment.
     *
     * @param string $file
     * @return Attachment
     */
    public function addAttachment (string $file) {
        /** @var Attachment $attachment */
        $attachment = $this->api->factory($this, Attachment::class, ['parent' => $this]);
        return $attachment->create($file);
    }

    /**
     * Premium feature.
     *
     * @param Task[] $tasks
     * @return $this
     */
    public function addDependencies (array $tasks) {
        $this->api->post("{$this}/addDependencies", ['dependents' => array_column($tasks, 'gid')]);
        return $this;
    }

    /**
     * Premium feature.
     *
     * @param Task $task
     * @return $this
     */
    public function addDependency (Task $task) {
        return $this->addDependencies([$task]);
    }

    /**
     * Premium feature.
     *
     * @param Task $task
     * @return $this
     */
    public function addDependent (Task $task) {
        return $this->addDependents([$task]);
    }

    /**
     * Premium feature.
     *
     * @param Task[] $tasks
     * @return $this
     */
    public function addDependents (array $tasks) {
        $this->api->post("{$this}/addDependents", ['dependents' => array_column($tasks, 'gid')]);
        return $this;
    }

    /**
     * Adds a follower.
     *
     * @param User $user
     * @return $this
     */
    public function addFollower (User $user) {
        return $this->addFollowers([$user]);
    }

    /**
     * Adds followers.
     *
     * @see https://developers.asana.com/docs/add-followers-to-a-task
     *
     * @param User[] $users
     * @return $this
     */
    public function addFollowers (array $users) {
        return $this->_addWithPost("{$this}/addFollowers", [
            'followers' => array_column($users, 'gid')
        ], 'followers', $users);
    }

    /**
     * Adds a tag.
     *
     * @see https://developers.asana.com/docs/add-a-tag-to-a-task
     *
     * @param Tag $tag
     * @return $this
     */
    public function addTag (Tag $tag) {
        assert($tag->hasGid());
        return $this->_addWithPost("{$this}/addTag", [
            'tag' => $tag->getGid()
        ], 'tags', [$tag]);
    }

    /**
     * Adds the task to a project.
     *
     * @see https://developers.asana.com/docs/add-a-project-to-a-task
     *
     * @see Project::newTask()
     * @see Section::newTask()
     *
     * @param Project|Section $target
     * @return $this
     */
    public function addToProject ($target) {
        assert($target->hasGid());
        if ($target instanceof Project) {
            $target = $target->getDefaultSection();
        }
        /** @var Membership $membership */
        $membership = $this->api->factory($this, Membership::class);
        $membership->setSection($target);
        return $this->_addWithPost("{$this}/addProject", $membership->toArray(), 'memberships', [$membership]);
    }

    /**
     * @return $this
     */
    public function create () {
        $this->_create();
        $this->_onSave();
        return $this;
    }

    /**
     * Duplicates the task.
     *
     * @see https://developers.asana.com/docs/duplicate-a-task
     *
     * @param string $name
     * @param string[] $include
     * @return Job
     */
    public function duplicate (string $name, array $include) {
        /** @var array $remote */
        $remote = $this->api->post("{$this}/duplicate", [
            'name' => $name,
            'include' => array_values($include)
        ]);
        return $this->api->factory($this, Job::class, $remote);
    }

    /**
     * Attached files.
     *
     * @return Attachment[]
     */
    public function getAttachments () {
        return $this->api->loadAll($this, Attachment::class, "{$this}/attachments");
    }

    /**
     * @return Story[]
     */
    public function getComments () {
        return $this->selectStories(function(Story $story) {
            return $story->isComment();
        });
    }

    /**
     * Premium feature.
     *
     * @return Task[]
     */
    public function getDependencies () {
        return $this->api->loadAll($this, self::class, "{$this}/dependencies");
    }

    /**
     * Premium feature.
     *
     * @return Task[]
     */
    public function getDependents () {
        return $this->api->loadAll($this, self::class, "{$this}/dependents");
    }

    /**
     * A proxy to the task's "external data".
     *
     * > :info:
     * > This always returns an instance, regardless of whether the task on Asana actually has external data.
     * >
     * > Asana will delete the external data object if it's emptied,
     * > and fetching it via `GET` will then return `null`, so we coalesce.
     *
     * @return ExternalData
     */
    public function getExternal () {
        return $this->_get('external') ?? $this->data['external'] = $this->api->factory($this, ExternalData::class);
    }

    /**
     * @return Project[]
     */
    public function getProjects () {
        return array_column($this->getMemberships(), 'project');
    }

    /**
     * @return Section[]
     */
    public function getSections () {
        return array_column($this->getMemberships(), 'section');
    }

    /**
     * @return Story[]
     */
    public function getStories () {
        return $this->api->loadAll($this, Story::class, "{$this}/stories");
    }

    /**
     * @return Task[]
     */
    public function getSubTasks () {
        return $this->api->loadAll($this, self::class, "{$this}/subtasks");
    }

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

    /**
     * @return TaskWebhook[]
     */
    public function getWebhooks () {
        return $this->api->loadAll($this, TaskWebhook::class, 'webhooks', [
            'workspace' => $this->getWorkspace()->getGid(),
            'resource' => $this->getGid()
        ]);
    }

    /**
     * Factory.
     *
     * @return Story
     */
    public function newComment () {
        return $this->api->factory($this, Story::class, [
            'resource_subtype' => Story::TYPE_COMMENT_ADDED,
            'target' => $this
        ]);
    }

    /**
     * Factory.
     *
     * @return Task
     */
    public function newSubTask () {
        /** @var Task $sub */
        $sub = $this->api->factory($this, self::class);
        return $sub->setParent($this);
    }

    /**
     * Factory.
     *
     * @return TaskWebhook
     */
    public function newWebhook () {
        /** @var TaskWebhook $webhook */
        $webhook = $this->api->factory($this, TaskWebhook::class);
        return $webhook->setResource($this);
    }

    /**
     * Premium feature.
     *
     * @param Task[] $tasks
     * @return $this
     */
    public function removeDependencies (array $tasks) {
        $this->api->post("{$this}/removeDependencies", ['dependencies' => array_column($tasks, 'gid')]);
        return $this;
    }

    /**
     * Premium feature.
     *
     * @param Task $task
     * @return $this
     */
    public function removeDependency (Task $task) {
        return $this->removeDependencies([$task]);
    }

    /**
     * Premium feature.
     *
     * @param Task $task
     * @return $this
     */
    public function removeDependent (Task $task) {
        return $this->removeDependents([$task]);
    }

    /**
     * Premium feature.
     *
     * @param Task[] $tasks
     * @return $this
     */
    public function removeDependents (array $tasks) {
        $this->api->post("{$this}/removeDependents", ['dependents' => array_column($tasks, 'gid')]);
        return $this;
    }

    /**
     * Removes a follower.
     *
     * @param User $user
     * @return $this
     */
    public function removeFollower (User $user) {
        return $this->removeFollowers([$user]);
    }

    /**
     * Removes followers.
     *
     * @see https://developers.asana.com/docs/remove-followers-from-a-task
     *
     * @param User[] $users
     * @return $this
     */
    public function removeFollowers (array $users) {
        return $this->_removeWithPost("{$this}/removeFollowers", [
            'followers' => array_column($users, 'gid')
        ], 'followers', $users);
    }

    /**
     * Removes the task from a project.
     *
     * @see https://developers.asana.com/docs/remove-a-project-from-a-task
     *
     * @param Project $project
     * @return $this
     */
    public function removeFromProject (Project $project) {
        return $this->_removeWithPost("{$this}/removeProject", [
            'project' => $project->getGid()
        ], 'memberships', function(Membership $membership) use ($project) {
            return $membership->getProject()->getGid() !== $project->getGid();
        });
    }

    /**
     * Removes a tag.
     *
     * @see https://developers.asana.com/docs/remove-a-tag-from-a-task
     *
     * @param Tag $tag
     * @return $this
     */
    public function removeTag (Tag $tag) {
        return $this->_removeWithPost("{$this}/removeTag", [
            'tag' => $tag->getGid()
        ], 'tags', [$tag]);
    }

    /**
     * Makes the task a subtask of another.
     *
     * @see https://developers.asana.com/docs/set-the-parent-of-a-task
     * @param null|Task $parent
     * @return $this
     */
    final public function setParent (?Task $parent) {
        assert(!$parent or $parent->hasGid());
        return $this->_setWithPost("{$this}/setParent", [
            'parent' => $parent
        ], 'parent', $parent);
    }

    /**
     * @return $this
     */
    public function update () {
        $this->_update();
        $this->_onSave();
        return $this;
    }

}

1			<?php
2
3			namespace Helix\Asana;
4
5			use Helix\Asana\Base\AbstractEntity;
6			use Helix\Asana\Base\AbstractEntity\CrudTrait;
7			use Helix\Asana\Base\AbstractEntity\DateTrait;
8			use Helix\Asana\Base\AbstractEntity\PostMutatorTrait;
9			use Helix\Asana\Base\AbstractEntity\SyncTrait;
10			use Helix\Asana\Project\Section;
11			use Helix\Asana\Task\Attachment;
12			use Helix\Asana\Task\ExternalData;
13			use Helix\Asana\Task\FieldEntries;
14			use Helix\Asana\Task\Like;
15			use Helix\Asana\Task\Membership;
16			use Helix\Asana\Task\Story;
17			use Helix\Asana\Webhook\TaskWebhook;
18
19			/**
20			* A task.
21			*
22			* @see https://developers.asana.com/docs/asana-tasks
23			* @see https://developers.asana.com/docs/task
24			*
25			* @see Workspace::newTask()
26			* @see Project::newTask()
27			* @see Section::newTask()
28			*
29			* @method $this setResourceSubtype (string $type) @depends create-only
30			* @method $this setWorkspace (Workspace $workspace) @depends create-only
31			*
32			* @method null\|User getAssignee ()
33			* @method string getAssigneeStatus ()
34			* @method bool isCompleted ()
35			* @method string getCompletedAt () RFC3339x
36			* @method string getCreatedAt () RFC3339x
37			* @method null\|FieldEntries getCustomFields () Premium feature.
38			* @method User[] getFollowers ()
39			* @method bool getIsRenderedAsSeparator ()
40			* @method bool isLiked () Whether you like the task.
41			* @method Like[] getLikes ()
42			* @method Membership[] getMemberships ()
43			* @method string getModifiedAt () RFC3339x
44			* @method string getName ()
45			* @method string getNotes ()
46			* @method int getNumLikes ()
47			* @method int getNumSubtasks ()
48			* @method null\|Task getParent ()
49			* @method string getResourceSubtype ()
50			* @method Tag[] getTags ()
51			* @method Workspace getWorkspace ()
52			*
53			* @method bool hasAssignee ()
54			* @method bool hasCustomFields () Premium feature.
55			* @method bool hasFollowers ()
56			* @method bool hasLikes ()
57			* @method bool hasMemberships ()
58			* @method bool hasName ()
59			* @method bool hasNotes ()
60			* @method bool hasParent ()
61			* @method bool hasTags ()
62			*
63			* @method $this setAssignee (?User $user)
64			* @method $this setAssigneeStatus (string $status)
65			* @method $this setCompleted (bool $completed)
66			* @method $this setIsRenderedAsSeparator (bool $flag)
67			* @method $this setLiked (bool $liked) Like or unlike the task.
68			* @method $this setName (string $name)
69			* @method $this setNotes (string $notes)
70			*
71			* @method Attachment[] selectAttachments (callable $filter) `fn( Attachment $attachment): bool`
72			* @method Task[] selectDependencies (callable $filter) `fn( Task $dependency ): bool`
73			* @method Task[] selectDependents (callable $filter) `fn( Task $dependent ): bool`
74			* @method User[] selectFollowers (callable $filter) `fn( User $user ): bool`
75			* @method Story[] selectComments (callable $filter) `fn( Story $comment ): bool`
76			* @method Like[] selectLikes (callable $filter) `fn( Like $like ): bool`
77			* @method Membership[] selectMemberships (callable $filter) `fn( Membership $membership ): bool`
78			* @method Project[] selectProjects (callable $filter) `fn( Project $project ): bool`
79			* @method Story[] selectStories (callable $filter) `fn( Story $story ): bool`
80			* @method Task[] selectSubTasks (callable $filter) `fn( Task $subtask ): bool`
81			* @method Tag[] selectTags (callable $filter) `fn( Tag $tag ): bool`
82			*/
83			class Task extends AbstractEntity {
84
85			use CrudTrait {
86			create as private _create;
87			update as private _update;
88			}
89
90			use DateTrait;
91			use PostMutatorTrait;
92			use SyncTrait;
93
94			const DIR = 'tasks';
95			const TYPE = 'task';
96
97			const TYPE_DEFAULT = 'default_task';
98			const TYPE_MILESTONE = 'milestone';
99
100			const ASSIGN_INBOX = 'inbox';
101			const ASSIGN_LATER = 'later';
102			const ASSIGN_NEW = 'new';
103			const ASSIGN_TODAY = 'today';
104			const ASSIGN_UPCOMING = 'upcoming';
105
106			const GET_INCOMPLETE = ['completed_since' => 'now'];
107
108			protected const MAP = [
109			'assignee' => User::class,
110			'custom_fields' => FieldEntries::class,
111			'external' => ExternalData::class, // opt-in
112			'followers' => [User::class],
113			'likes' => [Like::class],
114			'memberships' => [Membership::class],
115			'parent' => self::class,
116			'tags' => [Tag::class],
117			'workspace' => Workspace::class
118			];
119
120			const OPT_FIELDS = [
121			'memberships' => 'memberships.(project\|section)'
122			];
123
124			private function _onSave (): void {
125			/** @var FieldEntries $fields */
126			if ($fields = $this->data['custom_fields'] ?? null) {
127			$fields->__unset(true);
128			}
129			/** @var ExternalData $external */
130			if ($external = $this->data['external'] ?? null) {
131			$external->diff = [];
132			}
133			}
134
135			protected function _setData (array $data): void {
136			// hearts were deprecated for likes.
137			unset($data['hearted'], $data['hearts'], $data['num_hearts']);
138
139			// redundant. memberships are used instead.
140			unset($data['projects']);
141
142			// time-based deadlines are a little passive-aggressive, don't you think?
143			unset($data['due_at']);
144
145			parent::_setData($data);
146			}
147
148			/**
149			* Uploads a file attachment.
150			*
151			* @param string $file
152			* @return Attachment
153			*/
154			public function addAttachment (string $file) {
155			/** @var Attachment $attachment */
156			$attachment = $this->api->factory($this, Attachment::class, ['parent' => $this]);
157			return $attachment->create($file);
158			}
159
160			/**
161			* Premium feature.
162			*
163			* @param Task[] $tasks
164			* @return $this
165			*/
166			public function addDependencies (array $tasks) {
167			$this->api->post("{$this}/addDependencies", ['dependents' => array_column($tasks, 'gid')]);
168			return $this;
169			}
170
171			/**
172			* Premium feature.
173			*
174			* @param Task $task
175			* @return $this
176			*/
177			public function addDependency (Task $task) {
178			return $this->addDependencies([$task]);
179			}
180
181			/**
182			* Premium feature.
183			*
184			* @param Task $task
185			* @return $this
186			*/
187			public function addDependent (Task $task) {
188			return $this->addDependents([$task]);
189			}
190
191			/**
192			* Premium feature.
193			*
194			* @param Task[] $tasks
195			* @return $this
196			*/
197			public function addDependents (array $tasks) {
198			$this->api->post("{$this}/addDependents", ['dependents' => array_column($tasks, 'gid')]);
199			return $this;
200			}
201
202			/**
203			* Adds a follower.
204			*
205			* @param User $user
206			* @return $this
207			*/
208			public function addFollower (User $user) {
209			return $this->addFollowers([$user]);
210			}
211
212			/**
213			* Adds followers.
214			*
215			* @see https://developers.asana.com/docs/add-followers-to-a-task
216			*
217			* @param User[] $users
218			* @return $this
219			*/
220			public function addFollowers (array $users) {
221			return $this->_addWithPost("{$this}/addFollowers", [
222			'followers' => array_column($users, 'gid')
223			], 'followers', $users);
224			}
225
226			/**
227			* Adds a tag.
228			*
229			* @see https://developers.asana.com/docs/add-a-tag-to-a-task
230			*
231			* @param Tag $tag
232			* @return $this
233			*/
234			public function addTag (Tag $tag) {
235			assert($tag->hasGid());
236			return $this->_addWithPost("{$this}/addTag", [
237			'tag' => $tag->getGid()
238			], 'tags', [$tag]);
239			}
240
241			/**
242			* Adds the task to a project.
243			*
244			* @see https://developers.asana.com/docs/add-a-project-to-a-task
245			*
246			* @see Project::newTask()
247			* @see Section::newTask()
248			*
249			* @param Project\|Section $target
250			* @return $this
251			*/
252			public function addToProject ($target) {
253			assert($target->hasGid());
254			if ($target instanceof Project) {
255			$target = $target->getDefaultSection();
256			}
257			/** @var Membership $membership */
258			$membership = $this->api->factory($this, Membership::class);
259			$membership->setSection($target);
260			return $this->_addWithPost("{$this}/addProject", $membership->toArray(), 'memberships', [$membership]);
261			}
262
263			/**
264			* @return $this
265			*/
266			public function create () {
267			$this->_create();
268			$this->_onSave();
269			return $this;
270			}
271
272			/**
273			* Duplicates the task.
274			*
275			* @see https://developers.asana.com/docs/duplicate-a-task
276			*
277			* @param string $name
278			* @param string[] $include
279			* @return Job
280			*/
281			public function duplicate (string $name, array $include) {
282			/** @var array $remote */
283			$remote = $this->api->post("{$this}/duplicate", [
284			'name' => $name,
285			'include' => array_values($include)
286			]);
287			return $this->api->factory($this, Job::class, $remote);
288			}
289
290			/**
291			* Attached files.
292			*
293			* @return Attachment[]
294			*/
295			public function getAttachments () {
296			return $this->api->loadAll($this, Attachment::class, "{$this}/attachments");
297			}
298
299			/**
300			* @return Story[]
301			*/
302			public function getComments () {
303			return $this->selectStories(function(Story $story) {
304			return $story->isComment();
305			});
306			}
307
308			/**
309			* Premium feature.
310			*
311			* @return Task[]
312			*/
313			public function getDependencies () {
314			return $this->api->loadAll($this, self::class, "{$this}/dependencies");
315			}
316
317			/**
318			* Premium feature.
319			*
320			* @return Task[]
321			*/
322			public function getDependents () {
323			return $this->api->loadAll($this, self::class, "{$this}/dependents");
324			}
325
326			/**
327			* A proxy to the task's "external data".
328			*
329			* > :info:
330			* > This always returns an instance, regardless of whether the task on Asana actually has external data.
331			* >
332			* > Asana will delete the external data object if it's emptied,
333			* > and fetching it via `GET` will then return `null`, so we coalesce.
334			*
335			* @return ExternalData
336			*/
337			public function getExternal () {
338			return $this->_get('external') ?? $this->data['external'] = $this->api->factory($this, ExternalData::class);
339			}
340
341			/**
342			* @return Project[]
343			*/
344			public function getProjects () {
345			return array_column($this->getMemberships(), 'project');
346			}
347
348			/**
349			* @return Section[]
350			*/
351			public function getSections () {
352			return array_column($this->getMemberships(), 'section');
353			}
354
355			/**
356			* @return Story[]
357			*/
358			public function getStories () {
359			return $this->api->loadAll($this, Story::class, "{$this}/stories");
360			}
361
362			/**
363			* @return Task[]
364			*/
365			public function getSubTasks () {
366			return $this->api->loadAll($this, self::class, "{$this}/subtasks");
367			}
368
369			/**
370			* @return string
371			*/
372			final public function getUrl (): string {
373			return "https://app.asana.com/0/0/{$this->getGid()}";
374			}
375
376			/**
377			* @return TaskWebhook[]
378			*/
379			public function getWebhooks () {
380			return $this->api->loadAll($this, TaskWebhook::class, 'webhooks', [
381			'workspace' => $this->getWorkspace()->getGid(),
382			'resource' => $this->getGid()
383			]);
384			}
385
386			/**
387			* Factory.
388			*
389			* @return Story
390			*/
391			public function newComment () {
392			return $this->api->factory($this, Story::class, [
393			'resource_subtype' => Story::TYPE_COMMENT_ADDED,
394			'target' => $this
395			]);
396			}
397
398			/**
399			* Factory.
400			*
401			* @return Task
402			*/
403			public function newSubTask () {
404			/** @var Task $sub */
405			$sub = $this->api->factory($this, self::class);
406			return $sub->setParent($this);
407			}
408
409			/**
410			* Factory.
411			*
412			* @return TaskWebhook
413			*/
414			public function newWebhook () {
415			/** @var TaskWebhook $webhook */
416			$webhook = $this->api->factory($this, TaskWebhook::class);
417			return $webhook->setResource($this);
418			}
419
420			/**
421			* Premium feature.
422			*
423			* @param Task[] $tasks
424			* @return $this
425			*/
426			public function removeDependencies (array $tasks) {
427			$this->api->post("{$this}/removeDependencies", ['dependencies' => array_column($tasks, 'gid')]);
428			return $this;
429			}
430
431			/**
432			* Premium feature.
433			*
434			* @param Task $task
435			* @return $this
436			*/
437			public function removeDependency (Task $task) {
438			return $this->removeDependencies([$task]);
439			}
440
441			/**
442			* Premium feature.
443			*
444			* @param Task $task
445			* @return $this
446			*/
447			public function removeDependent (Task $task) {
448			return $this->removeDependents([$task]);
449			}
450
451			/**
452			* Premium feature.
453			*
454			* @param Task[] $tasks
455			* @return $this
456			*/
457			public function removeDependents (array $tasks) {
458			$this->api->post("{$this}/removeDependents", ['dependents' => array_column($tasks, 'gid')]);
459			return $this;
460			}
461
462			/**
463			* Removes a follower.
464			*
465			* @param User $user
466			* @return $this
467			*/
468			public function removeFollower (User $user) {
469			return $this->removeFollowers([$user]);
470			}
471
472			/**
473			* Removes followers.
474			*
475			* @see https://developers.asana.com/docs/remove-followers-from-a-task
476			*
477			* @param User[] $users
478			* @return $this
479			*/
480			public function removeFollowers (array $users) {
481			return $this->_removeWithPost("{$this}/removeFollowers", [
482			'followers' => array_column($users, 'gid')
483			], 'followers', $users);
484			}
485
486			/**
487			* Removes the task from a project.
488			*
489			* @see https://developers.asana.com/docs/remove-a-project-from-a-task
490			*
491			* @param Project $project
492			* @return $this
493			*/
494			public function removeFromProject (Project $project) {
495			return $this->_removeWithPost("{$this}/removeProject", [
496			'project' => $project->getGid()
497			], 'memberships', function(Membership $membership) use ($project) {
498			return $membership->getProject()->getGid() !== $project->getGid();
499			});
500			}
501
502			/**
503			* Removes a tag.
504			*
505			* @see https://developers.asana.com/docs/remove-a-tag-from-a-task
506			*
507			* @param Tag $tag
508			* @return $this
509			*/
510			public function removeTag (Tag $tag) {
511			return $this->_removeWithPost("{$this}/removeTag", [
512			'tag' => $tag->getGid()
513			], 'tags', [$tag]);
514			}
515
516			/**
517			* Makes the task a subtask of another.
518			*
519			* @see https://developers.asana.com/docs/set-the-parent-of-a-task
520			* @param null\|Task $parent
521			* @return $this
522			*/
523			final public function setParent (?Task $parent) {
524			assert(!$parent or $parent->hasGid());
525			return $this->_setWithPost("{$this}/setParent", [
526			'parent' => $parent
527			], 'parent', $parent);
528			}
529
530			/**
531			* @return $this
532			*/
533			public function update () {
534			$this->_update();
535			$this->_onSave();
536			return $this;
537			}
538
539			}

hfw / asana

Task::getDependents() A last analyzed 2020-11-23 04:28 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Task::getDependents() A
last analyzed 2020-11-23 04:28 UTC