Project::getStatuses() - Code Metrics - Inspection of "Portfolio :: "item" accessors renamed with "projec..." - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1f9a54...993a87 )

by y

created 2020-05-26 04:19 UTC

Project::getStatuses() A

↳ Parent: Project

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\CustomField\FieldSetting;
use Helix\Asana\CustomField\FieldSettingsTrait;
use Helix\Asana\Project\Section;
use Helix\Asana\Project\Status;
use Helix\Asana\Project\TaskCounts;
use Helix\Asana\Webhook\ProjectWebhook;
use IteratorAggregate;
use Traversable;

/**
 * A project.
 *
 * @see https://developers.asana.com/docs/asana-projects
 * @see https://developers.asana.com/docs/project
 *
 * @see Workspace::newProject()
 * @see Team::newProject()
 *
 * @method $this        setTeam             (?Team $team)           @depends create-only
 * @method $this        setWorkspace        (Workspace $workspace)  @depends create-only
 *
 * @method bool         isArchived          ()
 * @method string       getColor            ()
 * @method string       getCreatedAt        () RFC3339x
 * @method null|Status  getCurrentStatus    ()
 * @method User[]       getFollowers        ()
 * @method string       getIcon             ()
 * @method string       getLayout           ()
 * @method User[]       getMembers          ()
 * @method string       getModifiedAt       () RFC3339x
 * @method string       getName             ()
 * @method string       getNotes            ()
 * @method null|User    getOwner            ()
 * @method bool         isPublic            ()
 * @method null|Team    getTeam             ()
 * @method Workspace    getWorkspace        ()
 *
 * @method bool         hasFollowers        ()
 * @method bool         hasMembers          ()
 * @method bool         hasOwner            ()
 * @method bool         hasTeam             ()
 *
 * @method $this        setArchived         (bool $archived)
 * @method $this        setColor            (string $color)
 * @method $this        setLayout           (string $layout)
 * @method $this        setName             (string $name)
 * @method $this        setNotes            (string $notes)
 * @method $this        setOwner            (User $owner)
 * @method $this        setPublic           (bool $public)
 *
 * @method User[]       selectFollowers     (callable $filter) `fn( User $user ): bool`
 * @method User[]       selectMembers       (callable $filter) `fn( User $user ): bool`
 * @method Section[]    selectSections      (callable $filter) `fn( Section $section ): bool`
 * @method Status[]     selectStatuses      (callable $filter) `fn( Status $status ): bool`
 * @method Task[]       selectTasks         (callable $fn, array $apiX = Task::GET_INCOMPLETE) `fn( Task $task ): bool`
 */
class Project extends AbstractEntity implements IteratorAggregate {

    use CrudTrait;
    use DateTrait;
    use FieldSettingsTrait;
    use PostMutatorTrait;
    use SyncTrait;

    const DIR = 'projects';
    const TYPE = 'project';

    const LAYOUT_BOARD = 'board';
    const LAYOUT_LIST = 'list';

    const GET_ACTIVE = ['archived' => false];
    const GET_ARCHIVED = ['archived' => true];

    protected const MAP = [
        'current_status' => Status::class,
        'custom_field_settings' => [FieldSetting::class],
        'followers' => [User::class],
        'members' => [User::class],
        'owner' => User::class,
        'team' => Team::class,
        'workspace' => Workspace::class
    ];

    /**
     * @var Section
     */
    private $defaultSection;

    protected function _setData (array $data): void {
        // this is always empty. fields are in the settings, values are in tasks.
        unset($data['custom_fields']);

        // deprecated for due_on
        unset($data['due_date']);

        parent::_setData($data);
    }

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

    /**
     * @param User[] $users
     * @return $this
     */
    public function addFollowers (array $users) {
        return $this->_addWithPost("{$this}/addFollowers", [
            'followers' => array_column($users, 'gid')
        ], 'followers', $users);
    }

    /**
     * @param User $user
     * @return $this
     */
    public function addMember (User $user) {
        return $this->addMembers([$user]);
    }

    /**
     * @param User[] $users
     * @return $this
     */
    public function addMembers (array $users) {
        return $this->_addWithPost("{$this}/addMembers", [
            'members' => array_column($users, 'gid')
        ], 'members', $users);
    }

