PHP Classes

File: src/ObjectParameter.php

Recommend this page to a friend!
  Classes of Rodolfo Berrios Arce   Parameter   src/ObjectParameter.php   Download  
File: src/ObjectParameter.php
Role: Class source
Content type: text/plain
Description: Class source
Class: Parameter
Validate function parameters with PHP attributes
Author: By
Last change:
Date: 19 days ago
Size: 2,525 bytes
 

Contents

Class file image Download
<?php

/*
 * This file is part of Chevere.
 *
 * (c) Rodolfo Berrios <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace
Chevere\Parameter;

use
Chevere\Parameter\Interfaces\ObjectParameterInterface;
use
Chevere\Parameter\Traits\ParameterTrait;
use
Chevere\Parameter\Traits\SchemaTrait;
use
InvalidArgumentException;
use
stdClass;
use
TypeError;
use function
Chevere\Message\message;

final class
ObjectParameter implements ObjectParameterInterface
{
    use
ParameterTrait;
    use
SchemaTrait;

    private
string $className;

    private ?
object $default = null;

    public function
__invoke(object $value): object
   
{
        if (
$this->type->validate($value)) {
            return
$value;
        }

        throw new
TypeError(
            (string)
message(
               
'Argument value provided is not of type `%type%`',
               
type: $this->className()
            )
        );
    }

    public function
setUp(): void
   
{
       
$this->className = stdClass::class;
    }

    public function
className(): string
   
{
        return
$this->className;
    }

    public function
withClassName(string $className): ObjectParameterInterface
   
{
       
$new = clone $this;
       
$new->className = $className;
       
$new->type = new Type($className);

        return
$new;
    }

    public function
withDefault(object $value): ObjectParameterInterface
   
{
       
$this($value);
       
$new = clone $this;
       
$new->default = $value;

        return
$new;
    }

    public function default(): ?
object
   
{
        return
$this->default;
    }

    public function
schema(): array
    {
        return [
           
'type' => $this->type->primitive(),
           
'className' => $this->className(),
           
'description' => $this->description(),
           
'default' => $this->default() !== null
               
? $this->default()::class
                :
null,
        ];
    }

    public function
assertCompatible(ObjectParameterInterface $parameter): void
   
{
        if (
$this->className === $parameter->className()) {
            return;
        }

        throw new
InvalidArgumentException(
            (string)
message(
               
'Parameter must be of type `%type%`',
               
type: $this->className
           
)
        );
    }

    private function
typeName(): string
   
{
        return
$this->className;
    }
}