Task::isRenderedAsSeparator() - Code Metrics - Inspection of "docs, tweaks" - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( b66c10...181037 )

by y
created 2020-05-11 13:21 UTC
Task::isRenderedAsSeparator() A

↳ 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\WorkspaceTrait;
use Helix\Asana\Event\StoryEvent;
use Helix\Asana\Event\TaskEvent;
use Helix\Asana\Project\Section;
use Helix\Asana\Task\Attachment;
use Helix\Asana\Task\CustomValues;
use Helix\Asana\Task\External;
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
 *
 * @method null|User    getAssignee         ()
 * @method bool         hasAssignee         ()
 * @method $this        setAssignee         (null|User $user)
 * @method string       getAssigneeStatus   ()
 * @method $this        setAssigneeStatus   (string $status)
 * @method bool         isCompleted         ()
 * @method $this        setCompleted        (bool $completed)
 * @method string       getCompletedAt      ()
 * @method string       getCreatedAt        ()
 * @method null|CustomValues getCustomFields() Premium only.
 * @method bool         hasCustomFields     () Premium only.
 * @method string       getDueOn            ()
 * @method $this        setDueOn            (string $date)
 * @method User[]       getFollowers        ()
 * @method bool         hasFollowers        ()
 * @method string       getHtmlNotes        ()
 * @method $this        setHtmlNotes        (string $notes)
 * @method bool         isLiked             ()
 * @method $this        setLiked            (bool $liked)
 * @method Like[]       getLikes            ()
 * @method Membership[] getMemberships      ()
 * @method bool         hasMemberships      ()
 * @method string       getModifiedAt       ()
 * @method string       getName             ()
 * @method $this        setName             (string $name)
 * @method string       getNotes            ()
 * @method $this        setNotes            (string $notes)
 * @method int          getNumLikes         ()
 * @method int          getNumSubtasks      ()
 * @method null|Task    getParent           ()
 * @method bool         hasParent           ()
 * @method string       getResourceSubtype  ()
 * @method $this        setResourceSubtype  (string $type)
 * @method string       getStartOn          ()
 * @method $this        setStartOn          (string $date)
 * @method Tag[]        getTags             ()
 * @method bool         hasTags             ()
 */
class Task extends AbstractEntity {

    use CrudTrait;
    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';

    protected static $map = [
        'assignee' => User::class,
        'custom_fields' => CustomValues::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
    ];

    protected static $optFields = [
        'memberships' => 'memberships.(project|section)'
    ];

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

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

    protected function _save (string $dir = null) {
        parent::_save($dir);
        // use isset() to avoid has() fetch.
        if (isset($this->data['custom_fields'])) {
            $this->getCustomFields()->diff = [];
        }
        if (isset($this->data['external'])) {
            $this->getExternal()->diff = [];
        }
        return $this;
    }

    protected function _setData (array $data): void {
        unset($data['hearted']); // deprecated for likes
        unset($data['hearts']); // deprecated for likes
        unset($data['projects']); // redundant, memberships are used instead
        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->factory(Attachment::class, ['parent' => $this]);
        return $attachment->upload($file);
    }

    /**
     * Posts a comment on an existing task and returns it.
     *
     * @param string $text
     * @return Story
     */
    public function addComment (string $text) {
        return $this->newComment()->setText($text)->create();
        return $this->newComment()->/** @scrutinizer ignore-call */ 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 / section.
     *
     * @see https://developers.asana.com/docs/add-a-project-to-a-task
     *
     * @param Project $project
     * @param Section|null $section
     * @return $this
     */
    public function addToProject (Project $project, Section $section = null) {
        /** @var Membership $membership */
        $membership = $this->factory(Membership::class)
            ->_set('project', $project)
            ->_set('section', $section);
        return $this->_addWithPost("{$this}/addProject", $membership->toArray(), 'memberships', [$membership]);
    }

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

    /**
     * Creates and returns job to duplicate 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->factory(Job::class, $remote);
    }

    /**
     * Returns the task's files.
     *
     * @depends after-create
     * @return Attachment[]
     */
    public function getAttachments () {
        return $this->loadAll(Attachment::class, "{$this}/attachments");
    }

    /**
     * Returns the task's comments.
     *
     * @depends after-create
     * @return Story[]
     */
    public function getComments () {
        return array_values(array_filter($this->getStories(), function(Story $story) {
            return $story->isComment();
        }));
    }

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

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

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

    }

    /**
     * This always returns an instance, regardless of whether the task on Asana actually has external data.
     *
     * Developer's note: 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->factory(External::class);
    }

    /**
     * @return Project[]
     */
    public function getProjects () {
        return array_map(function(Membership $membership) {
            return $membership->getProject();
        }, $this->getMemberships());
    }

    /**
     * Returns the task's activity.
     *
     * @depends after-create
     * @return Story[]
     */
    public function getStories () {
        return $this->loadAll(Story::class, "{$this}/stories");
    }

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

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

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

    /**
     * @return bool
     */
    public function isRenderedAsSeparator (): bool {
        return $this->_is('is_rendered_as_separator');
    }

    /**
     * Instantiates and returns a new comment.
     *
     * @depends after-create
     * @return Story
     */
    public function newComment () {
        /** @var Story $comment */
        $comment = $this->factory(Story::class, [
            'resource_subtype' => Story::TYPE_COMMENT_ADDED
        ]);
        return $comment->_set('task', $this);
    }

    /**
     * Instantiates and returns a new subtask.
     *
     * @depends after-create
     * @return Task
     */
    public function newSubTask () {
        /** @var Task $sub */
        $sub = $this->factory(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);
    }

    /**
     * @param bool $flag
     * @return $this
     */
    public function setRenderedAsSeparator (bool $flag) {
        return $this->_set('is_rendered_as_separator', $flag);
    }

}
hfw / asana

Push — master ( b66c10...181037 )

Task::isRenderedAsSeparator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
