scribe/src/Extracting/ValidationRuleDescriptionParser.php

<?php

namespace Knuckles\Scribe\Extracting;

class ValidationRuleDescriptionParser
{
    private $rule;

    private $arguments = [];

    /**
     * @param string $rule
     */
    public function __construct(string $rule = null)
    {
        $this->rule = $rule;
    }

    public static function getDescription(string $rule, array $arguments = [], $type = 'string'): string
    {
        $instance = new self($rule);

        $instance->arguments = $arguments;

        return $instance->makeDescription($type);
    }

    protected function makeDescription($baseType = 'string'): string
    {
        $description = trans("validation.{$this->rule}");
        // For rules that can apply to multiple types (eg 'max' rule), Laravel returns an array of possible messages
        // 'numeric' => 'The :attribute must not be greater than :max'
        // 'file' => 'The :attribute must have a size less than :max kilobytes'
        if (is_array($description)) {
            $description = $description[$baseType];
        }

        // Convert messages from failure type ("The value is not a valid date.") to info ("The value must be a valid date.")
        $description = str_replace(['is not', 'does not'], ['must be', 'must'], $description);

        return $this->replaceArguments($description);
    }

    protected function replaceArguments(string $description): string
    {
        foreach ($this->arguments as $placeholder => $argument) {
            $description = str_replace($placeholder, $argument, $description);
        }

        $description = str_replace("The :attribute", "The value", $description);

        return $description;
    }
}