Project::getIterator() - Code Metrics - Inspection of "Api->_loadEach() generator. iterable entities. int..." - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( fbd180...23ab98 )

by y
created 2020-05-13 08:11 UTC
Project::getIterator() 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
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	2
rs	10
<?php

namespace Helix\Asana;

use Helix\Asana\Base\AbstractEntity;
use Helix\Asana\Base\AbstractEntity\CrudTrait;
use Helix\Asana\Base\AbstractEntity\WorkspaceTrait;
use Helix\Asana\CustomField\FieldSetting;
use Helix\Asana\CustomField\FieldSettingsTrait;
use Helix\Asana\Event\ProjectEvent;
use Helix\Asana\Event\StoryEvent;
use Helix\Asana\Event\TaskEvent;
use Helix\Asana\Project\Section;
use Helix\Asana\Project\Status;
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 $this        setArchived         (bool $archived)
 * @method string       getColor            ()
 * @method $this        setColor            (null|string $color)
 * @method string       getCreatedAt        () RFC3339x
 * @method null|Status  getCurrentStatus    ()
 * @method string       getDueOn            ()
 * @method $this        setDueOn            (string $date)
 * @method User[]       getFollowers        ()
 * @method User[]       selectFollowers     ()
 * @method string       getIcon             ()
 * @method string       getLayout           ()
 * @method $this        setLayout           (string $layout)
 * @method User[]       getMembers          ()
 * @method User[]       selectMembers       ()
 * @method string       getModifiedAt       ()
 * @method string       getName             ()
 * @method $this        setName             (string $name)
 * @method string       getNotes            ()
 * @method $this        setNotes            (string $notes)
 * @method null|User    getOwner            ()
 * @method $this        setOwner            (User $owner)
 * @method bool         isPublic            ()
 * @method $this        setPublic           (bool $public)
 * @method string       getStartOn          ()
 * @method $this        setStartOn          (string $date)
 * @method null|Team    getTeam             ()
 * @method bool         hasTeam             ()
 */
class Project extends AbstractEntity implements IteratorAggregate {

    use CrudTrait;
    use FieldSettingsTrait;
    use WorkspaceTrait;

    const TYPE = 'project';

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

    protected static $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
    ];

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

    final protected function _getDir (): string {
        return 'projects';
    }

    protected function _setData (array $data): void {
        // this is always empty. fields are in the settings, values are in tasks.
        unset($data['custom_fields']);
        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->_factory(ProjectWebhook::class);
        return $webhook->create($this, $target);
    }

    /**
     * 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 Team|null $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);
        $remote = $this->api->post("{$this}/duplicate", $data);
        return $this->_factory(Job::class, $remote);
        return $this->_factory(Job::class, /** @scrutinizer ignore-type */ $remote);
    }

    /**
     * @depends after-create
     * @return Section
     */
    public function getDefaultSection () {
        return $this->_loadAll(Section::class, "{$this}/sections", ['limit' => 1])[0];
    }

    /**
     * Returns events since the last sync.
     *
     * @depends after-create
     * @param null|string $token
     * @return ProjectEvent[]|TaskEvent[]|StoryEvent[]
     */
    public function getEvents (&$token) {
        return $this->api->sync($this, $token);
    }

    /**
     * @return Traversable|Section[]
     */
    public function getIterator () {
        return $this->_loadEach(Section::class, "{$this}/sections");
    }

    /**
     * @depends after-create
     * @return Section[]
     */
    public function getSections () {
        return iterator_to_array($this);
    }

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

    /**
     * The project's tasks.
     *
     * @depends after-create
     * @param array $filter
     * @return Task[]
     */
    public function getTasks (array $filter = []) {
        $filter['project'] = $this->getGid();
        return $this->_loadAll(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->_loadAll(ProjectWebhook::class, 'webhooks', [
            'workspace' => $this->getWorkspace()->getGid(),
            'resource' => $this->getGid()
        ]);
    }

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

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

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

    /**
     * @depends after-create
     * @return Status
     */
    public function newStatus () {
        return $this->_factory(Status::class);
    }

    /**
     * Instantiates and returns a new task in the default section of the project.
     *
     * @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);
    }

    /**
     * @param callable $filter `fn( Section $section ): bool`
     * @return Section[]
     */
    public function selectSections (callable $filter) {
        return $this->_select($this->getSections(), $filter);
    }

    /**
     * @param callable $filter `fn( Status $status ): bool`
     * @return Status[]
     */
    public function selectStatuses (callable $filter) {
        return $this->_select($this->getStatuses(), $filter);
    }

    /**
     * @param callable $filter `fn( Task $task ): bool`
     * @param array $apiFilter Pre-filter given to the API to reduce network load.
     * @return Task[]
     */
    public function selectTasks (callable $filter, array $apiFilter = []) {
        return $this->_select($this->getTasks($apiFilter), $filter);
    }

    /**
     * @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);
    }
}
hfw / asana

Push — master ( fbd180...23ab98 )

Project::getIterator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
