Firesphere\SolrSearch\Helpers\DataResolver

Complexity

Total Complexity

25

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Test Coverage

Coverage

96.92%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	cannotIdentifyException()	0	7	1
A	resolveDataObject()	0	24	5
A	resolveList()	0	18	4
A	__construct()	0	8	3
A	resolveArrayData()	0	10	4
A	identify()	0	11	3
A	resolveField()	0	21	5

<?php

namespace Firesphere\SolrSearch\Helpers;

use Exception;
use SilverStripe\Core\ClassInfo;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\SS_List;
use SilverStripe\View\ArrayData;

class DataResolver
{
    /**
     * @var DataObject|ArrayList|SS_List|DBField
     */
    protected $component;
    /**
     * @var array
     */
    protected $columns = [];
    /**
     * @var mixed|string|null
     */
    protected $columnName = '';
    /**
     * Supported object types
     * @var array map of objects to methods
     */
    private static $objTypes = [
        DataObject::class => 'DataObject',
        ArrayData::class  => 'ArrayData',
        SS_List::class    => 'List',
        DBField::class    => 'Field'
    ];

    /**
     * DataResolver constructor.
     * @param DataObject|ArrayList|SS_List $component
     * @param array|string $columns
     */
    public function __construct($component, $columns = [])
    {
        if (!is_array($columns)) {
            $columns = array_filter(explode('.', $columns));
        }
        $this->columns = $columns;
        $this->component = $component;
        $this->columnName = $this->columns ? array_shift($this->columns) : null;
    }

    /**
     * @param DataObject|ArrayData|SS_List|DBField $obj
     * @param array|string $columns
     *
     * @return mixed
     * @throws Exception
     */
    public static function identify($obj, $columns = [])
    {
        foreach (static::$objTypes as $type => $method) {

Since $objTypes is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $objTypes to at least protected.

            if ($obj instanceof $type) {
                $method = 'resolve' . $method;

                return (new self($obj, $columns))->{$method}();

It seems like $obj can also be of type SilverStripe\ORM\FieldType\DBField and SilverStripe\View\ArrayData; however, parameter $component of Firesphere\SolrSearch\Helpers\DataResolver::__construct() does only seem to accept SilverStripe\ORM\ArrayList|SilverStripe\ORM\DataObject|SilverStripe\ORM\SS_List, maybe add an additional type check?

            }
        }

        throw new Exception(sprintf('Class: %s, is not supported.', ClassInfo::shortName($obj)));
    }

    /**
     * @param DataObject|ArrayData|SS_List $component
     * @param array $columns
     *
     * @return void
     * @throws Exception
     */
    protected function cannotIdentifyException($component, $columns = [])
    {
        throw new Exception(
            sprintf(
                'Cannot identify, "%s" from class "%s"',
                implode('.', $columns),
                ClassInfo::shortName($component)
            )
        );
    }

    /**
     * Resolves a Single field in the database.
     * @return mixed
     * @throws Exception
     */
    protected function resolveField()
    {
        if ($this->columnName) {
            if ($this->component->hasMethod($this->columnName)) {

The method hasMethod() does not exist on SilverStripe\ORM\SS_List. It seems like you code against a sub-type of said class. However, the method does not exist in SilverStripe\ORM\Sortable or SilverStripe\ORM\Filterable or SilverStripe\ORM\Relation or SilverStripe\ORM\Limitable or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation. Are you sure you never get one of those?

                $method = $this->columnName;
            } elseif ($this->component->hasMethod("get{$this->columnName}")) {
                $method = "get{$this->columnName}";
            } else {
                throw new Exception(
                    sprintf('Method, "%s" not found on "%s"', $this->columnName, ClassInfo::shortName($this->component))
                );
            }
            $value = $this->component->$method();
        } else {
            $value = $this->component->getValue();

The method getValue() does not exist on SilverStripe\ORM\SS_List. It seems like you code against a sub-type of said class. However, the method does not exist in SilverStripe\ORM\Sortable or SilverStripe\ORM\Filterable or SilverStripe\ORM\Relation or SilverStripe\ORM\Limitable or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation. Are you sure you never get one of those?

        }
        if (!empty($this->columns)) {
            $this->cannotIdentifyException($this->component, $this->columns);

It seems like $this->component can also be of type SilverStripe\ORM\FieldType\DBField; however, parameter $component of Firesphere\SolrSearch\Helpers\DataResolver::cannotIdentifyException() does only seem to accept SilverStripe\ORM\DataObject|SilverStripe\ORM\SS_List|SilverStripe\View\ArrayData, maybe add an additional type check?

        }

        return $value;
    }

