Project::__toString() - Code Metrics - Inspection of "AbstractEntity :: refactored REST path resolution" - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2428ce...06a092 )

by y

created 2020-05-25 05:55 UTC

Project::__toString() A

↳ Parent: Project::_setData()

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\Base\AbstractEntity\WorkspaceTrait;
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
 *
 * @method bool         isArchived          ()
 * @method string       getColor            () @depends after-create
 * @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 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;
    use WorkspaceTrait;

    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);
    }

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

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

    /**
     * @depends after-create
     * @param string $target
     * @return ProjectWebhook
     */
    public function addWebhook (string $target) {
        /** @var ProjectWebhook $webhook */
        $webhook = $this->api->factory($this, ProjectWebhook::class);
        $webhook->_set('resource', $this);
        $webhook->_set('target', $target);
        return $webhook->create();
    }

    /**
     * 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.
     *
     * @depends after-create
     * @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);
    }

    /**
     * @depends after-create
     * @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]);
    }

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

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

    /**
     * @depends after-create
     * @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.
     *
     * @depends after-create
     * @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);
    }

    /**
     * @depends after-create
     * @return string
     */
    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;
    }

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

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

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

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

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

    /**
     * @depends create-only
     * @param null|Team $team
     * @return $this
     */
    public function setTeam (?Team $team) {
        if ($team and !$this->hasWorkspace()) {
            $this->setWorkspace($team->getOrganization());
        }
        return $this->_set('team', $team);
    }
}

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

hfw / asana

Push — master ( 2428ce...06a092 )

Project::__toString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like