Task::getAttachments() - Code Metrics - Inspection of "SyncTrait :: new trait to add ->getEvents()" - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8f2f39...434123 )

by y

created 2020-05-23 10:47 UTC

Task::getAttachments() A

↳ Parent: Task

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
c	1
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\External;
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;
use Helix\Asana\Workspace\WorkspaceTrait;

/**
 * A task.
 *
 * @see https://developers.asana.com/docs/asana-tasks
 * @see https://developers.asana.com/docs/task
 *
 * @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 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 $this                setResourceSubtype          (string $type) @depends create-only
 *
 * @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;
    use WorkspaceTrait;

    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' => External::class, // not included by expanding "this". always lazy.
        '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)'
    ];

    /**
     * `tasks/{gid}`
     *
     * @return string
     */
    final public function __toString (): string {
        return "tasks/{$this->getGid()}";
    }

    /**
     * `tasks`
     *
     * @return string
     */
    final protected function _getDir (): string {
        return 'tasks';
    }

    private function _onSave (): void {
        /** @var FieldEntries $fields */
        if ($fields = $this->data['custom_fields'] ?? null) {
            $fields->__unset(true);
        }
        /** @var External $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.
     *
     * @depends after-create
     * @param string $file
     * @return Attachment
     */
    public function addAttachment (string $file) {
        /** @var Attachment $attachment */
        $attachment = $this->api->factory($this, Attachment::class, ['parent' => $this]);
        return $attachment->upload($file);
    }

    /**
     * Posts a new comment.
     *
     * @depends after-create
     * @param string $text
     * @return Story
     */
    public function addComment (string $text) {
        return $this->newComment()->setText($text)->create();
    }

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

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

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

    /**
     * Premium feature.
     *
     * @depends after-create
     * @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) {
        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::getDefaultSection()
     *
     * @param Section $section
     * @return $this
     */
    public function addToProject (Section $section) {
        /** @var Membership $membership */
        $membership = $this->api->factory($this, Membership::class)
            ->_set('project', $section->getProject())
            ->_set('section', $section);
        return $this->_addWithPost("{$this}/addProject", $membership->toArray(), 'memberships', [$membership]);
    }

    /**
     * Creates a webhook.
     *
     * @depends after-create
     * @param string $target
     * @return TaskWebhook
     */
    public function addWebhook (string $target) {
        /** @var TaskWebhook $webhook */
        $webhook = $this->api->factory($this, TaskWebhook::class);
        return $webhook->create($this, $target);
    }

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

    /**
     * Duplicates the task.
     *
     * @see https://developers.asana.com/docs/duplicate-a-task
     *
     * @depends after-create
     * @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.
     *
     * @depends after-create
     * @return Attachment[]
     */
    public function getAttachments () {
        return $this->api->loadAll($this, Attachment::class, "{$this}/attachments");
    }

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

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

    /**
     * Premium feature.
     *
     * @depends after-create
     * @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 External
     */
    public function getExternal () {
        return $this->_get('external') ?? $this->data['external'] = $this->api->factory($this, External::class);
    }

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

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

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

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

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

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

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

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

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

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

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

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

hfw / asana

Push — master ( 8f2f39...434123 )

Task::getAttachments() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like