drycart\data\GetterHelper

Complexity

Total Complexity

23

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	8	2
A	getIterator()	0	10	3
A	getKeys()	0	17	6
B	subGet()	0	21	8
A	isArrayable()	0	4	2
A	tryGetMethodName()	0	7	2

<?php

/*
 *  @copyright (c) 2019 Mendel <mendel@zzzlab.com>
 *  @license see license.txt
 */

namespace drycart\data;

/**
 * Wrapper for pretty access to field
 * Used for deep access to some data at some unknown data
 *
 * fieldName for example forum.moderators.first().name work correct for any of this sence:
 * $data->forum->moderators->first()->name
 * $data['forum']['moderators']->first()['name']
 * $data['forum']->moderators->first()['name']
 * etc...
 *
 * Object field is priority option, second is array, after this we try method,
 * so if exist something like this, it will be used
 * $data['forum']->moderators['first()']['name']
 *
 * methods parameters not supports at any format
 */
class GetterHelper
{
    /**
     * Get some data by pretty name
     * 
     * @param array|object $data data for pretty access
     * @param string $name name for access
     * @param bool $safe if true - Exception for not exist fields
     * @return mixed
     * @throws \UnexpectedValueException
     */
    public static function get($data, string $name, bool $safe = true)
    {
        $fields = explode('.', $name);
        foreach ($fields as $key) {
            $data = static::subGet($data, $key, $safe);
        }
        return $data;
    }

    /**
     * Get iterator for data
     * 
     * @param mixed $data
     * @return \Traversable
     */
    public static function getIterator($data): \Traversable
    {
        if(is_a($data, \Traversable::class)) {
            return $data;
        } elseif(is_array($data)) {
            return new \ArrayIterator($data);
        } else {
            return new \ArrayIterator((array) $data);
        }
    }

    /**
     * Get keys list for data
     * 
     * @param mixed $data
     * @return array
     */
    public static function getKeys($data) : array
    {
        if(is_object($data) and is_a($data, ModelInterface::class)) {
            return $data->keys();
        } elseif(is_array($data)) {
            return array_keys($data);
        } elseif(is_a($data, \ArrayObject::class)) {
            $arr = $data->getArrayCopy();
            return array_keys($arr);
        } elseif(is_a($data, \Traversable::class)) {
            $arr = iterator_to_array($data);
            return array_keys($arr);
        } else {
            $arr = (array) $data;
            return array_keys($arr);
        }
    }

    /**
     * One level get
     * 
     * @param type $data
     * @param string $key
     * @param bool $safe
     * @return mixed
     * @throws \UnexpectedValueException
     */
    protected static function subGet($data, string $key, bool $safe = true)
    {
        if (static::isArrayable($data) and isset($data[$key])) {
            return $data[$key];
        }
        
        if (is_object($data) AND isset($data->{$key})) {
            return $data->{$key};
        }
        
        // Methods magic...
        $method = static::tryGetMethodName($key);
        if (!is_null($method) and method_exists($data, $method)) {
            return call_user_func_array([$data, $method], []);
        }
        
        if ($safe) {
            throw new \UnexpectedValueException("Bad field name $key");
        }
        return null;
    }
    
    /**
     * Check if data is array or ArrayAccess
     * @param type $data
     * @return bool
     */
    protected static function isArrayable($data) : bool
    {
        return is_array($data) OR is_a($data, \ArrayAccess::class);
    }
    
    /**
     * Check if key is methods name (i.e. finished to "()")
     * and return methods name
     *  
     * @param string $key
     * @return string|null
     */
    protected static function tryGetMethodName(string $key) : ?string
    {
        if(substr($key, -2) == '()') {
            return substr($key, 0, -2);
        }
        return null;
    }
}