drycart\data\EnumTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	titles()	0	4	1
A	data()	0	6	1
A	titlesIterator()	0	11	2
A	keyTitles()	0	9	2
A	valueTitles()	0	9	2
A	value()	0	4	1
A	key()	0	5	1
A	checkKey()	0	6	2

<?php
namespace drycart\data;

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

/**
 * Trait for pretty use for list of constants and/or data arrays
 *
 * @author mendel
 */
trait EnumTrait
{
    /**
     * Array for titles. Just default dummy for override if need
     * 
     * @return array
     */
    static protected function titles() : array
    {
        return [];
    }
    
    /**
     * Main function. Return list of constants i.e. keys and values...
     * 
     * @return array
     */
    static public function data() : array
    {
        // @2DO: add assertion for check if values is uniqal
        $reflector = new \ReflectionClass(static::class);
        return $reflector->getConstants();
    }
    
    /**
     * Get iterator for titles/keys/values
     * 
     * @return \Iterator
     */
    static public function titlesIterator() : \Iterator
    {
        $titles = static::titles();
        foreach(static::data() as $key=>$value) {
            yield new DataWrapper([
                'key' => $key,
                'value' => $value,
                'title' => $titles[$key] ?? StrHelper::key2Label(strtolower($key))
            ]);
        }
    }
    
    /**
     * Return all keys and his titles (defined at titles() or default generated)
     * 
     * @return array
     */
    static public function keyTitles() : array
    {
        $titles = static::titles();
        $result = [];
        foreach(array_keys(static::data()) as $key) {
            $result[$key] = $titles[$key] ?? StrHelper::key2Label(strtolower($key));
        }
        return $result;
    }
    
    /**
     * Return all values and his titles (defined at titles() or default generated)
     * 
     * @return array
     */
    static public function valueTitles() : array
    {
        $titles = static::titles();
        $result = [];
        foreach(static::data() as $key=>$value) {
            $result[$value] = $titles[$key] ?? StrHelper::key2Label(strtolower($key));
        }
        return $result;
    }
        
    /**
     * Get value by key
     * @param string $key
     * @return mixed
     */
    static public function value(string $key)
    {
        return static::data()[$key] ?? null;
    }
    
    /**
     * Get key by value
     * @param mixed $value
     * @return string|null
     */
    static public function key($value) : ?string
    {
        $data = array_flip(static::data());
        return $data[$value] ?? null;
    }
    
    static public function checkKey(string $key) : void
    {
        if(in_null(static::value($key))) {
            throw \Exception();
        }
    }
    
}