MaksimM\CompositePrimaryKeys\Http\Traits\NormalizedKeysParser

Complexity

Total Complexity

12

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getNormalizedKey()	0	14	5
A	getNormalizedKeyName()	0	3	1
A	recoverBinaryKey()	0	6	2
A	parseNormalizedKey()	0	9	4

<?php

namespace MaksimM\CompositePrimaryKeys\Http\Traits;

use Exception;
use Illuminate\Database\Eloquent\Model;
use MaksimM\CompositePrimaryKeys\Exceptions\WrongKeyException;

trait NormalizedKeysParser
{
    protected $magicKeyDelimiter = '___';

    /**
     * Get key-value array from normalized key.
     *
     * @param $normalizedKey
     *
     * @throws WrongKeyException
     *
     * @return array
     */
    public function parseNormalizedKey($normalizedKey)
    {
        $parsedKeys = explode($this->magicKeyDelimiter, $normalizedKey);
        $keys = $this instanceof Model ? $this->getRawKeyName() : $this->key;
        foreach ($keys as $index => $key) {
            $keys[$key] = in_array($key, $this->getBinaryColumns()) ? $this->recoverBinaryKey($key, $parsedKeys[$index]) : $parsedKeys[$index];

It seems like getBinaryColumns() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $keys;

The expression return $keys also could return the type Illuminate\Database\Eloquent\Builder which is incompatible with the documented return type array.

    }

    /**
     * Get normalized key.
     *
     * @return string
     */
    private function getNormalizedKeyName()
    {
        return implode($this->magicKeyDelimiter, array_merge($this->getRawKeyName()));

It seems like getRawKeyName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get normalized key.
     *
     * @return string
     */
    private function getNormalizedKey()
    {
        $rawKeys = $this->getRawKey();

It seems like getRawKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        //do not normalize single key because we couldn't detect its type
        if (count($rawKeys) > 1) {
            foreach ($rawKeys as $key => $value) {
                if (in_array($key, $this->getBinaryColumns()) && !$this->hexBinaryColumns()) {

It seems like hexBinaryColumns() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $rawKeys[$key] = strtoupper(bin2hex($value));
                }
            }
        }

        return implode($this->magicKeyDelimiter, $rawKeys);
    }

    /**
     * @param $key
     * @param $hexValue
     *
     * @throws WrongKeyException
     *
     * @return bool|string
     */
    public function recoverBinaryKey($key, $hexValue)
    {
        try {
            return hex2bin($hexValue);
        } catch (Exception $exception) {
            throw new WrongKeyException("$key has invalid hex value");
        }
    }
}