Core\Utility\Macros

Complexity

Total Complexity

7

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	get()	0	8	2
A	set()	0	5	1
A	text()	0	9	2

<?php
/**
 * CakeCMS Core
 *
 * This file is part of the of the simple cms based on CakePHP 3.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package     Core
 * @license     MIT
 * @copyright   MIT License http://www.opensource.org/licenses/mit-license.php
 * @link        https://github.com/CakeCMS/Core".
 * @author      Sergey Kalistratov <kalistratov.s.m@gmail.com>
 */

namespace Core\Utility;

use JBZoo\Utils\Arr;
use Cake\ORM\Entity;
use Cake\Utility\Hash;
use Cake\Routing\Router;

/**
 * Class Macros
 *
 * @package Core\Utility
 */
class Macros
{

    /**
     * Replacement data list.
     *
     * @var array|Entity
     */
    protected $_data = [];

    /**
     * Macros constructor.
     *
     * @param   mixed $data
     */
    public function __construct($data = [])
    {
        if ($data instanceof Entity) {
            $data = $data->toArray();
        }

        $this->_data = (array) $data;

        $this->set('base_url', Router::fullBaseUrl());
    }

    /**
     * Get replacement val or all list.
     *
     * @param   null|string|int $key
     * @return  array
     */
    public function get($key = null)
    {
        if (Arr::key($key, $this->_data)) {
            return $this->_data[$key];
        }

        return $this->_data;

The expression $this->_data; of type array|Cake\ORM\Entity adds the type Cake\ORM\Entity to the return on line 66 which is incompatible with the return type documented by Core\Utility\Macros::get of type array.

    }

    /**
     * Add new value in list.
     *
     * @param   string|int $key
     * @param   string|int $val
     * @return  $this
     */
    public function set($key, $val)
    {
        $this->_data = Hash::merge([$key => $val], $this->_data);
        return $this;
    }

    /**
     * Get replacement text.
     *
     * @param   string $text
     * @return  string mixed
     */
    public function text($text)
    {
        foreach ($this->_data as $macros => $value) {

The expression $this->_data of type array|object<Cake\ORM\Entity> is not guaranteed to be traversable. How about adding an additional type check?

            $macros = '{' . $macros . '}';
            $text   = preg_replace('#' . $macros . '#ius', $value, $text);
        }

        return $text;
    }
}