Spinen\ClickUp\Result

Complexity

Total Complexity

2

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	goal()	0	3	1
A	getOwnersAttribute()	0	3	1

<?php

namespace Spinen\ClickUp;

use Carbon\Carbon;
use Spinen\ClickUp\Exceptions\InvalidRelationshipException;
use Spinen\ClickUp\Exceptions\ModelNotFoundException;
use Spinen\ClickUp\Exceptions\NoClientException;
use Spinen\ClickUp\Support\Collection;
use Spinen\ClickUp\Support\Model;
use Spinen\ClickUp\Support\Relations\ChildOf;

/**
 * Class Result
 *
 * @package Spinen\ClickUp
 *
 * @property array $last_action
 * @property boolean $completed
 * @property Carbon $date_created
 * @property Collection $owners
 * @property Collection $subcategory_ids
 * @property Collection $task_ids
 * @property float $percent_completed
 * @property Goal $goal
 * @property integer $creator
 * @property integer $goal_pretty_id
 * @property string $goal_id
 * @property string $id
 * @property string $name
 * @property string $type
 * @property string $unit
 */
class Result extends Model
{
    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'completed'         => 'boolean',
        'creator'           => 'integer',
        'date_created'      => 'datetime:Uv',
        'goal_pretty_id'    => 'integer',
        'id'                => 'string',
        'percent_completed' => 'float',
    ];

    /**
     * Is resource nested behind parentModel
     *
     * Several of the endpoints are nested behind another model for relationship, but then to
     * interact with the specific model, then are not nested.  This property will know when to
     * keep the specific model nested.
     *
     * @var bool
     */
    protected $nested = true;

    /**
     * Path to API endpoint.
     *
     * @var string
     */
    protected $path = '/key_result';

    /**
     * Accessor for Owners.
     *
     * @param array $owners
     *
     * @return Collection
     * @throws NoClientException
     */
    public function getOwnersAttribute(array $owners): Collection
    {
        return $this->givenMany(Member::class, $owners);
    }

    /**
     * @return ChildOf
     * @throws InvalidRelationshipException
     * @throws ModelNotFoundException
     * @throws NoClientException
     */
    public function goal(): ChildOf
    {
        return $this->childOf(Goal::class);
    }
}