Helix\Asana\CustomField

Complexity

Total Complexity

15

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	sortEnumOptions()	0	18	5
A	addEnumOption()	0	11	2
A	isText()	0	2	1
A	isGlobalToWorkspace()	0	2	1
A	_setData()	0	11	1
A	hasNotificationsEnabled()	0	2	1
A	setNotificationsEnabled()	0	2	1
A	isEnum()	0	2	1
A	setGlobalToWorkspace()	0	2	1
A	isNumber()	0	2	1

<?php

namespace Helix\Asana;

use Helix\Asana\Base\AbstractEntity;
use Helix\Asana\Base\AbstractEntity\CrudTrait;
use Helix\Asana\Base\AbstractEntity\PostMutatorTrait;
use Helix\Asana\Base\AbstractEntity\WorkspaceTrait;
use Helix\Asana\CustomField\EnumOption;
use Helix\Asana\Task\FieldEntries;

/**
 * A custom field.
 *
 * See {@link FieldEntries} for getting {@link Task} values.
 *
 * @see https://developers.asana.com/docs/asana-custom-fields
 * @see https://developers.asana.com/docs/custom-field
 *
 * @method string       getDescription      ()
 * @method EnumOption[] getEnumOptions      ()
 * @method string       getName             ()
 * @method int          getPrecision        ()
 * @method string       getResourceSubtype  ()
 *
 * @method $this        setDescription      (string $text)
 * @method $this        setName             (string $name)
 * @method $this        setPrecision        (int $precision)
 * @method $this        setResourceSubtype  (string $type) @depends create-only
 */
class CustomField extends AbstractEntity {

    use CrudTrait;
    use PostMutatorTrait;
    use WorkspaceTrait;

    const DIR = 'custom_fields';
    const TYPE = 'custom_field';
    const TYPE_ENUM = 'enum';
    const TYPE_NUMBER = 'number';
    const TYPE_TEXT = 'text';

    protected const MAP = [
        'enum_options' => [EnumOption::class],
    ];

    protected function _setData (array $data): void {
        // strip out field entry values if present.
        $data = array_intersect_key($data, array_flip([
            'gid',
            'description',
            'enum_options',
            'name',
            'precision',
            'resource_subtype'
        ]));
        parent::_setData($data);
    }

    /**
     * `POST` or stage a new enum option.
     *
     * @see https://developers.asana.com/docs/create-an-enum-option
     *
     * @param string $name
     * @return EnumOption
     */
    public function addEnumOption (string $name) {
        /** @var EnumOption $option */
        $option = $this->api->factory($this, EnumOption::class);
        $option->setName($name);
        if ($this->hasGid()) {
            $option->create();
        }
        $this->_addWithPost("{$this}/enum_options", [
            'name' => $name
        ], 'enum_options', [$option]);
        return $option;
    }

    /**
     * @return bool
     */
    final public function hasNotificationsEnabled (): bool {
        return $this->_is('has_notifications_enabled');
    }

    /**
     * @return bool
     */
    final public function isEnum (): bool {
        return $this->getResourceSubtype() === self::TYPE_ENUM;
    }

    /**
     * @return bool
     */
    final public function isGlobalToWorkspace (): bool {
        return $this->_is('is_global_to_workspace');
    }

    /**
     * @return bool
     */
    final public function isNumber (): bool {
        return $this->getResourceSubtype() === self::TYPE_NUMBER;
    }

    /**
     * @return bool
     */
    final public function isText (): bool {
        return $this->getResourceSubtype() === self::TYPE_TEXT;
    }

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

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

    /**
     * @param callable $cmp `fn( EnumOption $a, EnumOption $b ): int`
     * @return $this
     */
    public function sortEnumOptions (callable $cmp) {
        if ($options = $this->getEnumOptions()) {
            $prev = $options[0]; // first option on remote
            usort($options, $cmp);
            if ($this->hasGid()) {
                foreach ($options as $option) {
                    if ($option !== $prev) {
                        $this->api->put($option, [
                            'insert_after' => $prev->getGid()
                        ]);
                    }
                    $prev = $option;
                }
            }
            $this->data['enum_options'] = $options;
            // no diff    
        }
        return $this;
    }

}