src/Symfony/Component/Console/Input/RawInputInterface.php - 8.2 - githubmirror/symfony

src/Symfony/Component/Console/Input/RawInputInterface.php

56 строк2 KB

Nicolas Grekas

[Console] Various fixes and hardenings

18 май 2026, 20:28

18 май 2026, 20:28ce7d676

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Component\Console\Input;

/**
 * Provides access to the original input arguments and options
 * before they are merged with default values, and allows
 * unparsing options back to their CLI representation.
 *
 * @author Théo FIDRY <theo.fidry@gmail.com>
 */
interface RawInputInterface extends InputInterface
{
    /**
     * Returns all the given arguments NOT merged with the default values.
     *
     * @return array<string|bool|int|float|array<string|bool|int|float|null>|null>
     */
    public function getRawArguments(): array;

    /**
     * Returns all the given options NOT merged with the default values.
     *
     * @return array<string|bool|int|float|array<string|bool|int|float|null>|null>
     */
    public function getRawOptions(): array;

    /**
     * Returns a stringified representation of the options passed to the command.
     *
     * The returned strings interpolate raw option values verbatim and are NOT
     * shell-escaped. They are intended to be passed as an array argv to
     * {@see \Symfony\Component\Process\Process}, which performs its own
     * escaping. Never concatenate the result into a shell string nor pass it
     * to {@see \Symfony\Component\Process\Process::fromShellCommandline()},
     * `shell_exec()`, `exec()`, `system()`, `passthru()`, or `proc_open()`
     * with a string command: untrusted option values would allow command
     * injection.
     *
     * @param string[]|null $optionNames Names of the options returned. If null, all options are returned.
     *                                   Requested options that either do not exist or were not passed
     *                                   (even if the option has a default value) will be ignored.
     *
     * @return list<string>
     */
    public function unparse(?array $optionNames = null): array;
}