Parameter.php

<?php

/*
 * This file is part of the PHP-CLI package.
 *
 * (c) Jitendra Adhikari <jiten.adhikary@gmail.com>
 *     <https://github.com/adhocore>
 *
 * Licensed under MIT license.
 */

namespace Ahc\Cli\Input;

use Ahc\Cli\Helper\InflectsString;

use function Ahc\Cli\t;
use function json_encode;
use function ltrim;
use function strpos;

/**
 * Cli Parameter.
 *
 * @author  Jitendra Adhikari <jiten.adhikary@gmail.com>
 * @license MIT
 *
 * @link    https://github.com/adhocore/cli
 */
abstract class Parameter
{
    use InflectsString;

    protected string $name;

    protected bool $required = false;

    protected bool $optional = false;

    protected bool $variadic = false;

    protected $filter = null;

    public function __construct(
        protected string $raw,
        protected string $desc = '',
        protected $default = null,
        $filter = null
    ) {
        $this->filter   = $filter;
        $this->required = strpos($raw, '<') !== false;
        $this->optional = strpos($raw, '[') !== false;
        $this->variadic = strpos($raw, '...') !== false;

        $this->parse($raw);
    }

    /**
     * Parse raw string representation of parameter.
     */
    abstract protected function parse(string $raw): void;

    /**
     * Get raw definition.
     */
    public function raw(): string
    {
        return $this->raw;
    }

    /**
     * Get name.
     */
    public function name(): string
    {
        return $this->name;
    }

    /**
     * Get description.
     */
    public function desc(bool $withDefault = false): string
    {
        if (!$withDefault || null === $this->default || '' === $this->default) {
            return $this->desc;
        }

        return ltrim(t('%1$s [default: %2$s]', [$this->desc, json_encode($this->default)]));
    }

    /**
     * Get normalized name.
     */
    public function attributeName(): string
    {
        return $this->toCamelCase($this->name);
    }

    /**
     * Check this param is required.
     */
    public function required(): bool
    {
        return $this->required;
    }

    /**
     * Check this param is optional.
     */
    public function optional(): bool
    {
        return $this->optional;
    }

    /**
     * Check this param is variadic.
     */
    public function variadic(): bool
    {
        return $this->variadic;
    }

    /**
     * Gets default value.
     */
    public function default(): mixed
    {
        if ($this->variadic()) {
            return (array) $this->default;
        }

        return $this->default;
    }

    /**
     * Run the filter/sanitizer/validato callback for this prop.
     */
    public function filter(mixed $raw): mixed
    {
        if ($this->filter) {
            $callback = $this->filter;

            return $callback($raw);
        }

        return $raw;
    }
}