AbstractMapper.php

<?php declare(strict_types=1);
/**
 * Class AbstractMapper
 *
 * @author        Robin 'codeFareith' von den Bergen <robinvonberg@gmx.de>
 * @copyright (c) 2018-2022 by Robin von den Bergen
 * @license       http://opensource.org/licenses/gpl-license.php GNU Public License
 * @version       1.0.0
 *
 * @link          https://github.com/codeFareith/cf_google_authenticator
 * @see           https://www.fareith.de
 * @see           https://typo3.org
 */

namespace CodeFareith\CfGoogleAuthenticator\Domain\Mapper;

use CodeFareith\CfGoogleAuthenticator\Exception\MissingRequiredField;
use CodeFareith\CfGoogleAuthenticator\Exception\PropertyNotInitialized;
use function array_diff;
use function array_keys;
use function array_values;
use function count;

/**
 * AbstractMapper
 *
 * Provides the basic functionality of Array-to-Struct / Struct-to-Array mappers.
 *
 * @package CodeFareith\CfGoogleAuthenticator\Domain\Mapper
 * @since   1.0.0
 */
abstract class AbstractMapper
    implements MapperInterface
{
    /*─────────────────────────────────────────────────────────────────────────────*\
            Properties
    \*─────────────────────────────────────────────────────────────────────────────*/
    /**
     * Contains all the fields/keys the array must have in order to create the desired struct.
     * Should be defined in child class.
     *
     * @var string[]|null
     */
    protected static $requiredFields = [];

    /*─────────────────────────────────────────────────────────────────────────────*\
            Methods
    \*─────────────────────────────────────────────────────────────────────────────*/
    /**
     * Check if the given array has all fields/keys defined in static::requiredFields.
     *
     * @param string[] $data
     */
    final public static function hasRequiredFields(array $data): bool
    {
        return (count(self::getMissingFields($data)) === 0);
    }

    /**
     * Get all fields/keys defined in static::requiredFields, but missing in the given array
     *
     * @param string[] $data
     */
    final public static function getMissingFields(array $data): array
    {
        return array_values(
            array_diff(
                static::$requiredFields,
                array_keys($data)
            )
        );
    }

    /**
     * Create a struct using data from the given array.
     * Any child class has to initialize static::requiredFields - otherwise an exception is thrown.
     *
     * @param mixed $data
     *
     * @return mixed
     * @throws MissingRequiredField
     * @throws PropertyNotInitialized
     */
    final public static function createStructFromArray(array $data)
    {
        if (static::$requiredFields === null) {
            throw new PropertyNotInitialized('requiredFields', static::class);
        }

        if (self::hasRequiredFields($data) === false) {
            self::throwMissingRequiredFieldExceptionStack($data);
        }

        return static::mapArrayOnStruct($data);
    }

    /**
     * Map array values to struct.
     * Should be defined in child class.
     *
     * @param mixed $data
     *
     * @return mixed
     */
    abstract protected static function mapArrayOnStruct(array $data);

    /**
     * Create and throw MissingRequiredField exception stack
     *
     * @param array $data
     *
     * @throws MissingRequiredField
     */
    private static function throwMissingRequiredFieldExceptionStack(array $data): void
    {
        $previous = null;
        $missingFields = self::getMissingFields($data);
        $length = count($missingFields);

        for ($i = $length; $i > 0; $i--) {
            $next = $missingFields[$length];
            $previous = new MissingRequiredField($next, $previous);
        }

        throw $previous;
    }
}