landrok/activitypub

<?php

declare(strict_types=1);

/*
 * This file is part of the ActivityPhp package.
 *
 * Copyright (c) landrok at github.com/landrok
 *
 * For the full copyright and license information, please see
 * <https://github.com/landrok/activitypub/blob/master/LICENSE>.
 */

namespace ActivityPhp\Type;

use Exception;

/**
 * \ActivityPhp\Type\Validator is an abstract class for
 * attribute validation.
 */
abstract class Validator
{
    /**
     * Contains all custom validators
     *
     * @var array<string,string>
     *
     * [ 'attributeName' => CustomValidatorClassName::class ]
     */
    protected static $validators = [];

    /**
     * Validate an attribute value for given attribute name and
     * container object.
     *
     * @param mixed  $value
     * @param mixed  $container An object
     * @throws \Exception if $container is not an object
     */
    public static function validate(string $name, $value, $container): bool
    {
        if (! is_object($container)) {
            throw new Exception(
                'Given container is not an object'
            );
        }

        // Perform validation
        if (isset(self::$validators[$name])
            && TypeConfiguration::get('undefined_properties') === 'strict'
        ) {
            return self::$validators[$name]->validate(
                $value,
                $container
            );
        }

        // Try to load a default validator
        $validatorName = sprintf(
            '\ActivityPhp\Type\Validator\%sValidator',
            ucfirst($name)
        );

        if (class_exists($validatorName)
            && TypeConfiguration::get('undefined_properties') === 'strict'
        ) {
            self::add($name, $validatorName);
            return self::validate($name, $value, $container);
        }

        // There is no validator for this attribute
        return true;
    }

    /**
     * Add a new validator in the pool.
     * It checks that it implements Validator\Interface
     *
     * @param string $name An attribute name to validate.
     * @param string|object $class A validator class name
     * @throws \Exception if validator class does not implement
     * \ActivityPhp\Type\Helper\ValidatorInterface
     */
    public static function add(string $name, $class): void
    {
        $validator = new $class();

        if (! ($validator instanceof ValidatorInterface)) {
            throw new Exception(
                sprintf(
                    'Validator "%s" MUST implement "%s" interface',
                    get_class($validator),
                    ValidatorInterface::class
                )
            );
        }

        self::$validators[$name] = $validator;
    }
}