respect-validation/library/Message/StandardStringifier.php
Henrique Moody b8f494955c
Implement a custom stringifier
The standards `CompositeStringifier` from "respect/stringifier" has lots
of interesting stringifiers. However, this library is not 100% focused
on engineers. Someone could type a string that matches a callable, and
then you will overexpose the system.

This commit makes sure that callables are not interpreted as callables.
2024-12-27 00:15:59 +01:00

92 lines
3.8 KiB
PHP

<?php
/*
* Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
* SPDX-License-Identifier: MIT
*/
declare(strict_types=1);
namespace Respect\Validation\Message;
use DateTimeInterface;
use Respect\Stringifier\Quoter;
use Respect\Stringifier\Quoters\StandardQuoter;
use Respect\Stringifier\Stringifier;
use Respect\Stringifier\Stringifiers\ArrayObjectStringifier;
use Respect\Stringifier\Stringifiers\ArrayStringifier;
use Respect\Stringifier\Stringifiers\BoolStringifier;
use Respect\Stringifier\Stringifiers\CompositeStringifier;
use Respect\Stringifier\Stringifiers\DateTimeStringifier;
use Respect\Stringifier\Stringifiers\DeclaredStringifier;
use Respect\Stringifier\Stringifiers\EnumerationStringifier;
use Respect\Stringifier\Stringifiers\InfiniteNumberStringifier;
use Respect\Stringifier\Stringifiers\IteratorObjectStringifier;
use Respect\Stringifier\Stringifiers\JsonEncodableStringifier;
use Respect\Stringifier\Stringifiers\JsonSerializableObjectStringifier;
use Respect\Stringifier\Stringifiers\NotANumberStringifier;
use Respect\Stringifier\Stringifiers\NullStringifier;
use Respect\Stringifier\Stringifiers\ObjectStringifier;
use Respect\Stringifier\Stringifiers\ObjectWithDebugInfoStringifier;
use Respect\Stringifier\Stringifiers\ResourceStringifier;
use Respect\Stringifier\Stringifiers\StringableObjectStringifier;
use Respect\Stringifier\Stringifiers\ThrowableObjectStringifier;
final class StandardStringifier implements Stringifier
{
private const MAXIMUM_DEPTH = 3;
private const MAXIMUM_NUMBER_OF_ITEMS = 5;
private const MAXIMUM_NUMBER_OF_PROPERTIES = self::MAXIMUM_NUMBER_OF_ITEMS;
private const MAXIMUM_LENGTH = 120;
private readonly Stringifier $stringifier;
public function __construct(
private readonly Quoter $quoter = new StandardQuoter(self::MAXIMUM_LENGTH)
) {
$this->stringifier = $this->createStringifier($quoter);
}
public function stringify(mixed $raw, int $depth): string
{
return $this->stringifier->stringify($raw, $depth) ?? $this->quoter->quote('unknown', $depth);
}
private function createStringifier(Quoter $quoter): Stringifier
{
$jsonEncodableStringifier = new JsonEncodableStringifier();
$stringifier = new CompositeStringifier(
new InfiniteNumberStringifier($quoter),
new NotANumberStringifier($quoter),
new ResourceStringifier($quoter),
new BoolStringifier($quoter),
new NullStringifier($quoter),
new DeclaredStringifier($quoter),
$jsonEncodableStringifier,
);
$arrayStringifier = new ArrayStringifier(
$stringifier,
$quoter,
self::MAXIMUM_DEPTH,
self::MAXIMUM_NUMBER_OF_ITEMS,
);
$stringifier->prependStringifier($arrayStringifier);
$stringifier->prependStringifier(new ObjectStringifier(
$stringifier,
$quoter,
self::MAXIMUM_DEPTH,
self::MAXIMUM_NUMBER_OF_PROPERTIES
));
$stringifier->prependStringifier(new EnumerationStringifier($quoter));
$stringifier->prependStringifier(new ObjectWithDebugInfoStringifier($arrayStringifier, $quoter));
$stringifier->prependStringifier(new ArrayObjectStringifier($arrayStringifier, $quoter));
$stringifier->prependStringifier(new JsonSerializableObjectStringifier($jsonEncodableStringifier, $quoter));
$stringifier->prependStringifier(new StringableObjectStringifier($jsonEncodableStringifier, $quoter));
$stringifier->prependStringifier(new ThrowableObjectStringifier($jsonEncodableStringifier, $quoter));
$stringifier->prependStringifier(new DateTimeStringifier($quoter, DateTimeInterface::ATOM));
$stringifier->prependStringifier(new IteratorObjectStringifier($stringifier, $quoter));
return $stringifier;
}
}