    /**
     * Duplicates the project.
     *
     * @see https://developers.asana.com/docs/duplicate-a-project
     *
     * If `$team` is `null`, the duplicate will inherit the existing team.
     *
     * If `$schedule` is given:
     * - It must have either `due_on` or `start_on`
     * - `task_dates` is automatically added to `$include`
     * - `should_skip_weekends` defaults to `true` if not given.
     *
     * @param string $name
     * @param string[] $include
     * @param null|Team $team
     * @param array $schedule
     * @return Job
     */
    public function duplicate (string $name, array $include, Team $team = null, array $schedule = []) {
        $data = ['name' => $name];
        if ($team) {
            $data['team'] = $team->getGid();
        }
        if ($schedule) {
            $include[] = 'task_dates';
            $schedule += ['should_skip_weekends' => true];
            $data['schedule_dates'] = $schedule;
        }
        $data['include'] = array_values($include);
        /** @var array $remote */
        $remote = $this->api->post("{$this}/duplicate", $data);
        return $this->api->factory($this, Job::class, $remote);
    }

    /**
     * @return Section
     */
    public function getDefaultSection () {
        return $this->defaultSection ?? $this->defaultSection = $this->getSections(1)[0];
    }

    /**
     * Iterates over sections.
     *
     * @see https://developers.asana.com/docs/get-sections-in-a-project
     *
     * @param int $limit
     * @return Traversable|Section[]
     */
    public function getIterator (int $limit = PHP_INT_MAX) {
        return $this->api->loadEach($this, Section::class, "{$this}/sections", ['limit' => $limit]);
    }

    /**
     * @param int $limit
     * @return Section[]
     */
    public function getSections (int $limit = PHP_INT_MAX) {
        return iterator_to_array($this->getIterator($limit));
    }

    /**
     * @return Status[]
     */
    public function getStatuses () {
        return $this->api->loadAll($this, Status::class, "{$this}/project_statuses");
    }

    /**
     * @return TaskCounts
     */
    public function getTaskCounts () {
        $remote = $this->api->get("{$this}/task_counts", [
            'opt_fields' => // opt_expand doesn't work.
                'num_completed_milestones,'
                . 'num_completed_tasks,'
                . 'num_incomplete_milestones,'
                . 'num_incomplete_tasks,'
                . 'num_milestones,'
                . 'num_tasks'
        ]);
        return $this->api->factory($this, TaskCounts::class, $remote);
    }

    /**
     * The project's tasks.
     *
     * @param array $filter
     * @return Task[]
     */
    public function getTasks (array $filter = Task::GET_INCOMPLETE) {
        $filter['project'] = $this->getGid();
        return $this->api->loadAll($this, Task::class, "tasks", $filter);
    }

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

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

    /**
     * @return bool
     */
    final public function isBoard (): bool {
        return $this->getLayout() === self::LAYOUT_BOARD;
    }

    /**
     * @return bool
     */
    final public function isList (): bool {
        return $this->getLayout() === self::LAYOUT_LIST;
    }

    /**
     * @return bool
     */
    final public function isTemplate (): bool {
        return $this->_is('is_template');
    }

    /**
     * Factory.
     *
     * @return Section
     */
    public function newSection () {
        return $this->api->factory($this, Section::class, ['project' => $this]);
    }

    /**
     * Factory.
     *
     * @return Status
     */
    public function newStatus () {
        return $this->api->factory($this, Status::class);
    }

    /**
     * Factory.
     *
     * @return Task
     */
    public function newTask () {
        return $this->getDefaultSection()->newTask();
    }

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

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

    /**
     * @param User[] $users
     * @return $this
     */
    public function removeFollowers (array $users) {
        return $this->_removeWithPost("{$this}/removeFollowers", [
            'followers' => array_column($users, 'gid')
        ], 'followers', $users);
    }

    /**
     * @param User $user
     * @return $this
     */
    public function removeMember (User $user) {
        return $this->removeMembers([$user]);
    }

