CPS-IT/project-builder

<?php

declare(strict_types=1);

/*
 * This file is part of the Composer package "cpsit/project-builder".
 *
 * Copyright (C) 2022 Elias Häußler <e.haeussler@familie-redlich.de>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace CPSIT\ProjectBuilder\Helper;

use ArrayObject;

/**
 * ArrayHelper.
 *
 * @author Elias Häußler <e.haeussler@familie-redlich.de>
 * @license GPL-3.0-or-later
 */
final class ArrayHelper
{
    /**
     * @param array<string, mixed>|ArrayObject<string, mixed> $subject
     */
    public static function getValueByPath(array|ArrayObject $subject, string $path): mixed
    {
        $pathSegments = self::trimExplode($path, '.');
        $reference = &$subject;

        foreach ($pathSegments as $pathSegment) {
            if (!self::pathSegmentExists($reference, $pathSegment)) {
                return null;
            }

            $reference = &$reference[$pathSegment];
        }

        return $reference;
    }

    /**
     * @param array<string, mixed>|ArrayObject<string, mixed> $subject
     */
    public static function setValueByPath(array|ArrayObject &$subject, string $path, mixed $value): void
    {
        $pathSegments = self::trimExplode($path, '.');
        $reference = &$subject;

        foreach ($pathSegments as $pathSegment) {
            // Instantiate array if path segment does not exist
            if (!self::pathSegmentExists($reference, $pathSegment)) {
                $reference[$pathSegment] = [];
            }

            // Overwrite unsupported value as empty array
            if (!is_array($reference[$pathSegment]) && !($reference[$pathSegment] instanceof ArrayObject)) {
                $reference[$pathSegment] = [];
            }

            // Move pointer forward to current path
            $reference = &$reference[$pathSegment];
        }

        $reference = $value;
    }

    /**
     * @param non-empty-string $delimiter
     *
     * @return list<non-empty-string>
     */
    public static function trimExplode(string $subject, string $delimiter = ','): array
    {
        return array_values(
            array_filter(
                array_map(
                    trim(...),
                    explode($delimiter, $subject),
                ),
                static fn (string $value) => '' !== $value,
            ),
        );
    }

    private static function pathSegmentExists(mixed $subject, string $pathSegment): bool
    {
        if (!is_array($subject) && !($subject instanceof ArrayObject)) {
            return false;
        }

        if (is_array($subject)) {
            return array_key_exists($pathSegment, $subject);
        }

        return isset($subject[$pathSegment]);
    }
}