Smoren\NestedAccessor\Helpers\NestedHelper

Complexity

Total Complexity

8

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	3	1
A	set()	0	3	1
A	delete()	0	3	1
A	prepareAccessor()	0	9	2
A	exist()	0	3	1
A	isset()	0	3	1
A	append()	0	3	1

<?php

namespace Smoren\NestedAccessor\Helpers;

use Smoren\NestedAccessor\Components\NestedAccessor;
use Smoren\NestedAccessor\Exceptions\NestedAccessorException;

/**
 * Helper for getting and setting to source array or object with nested keys
 * @author Smoren <ofigate@gmail.com>
 */
class NestedHelper
{
    /**
     * @var NestedAccessor|null nested accessor instance
     */
    protected static ?NestedAccessor $accessor = null;

    /**
     * Gets value from nested source by given path
     * @param array<scalar, mixed>|object $source source
     * @param string|array<string> $path path e.g. 'path.to.value' or ['path', 'to', 'value']
     * @param bool $strict if true: throw exception when path is not found in source
     * @return mixed value got by path
     * @throws NestedAccessorException
     */
    public static function get($source, $path, bool $strict = true)
    {
        return static::prepareAccessor($source)->get($path, $strict);
    }

    /**
     * Sets value to nested source by given path
     * @param array<scalar, mixed>|object $source source
     * @param string|array<string> $path path e.g. 'path.to.value' or ['path', 'to', 'value']
     * @param mixed $value value to set
     * @param bool $strict if true: throw exception when path is not found in source
     * @return void
     * @throws NestedAccessorException
     */
    public static function set(&$source, $path, $value, bool $strict = true): void
    {
        static::prepareAccessor($source)->set($path, $value, $strict);
    }

    /**
     * Appends value to nested source by given path
     * @param array<scalar, mixed>|object $source source
     * @param string|array<string> $path path e.g. 'path.to.value' or ['path', 'to', 'value']
     * @param mixed $value value to set
     * @param bool $strict if true: throw exception when path is not found in source
     * @return void
     * @throws NestedAccessorException
     */
    public static function append(&$source, $path, $value, bool $strict = true): void
    {
        static::prepareAccessor($source)->append($path, $value, $strict);
    }

    /**
     * Deletes value to nested source by given path
     * @param array<scalar, mixed>|object $source source
     * @param string|array<string> $path path e.g. 'path.to.value' or ['path', 'to', 'value']
     * @param bool $strict if true: throw exception when path is not found in source
     * @return void
     * @throws NestedAccessorException
     */
    public static function delete(&$source, $path, bool $strict = true): void
    {
        static::prepareAccessor($source)->delete($path, $strict);
    }

    /**
     * Returns true if path exists, false otherwise
     * @param array<scalar, mixed>|object $source source
     * @param string|string[] $path nested path
     * @return bool
     * @throws NestedAccessorException
     */
    public static function exist(&$source, $path): bool
    {
        return static::prepareAccessor($source)->exist($path);
    }

    /**
     * Returns true if path exists and not null, false otherwise
     * @param array<scalar, mixed>|object $source source
     * @param string|string[] $path nested path
     * @return bool
     * @throws NestedAccessorException
     */
    public static function isset(&$source, $path): bool
    {
        return static::prepareAccessor($source)->isset($path);
    }

    /**
     * Method for preparing accessor to use with source
     * @param array<scalar, mixed>|object $source source data
     * @return NestedAccessor
     * @throws NestedAccessorException
     */
    protected static function prepareAccessor(&$source): NestedAccessor
    {
        if(static::$accessor === null) {
            static::$accessor = new NestedAccessor($source);
        } else {
            static::$accessor->setSource($source);
        }

        return static::$accessor;

The expression return static::accessor could return the type null which is incompatible with the type-hinted return Smoren\NestedAccessor\Components\NestedAccessor. Consider adding an additional type-check to rule them out.

    }
}