    /**
     * Resolves a DataObject value
     * @return mixed
     * @throws Exception
     */
    protected function resolveDataObject()
    {
        if (empty($this->columnName)) {
            return $this->component->toMap();

The method toMap() does not exist on SilverStripe\ORM\SS_List. It seems like you code against a sub-type of said class. However, the method does not exist in SilverStripe\ORM\Sortable or SilverStripe\ORM\Filterable or SilverStripe\ORM\Relation or SilverStripe\ORM\Limitable or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation. Are you sure you never get one of those?

        }
        // Inspect component for element $relation
        if ($this->component->hasMethod($this->columnName)) {
            $relation = $this->columnName;

            return self::identify($this->component->$relation(), $this->columns);
        }
        // Inspect component has attribute
        if ($this->component->hasField($this->columnName)) {

The method hasField() does not exist on SilverStripe\ORM\SS_List. It seems like you code against a sub-type of said class. However, the method does not exist in SilverStripe\ORM\Sortable or SilverStripe\ORM\Filterable or SilverStripe\ORM\Relation or SilverStripe\ORM\Limitable or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation. Are you sure you never get one of those?

            $data = $this->component->{$this->columnName};
            $dbObject = $this->component->dbObject($this->columnName);

The method dbObject() does not exist on SilverStripe\ORM\SS_List. It seems like you code against a sub-type of said class. However, the method does not exist in SilverStripe\ORM\Sortable or SilverStripe\ORM\Filterable or SilverStripe\ORM\Limitable. Are you sure you never get one of those?

            if ($dbObject) {
                $dbObject->setValue($data);

                return self::identify($dbObject, $this->columns);
            }

            return $data;
        }
        $this->cannotIdentifyException($this->component, [$this->columnName]);

It seems like $this->component can also be of type SilverStripe\ORM\FieldType\DBField; however, parameter $component of Firesphere\SolrSearch\Helpers\DataResolver::cannotIdentifyException() does only seem to accept SilverStripe\ORM\DataObject|SilverStripe\ORM\SS_List|SilverStripe\View\ArrayData, maybe add an additional type check?

    }

    /**
     * Resolves an ArrayData value
     * @return mixed
     * @throws Exception
     */
    public function resolveArrayData()
    {
        if (empty($this->columnName)) {
            return $this->component->toMap();
        }
        // Inspect component has attribute
        if ($this->component->hasField($this->columnName) && empty($this->columns)) {
            return $this->component->{$this->columnName};
        }
        $this->cannotIdentifyException($this->component, array_merge([$this->columnName], $this->columns));

It seems like $this->component can also be of type SilverStripe\ORM\FieldType\DBField; however, parameter $component of Firesphere\SolrSearch\Helpers\DataResolver::cannotIdentifyException() does only seem to accept SilverStripe\ORM\DataObject|SilverStripe\ORM\SS_List|SilverStripe\View\ArrayData, maybe add an additional type check?

    }

    /**
     * Resolves a DataList values
     * @return array|mixed
     * @throws Exception
     */
    public function resolveList()
    {
        if (empty($this->columnName)) {
            return $this->component->toNestedArray();
        }
        // Inspect $component for element $relation
        if ($this->component->hasMethod($this->columnName)) {
            $relation = $this->columnName;

            return self::identify($this->component->$relation(), $this->columns);
        }
        $data = [];
        array_unshift($this->columns, $this->columnName);
        foreach ($this->component as $component) {
            $data[] = self::identify($component, $this->columns);
        }

        return $data;
    }
}