FieldValues::offsetExists() - Code Metrics - Inspection of "data integrity / plumbing" - hfw/asana - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 50a671...528684 )

by y
created 2020-05-12 13:59 UTC
FieldValues::offsetExists() A

↳ Parent: FieldValues
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	1
dl	0
loc	2
rs	10
c	0
b	0
f	0
<?php

namespace Helix\Asana\Task;

use ArrayAccess;
use Countable;
use Generator;
use Helix\Asana\Base\Data;
use Helix\Asana\CustomField;
use Helix\Asana\Task;
use IteratorAggregate;

/**
 * Custom field value adapter for tasks.
 *
 * Field access is by GID.
 *
 * Enum values are set by option GID.
 */
class FieldValues extends Data implements ArrayAccess, Countable, IteratorAggregate {

    /**
     * ` [ field gid => data index ]`
     *
     * @var int[]
     */
    protected $index = [];

    /**
     * `[ enum gid => option gid => option name ]`
     *
     * @var string[][]
     */
    protected $optionNames = [];

    /**
     * @var Task
     */
    protected $task;

    /**
     * `[ field gid => type ]`
     *
     * @var string[]
     */
    protected $types = [];

    public function __construct (Task $task, array $data = []) {
        $this->task = $task;
        parent::__construct($task, $data);
    }

    /**
     * Strips Asana's beefy data array down to what we need and builds indexes.
     *
     * @param array $data
     */
    protected function _setData (array $data): void {
        $this->index = [];
        $this->optionNames = [];
        $keys = array_flip(['gid', 'name', 'type', 'enum_options', 'enum_value', 'text_value', 'number_value']);
        foreach ($data as $i => $field) {
            $field = array_intersect_key($field, $keys);
            if ($field['type'] === CustomField::TYPE_ENUM) {
                foreach ($field['enum_options'] as $j => $option) {
                    $field['enum_options'][$j] = ['gid' => $option['gid'], 'name' => $option['name']];
                    $this->optionNames[$field['gid']][$option['gid']] = $option['name'];
                }
                $field['enum_value'] = ['gid' => $field['enum_value']['gid']];
            }
            $this->index[$field['gid']] = $i;
            $data[$i] = $field;
        }
        parent::_setData($data);
    }

    /**
     * @return int
     */
    public function count () {
        return count($this->data);
    }

    /**
     * @param string $enumGid
     * @return null|string
     */
    public function getCurrentOptionName (string $enumGid): ?string {
        return $this->getOptionName($enumGid, $this[$enumGid]);
        return $this->getOptionName($enumGid, /** @scrutinizer ignore-type */ $this[$enumGid]);
    }

    public function getDiff (): array {
        $diff = [];
        foreach (array_keys($this->diff) as $index) {
            $gid = $this->index[$index];
            $diff[$gid] = $this[$gid];
        }
        return $diff;
    }

    /**
     * @return Generator
     */
    public function getIterator () {
        foreach (array_keys($this->index) as $gid) {
            yield $gid => $this[$gid];
        }
    }

    /**
     * @param string $fieldGid
     * @return null|string
     */
    public function getName (string $fieldGid): ?string {
        return $this->data[$this->index[$fieldGid]]['name'];
    }

    /**
     * Field names, keyed by GID.
     *
     * @return string[]
     */
    public function getNames () {
        return array_column($this->data, 'name', 'gid');
    }

    /**
     * @param string $enumGid
     * @param string $optionGid
     * @return null|string
     */
    public function getOptionName (string $enumGid, string $optionGid): ?string {
        return $this->optionNames[$enumGid][$optionGid];
    }

    /**
     * Enum option names, keyed by GID.
     *
     * @param string $enumGid
     * @return string[]
     */
    public function getOptionNames (string $enumGid) {
        return $this->optionNames[$enumGid];
    }

    /**
     * @param string $fieldGid
     * @return null|number|string
     */
    public function getValue (string $fieldGid) {
        $field = $this->data[$this->index[$fieldGid]];
        if ($field['type'] === CustomField::TYPE_ENUM) {
            return $field['enum_value']['gid'];
        }
        return $field["{$field['type']}_value"];
    }

    /**
     * @param string $fieldGid
     * @return bool
     */
    public function offsetExists ($fieldGid) {
        return array_key_exists($this->index[$fieldGid], $this->data);
    }

    /**
     * @param string $fieldGid
     * @return null|number|string
     */
    public function offsetGet ($fieldGid) {
        return $this->getValue($fieldGid);
    }

    /**
     * @param string $fieldGid
     * @param null|number|string $value
     */
    public function offsetSet ($fieldGid, $value) {
        $this->setValue($fieldGid, $value);
    }

    /**
     * Custom fields cannot be "removed" through this. This only sets them to `null`.
     *
     * @param string $fieldGid
     */
    public function offsetUnset ($fieldGid) {
        $this->setValue($fieldGid, null);
    }

    /**
     * @param string $fieldGid
     * @param null|number|string $value
     * @return $this
     */
    public function setValue (string $fieldGid, $value) {
        $i = $this->index[$fieldGid];
        $type = $this->data[$i]['type'];
        if ($type === CustomField::TYPE_ENUM) {
            $this->data[$i]['enum_value']['gid'] = $value;
        }
        else {
            $this->data["{$type}_value"] = $value;
        }
        $this->diff[$i] = true;
        $this->task->diff['custom_fields'] = true;
        return $this;
    }
}
hfw / asana

Push — master ( 50a671...528684 )

FieldValues::offsetExists() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