    /**
     * @param User[] $users
     * @return $this
     */
    public function removeMembers (array $users) {
        return $this->_removeWithPost("{$this}/removeMembers", [
            'members' => array_column($users, 'gid')
        ], 'members', $users);
    }
}

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\CustomField\FieldSetting;
11			use Helix\Asana\CustomField\FieldSettingsTrait;
12			use Helix\Asana\Project\Section;
13			use Helix\Asana\Project\Status;
14			use Helix\Asana\Project\TaskCounts;
15			use Helix\Asana\Webhook\ProjectWebhook;
16			use IteratorAggregate;
17			use Traversable;
18
19			/**
20			* A project.
21			*
22			* @see https://developers.asana.com/docs/asana-projects
23			* @see https://developers.asana.com/docs/project
24			*
25			* @see Workspace::newProject()
26			* @see Team::newProject()
27			*
28			* @method $this setTeam (?Team $team) @depends create-only
29			* @method $this setWorkspace (Workspace $workspace) @depends create-only
30			*
31			* @method bool isArchived ()
32			* @method string getColor ()
33			* @method string getCreatedAt () RFC3339x
34			* @method null\|Status getCurrentStatus ()
35			* @method User[] getFollowers ()
36			* @method string getIcon ()
37			* @method string getLayout ()
38			* @method User[] getMembers ()
39			* @method string getModifiedAt () RFC3339x
40			* @method string getName ()
41			* @method string getNotes ()
42			* @method null\|User getOwner ()
43			* @method bool isPublic ()
44			* @method null\|Team getTeam ()
45			* @method Workspace getWorkspace ()
46			*
47			* @method bool hasFollowers ()
48			* @method bool hasMembers ()
49			* @method bool hasOwner ()
50			* @method bool hasTeam ()
51			*
52			* @method $this setArchived (bool $archived)
53			* @method $this setColor (string $color)
54			* @method $this setLayout (string $layout)
55			* @method $this setName (string $name)
56			* @method $this setNotes (string $notes)
57			* @method $this setOwner (User $owner)
58			* @method $this setPublic (bool $public)
59			*
60			* @method User[] selectFollowers (callable $filter) `fn( User $user ): bool`
61			* @method User[] selectMembers (callable $filter) `fn( User $user ): bool`
62			* @method Section[] selectSections (callable $filter) `fn( Section $section ): bool`
63			* @method Status[] selectStatuses (callable $filter) `fn( Status $status ): bool`
64			* @method Task[] selectTasks (callable $fn, array $apiX = Task::GET_INCOMPLETE) `fn( Task $task ): bool`
65			*/
66			class Project extends AbstractEntity implements IteratorAggregate {
67
68			use CrudTrait;
69			use DateTrait;
70			use FieldSettingsTrait;
71			use PostMutatorTrait;
72			use SyncTrait;
73
74			const DIR = 'projects';
75			const TYPE = 'project';
76
77			const LAYOUT_BOARD = 'board';
78			const LAYOUT_LIST = 'list';
79
80			const GET_ACTIVE = ['archived' => false];
81			const GET_ARCHIVED = ['archived' => true];
82
83			protected const MAP = [
84			'current_status' => Status::class,
85			'custom_field_settings' => [FieldSetting::class],
86			'followers' => [User::class],
87			'members' => [User::class],
88			'owner' => User::class,
89			'team' => Team::class,
90			'workspace' => Workspace::class
91			];
92
93			/**
94			* @var Section
95			*/
96			private $defaultSection;
97
98			protected function _setData (array $data): void {
99			// this is always empty. fields are in the settings, values are in tasks.
100			unset($data['custom_fields']);
101
102			// deprecated for due_on
103			unset($data['due_date']);
104
105			parent::_setData($data);
106			}
107
108			/**
109			* @param User $user
110			* @return $this
111			*/
112			public function addFollower (User $user) {
113			return $this->addFollowers([$user]);
114			}
115
116			/**
117			* @param User[] $users
118			* @return $this
119			*/
120			public function addFollowers (array $users) {
121			return $this->_addWithPost("{$this}/addFollowers", [
122			'followers' => array_column($users, 'gid')
123			], 'followers', $users);
124			}
125
126			/**
127			* @param User $user
128			* @return $this
129			*/
130			public function addMember (User $user) {
131			return $this->addMembers([$user]);
132			}
133
134			/**
135			* @param User[] $users
136			* @return $this
137			*/
138			public function addMembers (array $users) {
139			return $this->_addWithPost("{$this}/addMembers", [
140			'members' => array_column($users, 'gid')
141			], 'members', $users);
142			}
143
144			/**
145			* Duplicates the project.
146			*
147			* @see https://developers.asana.com/docs/duplicate-a-project
148			*
149			* If `$team` is `null`, the duplicate will inherit the existing team.
150			*
151			* If `$schedule` is given:
152			* - It must have either `due_on` or `start_on`
153			* - `task_dates` is automatically added to `$include`
154			* - `should_skip_weekends` defaults to `true` if not given.
155			*
156			* @param string $name
157			* @param string[] $include
158			* @param null\|Team $team
159			* @param array $schedule
160			* @return Job
161			*/
162			public function duplicate (string $name, array $include, Team $team = null, array $schedule = []) {
163			$data = ['name' => $name];
164			if ($team) {
165			$data['team'] = $team->getGid();
166			}
167			if ($schedule) {
168			$include[] = 'task_dates';
169			$schedule += ['should_skip_weekends' => true];
170			$data['schedule_dates'] = $schedule;
171			}
172			$data['include'] = array_values($include);
173			/** @var array $remote */
174			$remote = $this->api->post("{$this}/duplicate", $data);
175			return $this->api->factory($this, Job::class, $remote);
176			}
177
178			/**
179			* @return Section
180			*/
181			public function getDefaultSection () {
182			return $this->defaultSection ?? $this->defaultSection = $this->getSections(1)[0];
183			}
184
185			/**
186			* Iterates over sections.
187			*
188			* @see https://developers.asana.com/docs/get-sections-in-a-project
189			*
190			* @param int $limit
191			* @return Traversable\|Section[]
192			*/
193			public function getIterator (int $limit = PHP_INT_MAX) {
194			return $this->api->loadEach($this, Section::class, "{$this}/sections", ['limit' => $limit]);
195			}
196
197			/**
198			* @param int $limit
199			* @return Section[]
200			*/
201			public function getSections (int $limit = PHP_INT_MAX) {
202			return iterator_to_array($this->getIterator($limit));
203			}
204
205			/**
206			* @return Status[]
207			*/
208			public function getStatuses () {
209			return $this->api->loadAll($this, Status::class, "{$this}/project_statuses");
210			}
211
212			/**
213			* @return TaskCounts
214			*/
215			public function getTaskCounts () {
216			$remote = $this->api->get("{$this}/task_counts", [
217			'opt_fields' => // opt_expand doesn't work.
218			'num_completed_milestones,'
219			. 'num_completed_tasks,'
220			. 'num_incomplete_milestones,'
221			. 'num_incomplete_tasks,'
222			. 'num_milestones,'
223			. 'num_tasks'
224			]);
225			return $this->api->factory($this, TaskCounts::class, $remote);
226			}
227
228			/**
229			* The project's tasks.
230			*
231			* @param array $filter
232			* @return Task[]
233			*/
234			public function getTasks (array $filter = Task::GET_INCOMPLETE) {
235			$filter['project'] = $this->getGid();
236			return $this->api->loadAll($this, Task::class, "tasks", $filter);
237			}
238
239			/**
240			* @return string
241			*/
242			final public function getUrl (): string {
243			return "https://app.asana.com/0/{$this->getGid()}";
244			}
245
246			/**
247			* @return ProjectWebhook[]
248			*/
249			public function getWebhooks () {
250			return $this->api->loadAll($this, ProjectWebhook::class, 'webhooks', [
251			'workspace' => $this->getWorkspace()->getGid(),
252			'resource' => $this->getGid()
253			]);
254			}
255
256			/**
257			* @return bool
258			*/
259			final public function isBoard (): bool {
260			return $this->getLayout() === self::LAYOUT_BOARD;
261			}
262
263			/**
264			* @return bool
265			*/
266			final public function isList (): bool {
267			return $this->getLayout() === self::LAYOUT_LIST;
268			}
269
270			/**
271			* @return bool
272			*/
273			final public function isTemplate (): bool {
274			return $this->_is('is_template');
275			}
276
277			/**
278			* Factory.
279			*
280			* @return Section
281			*/
282			public function newSection () {
283			return $this->api->factory($this, Section::class, ['project' => $this]);
284			}
285
286			/**
287			* Factory.
288			*
289			* @return Status
290			*/
291			public function newStatus () {
292			return $this->api->factory($this, Status::class);
293			}
294
295			/**
296			* Factory.
297			*
298			* @return Task
299			*/
300			public function newTask () {
301			return $this->getDefaultSection()->newTask();
302			}
303
304			/**
305			* Factory.
306			*
307			* @return ProjectWebhook
308			*/
309			public function newWebhook () {
310			/** @var ProjectWebhook $webhook */
311			$webhook = $this->api->factory($this, ProjectWebhook::class);
312			return $webhook->setResource($this);
313			}
314
315			/**
316			* @param User $user
317			* @return $this
318			*/
319			public function removeFollower (User $user) {
320			return $this->removeFollowers([$user]);
321			}
322
323			/**
324			* @param User[] $users
325			* @return $this
326			*/
327			public function removeFollowers (array $users) {
328			return $this->_removeWithPost("{$this}/removeFollowers", [
329			'followers' => array_column($users, 'gid')
330			], 'followers', $users);
331			}
332
333			/**
334			* @param User $user
335			* @return $this
336			*/
337			public function removeMember (User $user) {
338			return $this->removeMembers([$user]);
339			}
340
341			/**
342			* @param User[] $users
343			* @return $this
344			*/
345			public function removeMembers (array $users) {
346			return $this->_removeWithPost("{$this}/removeMembers", [
347			'members' => array_column($users, 'gid')
348			], 'members', $users);
349			}
350			}

hfw / asana

Push — master ( 1f9a54...993a87 )

Project::getStatuses() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like