Workspace::findPortfolios() - Code Metrics - Inspection of "moved Api->getUserByEmail() to Workspace" - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 023346...878e6c )

by y
created 2020-05-05 03:29 UTC
Workspace::findPortfolios() A

↳ Parent: Workspace
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	2
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\UpdateTrait;
use Helix\Asana\Webhook\ProjectWebhook;
use Helix\Asana\Webhook\TaskWebhook;
use Helix\Asana\Workspace\OrganizationExport;

/**
 * A workspace.
 *
 * Workspaces cannot be created or deleted through the API, but they can be updated.
 *
 * @see https://developers.asana.com/docs/#asana-workspaces
 * @see https://developers.asana.com/docs/#tocS_Workspace
 *
 * @method string[] getEmailDomains ()
 * @method string   getName         ()
 * @method $this    setName         (string $name)
 */
class Workspace extends AbstractEntity {

    use UpdateTrait;

    const TYPE = 'workspace';

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

    /**
     * Initiates and returns an asynchronous export for the organization.
     *
     * @return OrganizationExport
     */
    public function export () {
        assert($this->isOrganization());
        /** @var OrganizationExport $export */
        $export = $this->factory(OrganizationExport::class);
        return $export->create($this);
    }

    /**
     * Finds entities via the typeahead endpoint.
     *
     * @see https://developers.asana.com/docs/#get-objects-via-typeahead
     *
     * @param string $class
     * @param string $resourceType
     * @param string $text
     * @param int $limit 1-100
     * @return array|AbstractEntity[]
     */
    protected function find (string $class, string $resourceType, string $text, int $limit = 20) {
        return $this->loadAll($class, "{$this}/typeahead", [
            'resource_type' => $resourceType,
            'query' => $text,
            'count' => $limit
        ]);
    }

    /**
     * Finds custom fields via the typeahead endpoint.
     *
     * @param string $text
     * @param int $limit 1-100
     * @return CustomField[]
     */
    public function findCustomFields (string $text, int $limit = 20) {
        return $this->find(CustomField::class, CustomField::TYPE, $text, $limit);
    }

    /**
     * Finds portfolios via the typeahead endpoint.
     *
     * @param string $text
     * @param int $limit 1-100
     * @return Portfolio[]
     */
    public function findPortfolios (string $text, int $limit = 20) {
        return $this->find(Portfolio::class, Portfolio::TYPE, $text, $limit);
    }

    /**
     * Finds projects via the typeahead endpoint.
     *
     * @param string $text
     * @param int $limit 1-100
     * @return Project[]
     */
    public function findProjects (string $text, int $limit = 20) {
        return $this->find(Project::class, Project::TYPE, $text, $limit);
    }

    /**
     * Finds tags via the typeahead endpoint.
     *
     * @param string $text
     * @param int $limit 1-100
     * @return Tag[]
     */
    public function findTags (string $text, int $limit = 20) {
        return $this->find(Tag::class, Tag::TYPE, $text, $limit);
    }

    /**
     * Finds tasks via the typeahead endpoint.
     *
     * @param string $text
     * @param int $limit 1-100
     * @return Task[]
     */
    public function findTasks (string $text, int $limit = 20) {
        return $this->find(Task::class, Task::TYPE, $text, $limit);
    }

    /**
     * Finds users via the typeahead endpoint.
     *
     * @param string $text
     * @param int $limit 1-100
     * @return User[]
     */
    public function findUsers (string $text, int $limit = 20) {
        return $this->find(User::class, User::TYPE, $text, $limit);
    }

    /**
     * @return Project[]
     */
    public function getProjects () {
        return $this->loadAll(Project::class, 'projects', ['workspace' => $this->getGid()]);
    }

    /**
     * @return Tag[]
     */
    public function getTags () {
        return $this->loadAll(Tag::class, 'tags', ['workspace' => $this->getGid()]);
    }

    /**
     * @return Team[]
     */
    public function getTeams () {
        return $this->loadAll(Team::class, "organizations/{$this->getGid()}/teams");
    }

    /**
     * @param string $email
     * @return null|User
     */
    public function getUserByEmail (string $email) {
        return $this->api->getCache()->get($email, $this, function() use ($email) {
            foreach ($this->getUsers() as $user) {
                if ($user->getEmail() === $email) {
                    return $user;
                }
            }
            return null;
        });
    }

    /**
     * @return User[]
     */
    public function getUsers () {
        return $this->loadAll(User::class, "{$this}/users");
    }

    /**
     * Returns all webhooks belonging to the workspace.
     *
     * @return ProjectWebhook[]|TaskWebhook[]
     */
    public function getWebhooks () {
        $all = $this->api->get('webhooks', ['workspace' => $this->getGid()], ['expand' => 'this']);
        return array_map(function(array $each) {
            return $this->api->getCache()->get($each['gid'], $this, function() use ($each) {
                static $classes = [
                    Project::TYPE => ProjectWebhook::class,
                    Task::TYPE => TaskWebhook::class
                ];
                return $this->factory($classes[$each['resource_type']], $each);
            });
        }, $all);
        }, /** @scrutinizer ignore-type */ $all);
    }

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

    /**
     * Returns a new custom field for the workspace.
     *
     * @return CustomField
     */
    public function newCustomField () {
        /** @var CustomField $field */
        $field = $this->factory(CustomField::class);
        return $field->setWorkspace($this);
    }

    /**
     * Returns a new portfolio for the workspace.
     *
     * @return Portfolio
     */
    public function newPortfolio () {
        /** @var Portfolio $portfolio */
        $portfolio = $this->factory(Portfolio::class);
        return $portfolio->setWorkspace($this);
    }

    /**
     * Returns a new project for the workspace.
     *
     * @return Project
     */
    public function newProject () {
        /** @var Project $project */
        $project = $this->factory(Project::class);
        return $project->setWorkspace($this);
    }

    /**
     * Returns a new tag for the workspace.
     *
     * @return Tag
     */
    public function newTag () {
        /** @var Tag $tag */
        $tag = $this->factory(Tag::class);
        return $tag->setWorkspace($this);
    }

    /**
     * Returns a new task for the workspace.
     *
     * @return Task
     */
    public function newTask () {
        /** @var Task $task */
        $task = $this->factory(Task::class);
        return $task->setWorkspace($this);
    }
}
hfw / asana

Push — master ( 023346...878e6c )

Workspace::findPortfolios() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
