Prompts (Подсказки)

Введение
Установка
Доступные Prompts
Текст
Textarea
Пароль
Подтверждение
Выбор
Множественный выбор
Подсказка
Поиск
Множественный поиск
Пауза
Преобразование входных данных перед проверкой
Формы
Информационные Сообщения
Таблицы
Spin
Прогресс-бар
Очистка терминала
Учет Особенностей Терминала
Неподдерживаемые Окружения и Резервные Варианты

Введение

Laravel Prompts – это PHP-пакет, который позволяет добавлять красивые и удобные формы в ваши приложения командной строки, с функциями, подобными браузеру, включая плейсхолдеры и валидацию.

Laravel Prompts идеально подходит для приема пользовательского ввода в ваших командах Artisan консоли, но его также можно использовать в любом проекте с командной строкой на PHP.

Laravel Prompts поддерживает macOS, Linux и Windows с WSL. Для получения дополнительной информации, пожалуйста, ознакомьтесь с нашей документацией по не поддерживаемым средам и резервным вариантам.

Установка

Laravel Prompts уже включен в последний релиз Laravel.

Вы также можете установить Laravel Prompts в другие проекты PHP, используя менеджер пакетов Composer:

composer require laravel/prompts

Доступные Prompts

Текст

Функция text предложит пользователю указанный вопрос, примет введённый текст и затем вернет его:

use function Laravel\Prompts\text;

$name = text('Как вас зовут?');

Вы также можете добавить плейсхолдер, значение по умолчанию и информационную подсказку:

$name = text(
    label: 'Как вас зовут?',
    placeholder: 'Например: Тейлор Отвелл',
    default: $user?->name,
    hint: 'Это будет отображаться в вашем профиле.'
);

Обязательные значения

Если вам необходимо, чтобы было введено значение, вы можете передать аргумент required:

$name = text(
    label: 'Как вас зовут?',
    required: true
);

Если вы хотите настроить сообщение об ошибке валидации, вы также можете передать строку:

$name = text(
    label: 'Как вас зовут?',
    required: 'Требуется ваше имя.'
);

Дополнительная Валидация

Наконец, если вы хотите выполнить дополнительную логику валидации, вы можете передать замыкание в аргумент validate:

$name = text(
    label: 'Как вас зовут?',
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => 'Имя должно состоять минимум из 3 символов.',
        strlen($value) > 255 => 'Имя не должно превышать 255 символов.',
        default => null
    }
);

Замыкание получит введенное значение и может вернуть сообщение об ошибке или null, если валидация прошла успешно.

Альтернативно вы можете использовать возможности валидатора Laravel. Для этого предоставьте в аргумент validate массив, содержащий имя атрибута и желаемые правила проверки:

$name = text(
    label: 'Как вас зовут?',
    validate: ['name' => 'required|max:255|unique:users']
);

Textarea

Функция textarea предложит пользователю задать заданный вопрос, примет его ввод через многострочную текстовую область, а затем вернет его:

use function Laravel\Prompts\textarea;

$story = textarea('Расскажи мне историю.');

Вы также можете включить текст-заполнитель, значение по умолчанию и информационную подсказку:

$story = textarea(
    label: 'Расскажи мне историю.',
    placeholder: 'Это история о...',
    hint: 'Это будет отображаться в вашем профиле.'
);

Обязательные значения

Если вам требуется, чтобы значение было введено, то вы можете передать аргумент required:

$story = textarea(
    label: 'Расскажи мне историю.',
    required: true
);

Если вы хотите настроить сообщение проверки, вы также можете передать строку:

$story = textarea(
    label: 'Расскажи мне историю.',
    required: 'Требуется история.'
);

Дополнительная проверка

Наконец, если вы хотите выполнить дополнительную логику проверки, вы можете передать замыкание аргументу validate:

$story = textarea(
    label: 'Расскажи мне историю.',
    validate: fn (string $value) => match (true) {
        strlen($value) < 250 => 'В рассказе должно быть не менее 250 символов.',
        strlen($value) > 10000 => 'Рассказ не должен превышать 10 000 символов.',
        default => null
    }
);

Замыкание получит введенное значение и может вернуть сообщение об ошибке или значение null, если проверка пройдет успешно.

$story = textarea(
    label: 'Расскажи мне историю.',
    validate: ['story' => 'required|max:10000']
);

Пароль

Функция password аналогична функции text, но ввод пользователя будет маскироваться при вводе в консоли. Это полезно при запросе чувствительной информации, такой как пароли:

use function Laravel\Prompts\password;

$password = password('Какой у вас пароль?');

Вы также можете включить плейсхолдер и информационную подсказку:

$password = password(
    label: 'Какой у вас пароль?',
    placeholder: 'пароль',
    hint: 'Минимум 8 символов.'
);

Обязательные знаяения

Если вам необходимо, чтобы было введено значение, вы можете передать аргумент required:

$password = password(
    label: 'Какой у вас пароль?',
    required: true
);

Если вы хотите настроить сообщение об ошибке валидации, вы также можете передать строку:

$password = password(
    label: 'Какой у вас пароль?',
    required: 'Требуется пароль.'
);

Дополнительная Валидация

$password = password(
    label: 'Какой у вас пароль?',
    validate: fn (string $value) => match (true) {
        strlen($value) < 8 => 'Пароль должен состоять не менее 8 символов.',
        default => null
    }
);

Замыкание получит введенное значение и может вернуть сообщение об ошибке или null, если валидация проходит успешно.

$password = password(
    label: 'Какой у вас пароль?',
    validate: ['password' => 'min:8']
);

Если вам нужно запросить у пользователя подтверждение “да или нет”, вы можете использовать функцию confirm. Пользователи могут использовать стрелки или нажать y или n, чтобы выбрать свой ответ. Эта функция вернет либо true, либо false.

use function Laravel\Prompts\confirm;

$confirmed = confirm('Вы принимаете условия?');

Вы также можете включить значение по умолчанию, настраиваемые названия для меток “Да” и “Нет” и информационную подсказку:

$confirmed = confirm(
    label: 'Вы принимаете условия?',
    default: false,
    yes: 'Я принимаю',
    no: 'Я отказываюсь',
    hint: 'Чтобы продолжить, необходимо принять условия.'
);

Обязательное "Да"

При необходимости вы можете потребовать от ваших пользователей выбрать “Да”, передав аргумент required:

$confirmed = confirm(
    label: 'Вы принимаете условия?',
    required: true
);

Если вы хотите настроить сообщение об ошибке валидации, вы также можете передать строку:

$confirmed = confirm(
    label: 'Вы принимаете условия?',
    required: 'Вы должны принять условия, чтобы продолжить.'
);

Выбор

Если вам нужно, чтобы пользователь выбрал из предопределенного набора вариантов, вы можете использовать функцию select:

use function Laravel\Prompts\select;

$role = select(
    label: 'Какая роль должна быть у пользователя?',
    options: ['Member', 'Contributor', 'Owner']
);

Вы также можете указать значение по умолчанию и информационную подсказку:

$role = select(
    label: 'Какая роль должна быть у пользователя?',
    options: ['Member', 'Contributor', 'Owner'],
    default: 'Owner',
    hint: 'Роль может быть изменена в любой момент.'
);

Вы также можете передать ассоциативный массив в аргументе options, чтобы вернуть выбранный ключ вместо его значения:

$role = select(
    label: 'Какая роль должна быть у пользователя?',
    options: [
        'member' => 'Участник',
        'contributor' => 'Автор',
        'owner' => 'Владелец',
    ],
    default: 'owner'
);

При наличии более пяти вариантов будет использоваться прокрутка списка. Вы можете настроить это, передав аргумент scroll:

$role = select(
    label: 'Какую категорию вы хотели бы присвоить?',
    options: Category::pluck('name', 'id'),
    scroll: 10
);

Дополнительная валидация

В отличие от других, функция select не принимает аргумент required, потому что невозможно выбрать ничего. Однако, вы можете передать замыкание в аргумент validate, если вам нужно представить вариант, но предотвратить его выбор:

$role = select(
    label: 'Какая роль должна быть у пользователя?',
    options: [
        'member' => 'Учаастник',
        'contributor' => 'Автор',
        'owner' => 'Владелец',
    ],
    validate: fn (string $value) =>
        $value === 'owner' && User::where('role', 'owner')->exists()
            ? 'Владелец уже существует.'
            : null
);

Если аргумент options является ассоциативным массивом, то замыкание получит выбранный ключ, в противном случае оно получит выбранное значение. Замыкание может вернуть сообщение об ошибке или null, если валидация прошла успешно.

Множественный выбор

Если вам нужно, чтобы пользователь мог выбирать несколько вариантов, вы можете использовать функцию multiselect:

use function Laravel\Prompts\multiselect;

$permissions = multiselect(
    label: 'Какие разрешения следует назначить?',
    options: ['Read', 'Create', 'Update', 'Delete']
);

Вы также можете указать значения по умолчанию и информационную подсказку:

use function Laravel\Prompts\multiselect;

$permissions = multiselect(
    label: 'Какие разрешения следует назначить?',
    options: ['Read', 'Create', 'Update', 'Delete'],
    default: ['Read', 'Create'],
    hint: 'Разрешения могут быть обновлены в любое время.'
);

Вы также можете передать ассоциативный массив в аргумент options, чтобы возвращались ключи выбранных вариантов вместо их значений:

$permissions = multiselect(
    label: 'Какие разрешения следует назначить?',
    options: [
        'read' => 'Читать',
        'create' => 'Создавать',
        'update' => 'Обновлять',
        'delete' => 'Удалять',
    ],
    default: ['read', 'create']
);

$categories = multiselect(
    label: 'Какие категории следует присвоить?',
    options: Category::pluck('name', 'id'),
    scroll: 10
);

Обязательное значение

По умолчанию пользователь может выбирать ноль или более вариантов. Вы можете передать аргумент required, чтобы требовать один или более вариантов вместо этого:

$categories = multiselect(
    label: 'Какие категории следует присвоить?',
    options: Category::pluck('name', 'id'),
    required: true
);

Если вы хотите настроить сообщение об ошибке валидации, вы можете передать строку в аргумент required:

$categories = multiselect(
    label: 'Какие категории следует присвоить?',
    options: Category::pluck('name', 'id'),
    required: 'Вы должны выбрать хотя бы одну категорию'
);

Дополнительная валидация

Вы можете передать замыкание в аргумент validate, если вам нужно представить вариант, но предотвратить его выбор:

$permissions = multiselect(
    label: 'Какие разрешения должен иметь пользователь?',
    options: [
        'read' => 'Читать',
        'create' => 'Создавать',
        'update' => 'Обновлять',
        'delete' => 'Удалять',
    ],
    validate: fn (array $values) => ! in_array('read', $values)
        ? 'Всем пользователям требуется разрешение на чтение.'
        : null
);

Если аргумент options является ассоциативным массивом, то замыкание получит выбранные ключи, в противном случае оно получит выбранные значения. Замыкание может вернуть сообщение об ошибке или null, если валидация прошла успешно.

Подсказка

Функция suggest может использоваться для предоставления автозаполнения возможных вариантов. Пользователь все равно может ввести любой ответ, независимо от подсказок автозаполнения:

use function Laravel\Prompts\suggest;

$name = suggest('Как вас зовут?', ['Taylor', 'Dayle']);

В качестве альтернативы, вы можете передать замыкание вторым аргументом в функцию suggest. Замыкание будет вызываться каждый раз, когда пользователь вводит символ. Замыкание должно принимать строку, содержащую ввод пользователя до этого момента, и возвращать массив вариантов для автозаполнения:

$name = suggest(
    label: 'Как вас зовут?',
    options: fn ($value) => collect(['Taylor', 'Dayle'])
        ->filter(fn ($name) => Str::contains($name, $value, ignoreCase: true))
)

Вы также можете включить плейсхолдер текста, значение по умолчанию и информационную подсказку:

$name = suggest(
    label: 'Как вас зовут?',
    options: ['Тейлор', 'Дэйл'],
    placeholder: 'Например: Тейлор',
    default: $user?->name,
    hint: 'Это будет отображаться в вашем профиле.'
);

Обязательные значения

Если вам необходимо, чтобы было введено значение, вы можете передать аргумент required:

$name = suggest(
    label: 'Как вас зовут?',
    options: ['Тейлор', 'Дэйл'],
    required: true
);

Если вы хотите настроить сообщение об ошибке валидации, вы также можете передать строку:

$name = suggest(
    label: 'Как вас зовут?',
    options: ['Тейлор', 'Дэйл'],
    required: 'Требуется ваше имя.'
);

Дополнительная валидация

Наконец, если вам нужно выполнить дополнительную логику валидации, вы можете передать замыкание в аргумент validate:

$name = suggest(
    label: 'Как вас зовут?',
    options: ['Тейлор', 'Дэйл'],
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => 'Имя должно состоять минимум из 3 символов.',
        strlen($value) > 255 => 'Имя не должно превышать 255 символов.',
        default => null
    }
);

$name = suggest(
    label: 'Как вас зовут?',
    options: ['Тейлор', 'Дэйл'],
    validate: ['name' => 'required|min:3|max:255']
);

Поиск

Если у вас много вариантов для выбора пользователем, функция search позволяет пользователю вводить запрос поиска для фильтрации результатов, прежде чем использовать клавиши со стрелками для выбора параметра::

use function Laravel\Prompts\search;

$id = search(
    label: 'Найдите пользователя, который должен получать почту',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : []
);

Замыкание получит текст, введенный пользователем, и должно вернуть массив вариантов. Если вы возвращаете ассоциативный массив, то будет возвращен выбранный ключ, в противном случае будет возвращено его значение.

При фильтрации массива, в который вы собираетесь вернуть значение, вам следует использовать функцию array_values или метод Collection values, чтобы гарантировать, что массив не станет ассоциативным:

$names = collect(['Taylor', 'Abigail']);

$selected = search(
    label: 'Найдите пользователя, который должен получать почту',
    options: fn (string $value) => $names
        ->filter(fn ($name) => Str::contains($name, $value, ignoreCase: true))
        ->values()
        ->all(),
);

Вы также можете включить плейсхолдер и информационную подсказку:

$id = search(
    label: 'Найдите пользователя, который должен получать почту',
    placeholder: 'Например: Тейлор Отвелл',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    hint: 'Пользователь немедленно получит электронное письмо.'
);

При наличии более пяти аргументов будет использоваться прокрутка списка. Вы можете настроить это, передав аргумент scroll:

$id = search(
    label: 'Найдите пользователя, который должен получать почту',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    scroll: 10
);

Дополнительная валидация

Если вы хотите выполнить дополнительную логику валидации, вы можете передать замыкание в аргумент validate:

$id = search(
    label: 'Найдите пользователя, который должен получать почту',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    validate: function (int|string $value) {
        $user = User::findOrFail($value);

        if ($user->opted_out) {
            return 'Этот пользователь отказался от получения почты.';
        }
    }
);

Если замыкание options возвращает ассоциативный массив, то замыкание получит выбранный ключ, в противном случае оно получит выбранное значение. Замыкание может вернуть сообщение об ошибке или null, если валидация прошла успешно.

Множественный поиск

Если у вас много вариантов для поиска и вам нужно, чтобы пользователь мог выбирать несколько элементов, функция multisearch позволяет пользователю вводить запрос поиска для фильтрации результатов перед выбором вариантов с помощью стрелок и пробела:

use function Laravel\Prompts\multisearch;

$ids = multisearch(
    'Поиск пользователей, которые должны получать почту',
    fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : []
);

Замыкание получит текст, введенный пользователем до сих пор, и должно вернуть массив вариантов. Если вы возвращаете ассоциативный массив, то будут возвращены ключи выбранных вариантов; в противном случае будут возвращены их значения.

$names = collect(['Taylor', 'Abigail']);

$selected = multisearch(
    label: 'Поиск пользователей, которые должны получать почту',
    options: fn (string $value) => $names
        ->filter(fn ($name) => Str::contains($name, $value, ignoreCase: true))
        ->values()
        ->all(),
);

Вы также можете включить плейсхолдер текста и информационную подсказку:

$ids = multisearch(
    label: 'Поиск пользователей, которые должны получать почту',
    placeholder: 'Например: Тейлор Отвелл',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    hint: 'Пользователь немедленно получит электронное письмо.'
);

До пяти вариантов будет отображаться до начала прокрутки списка. Вы можете настроить это, указав аргумент scroll:

$ids = multisearch(
    label: 'Поиск пользователей, которые должны получать почту',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    scroll: 10
);

Обязательное значение

По умолчанию пользователь может выбрать ноль или более вариантов. Вы можете передать аргумент required, чтобы вместо этого требовать хотя бы один вариант:

$ids = multisearch(
    label: 'Поиск пользователей, которые должны получать почту',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    required: true
);

Если вы хотите настроить сообщение об ошибке валидации, вы также можете передать строку в аргумент required:

$ids = multisearch(
    label: 'Поиск пользователей, которые должны получать почту',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    required: 'Вы должны выбрать хотя бы одного пользователя.'
);

Дополнительная валидация

Если вам нужно выполнить дополнительную логику валидации, вы можете передать замыкание в аргумент validate:

$ids = multisearch(
    label: 'Поиск пользователей, которые должны получать почту',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    validate: function (array $values) {
        $optedOut = User::whereLike('name', '%a%')->findMany($values);

        if ($optedOut->isNotEmpty()) {
            return $optedOut->pluck('name')->join(', ', ', and ').' have opted out.';
        }
    }
);

Если замыкание options возвращает ассоциативный массив, то замыкание получит выбранные ключи; в противном случае оно получит выбранные значения. Замыкание может вернуть сообщение об ошибке или null, если валидация прошла успешно.

Пауза

Функция pause может использоваться для отображения информационного текста пользователю и ожидания его подтверждения продолжения нажатием клавиш Enter / Return:

use function Laravel\Prompts\pause;

pause('Нажмите ENTER, чтобы продолжить.');

Преобразование входных данных перед проверкой

Иногда вам может потребоваться преобразовать вводимые данные до того, как произойдет проверка. Например, вы можете удалить пробелы из любых предоставленных строк. Для этого многие функции приглашения предоставляют аргумент transform, который принимает замыкание:

$name = text(
    label: 'Как вас зовут?',
    transform: fn (string $value) => trim($value),
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => 'Имя должно состоять минимум из 3 символов.',
        strlen($value) > 255 => 'Имя не должно превышать 255 символов.',
        default => null
    }
);

Формы

Часто у вас будет несколько подсказок, которые будут отображаться последовательно для сбора информации перед выполнением дополнительных действий. Вы можете использовать функцию form для создания сгруппированного набора подсказок, которые пользователь должен выполнить:

use function Laravel\Prompts\form;

$responses = form()
    ->text('Как вас зовут?', required: true)
    ->password('Какой у вас пароль?', validate: ['password' => 'min:8'])
    ->confirm('Вы принимаете условия?')
    ->submit();

Метод submit вернет числовой индексированный массив, содержащий все ответы на запросы формы. Однако вы можете указать имя для каждого приглашения с помощью аргумента name. Если указано имя, доступ к ответу на указанное приглашение можно получить по этому имени:

use App\Models\User;
use function Laravel\Prompts\form;

$responses = form()
    ->text('Как вас зовут?', required: true, name: 'name')
    ->password(
        label: 'Какой у вас пароль?',
        validate: ['password' => 'min:8'],
        name: 'password'
    )
    ->confirm('Вы принимаете условия?')
    ->submit();

User::create([
    'name' => $responses['name'],
    'password' => $responses['password'],
]);

Основным преимуществом использования функции form является возможность для пользователя вернуться к предыдущим запросам в форме с помощью CTRL + U. Это позволяет пользователю исправлять ошибки или изменять выбор без необходимости отмены и перезапуска всей формы.

Если вам нужен более детальный контроль над подсказкой в форме, вы можете вызвать метод add вместо прямого вызова одной из функций подсказки. Методу add передаются все предыдущие ответы, предоставленные пользователем:

use function Laravel\Prompts\form;
use function Laravel\Prompts\outro;

$responses = form()
    ->text('Как вас зовут?', required: true, name: 'name')
    ->add(function ($responses) {
        return text("Сколько тебе лет, {$responses['name']}?");
    }, name: 'age')
    ->submit();

outro("Ваше имя {$responses['name']} и вам {$responses['age']} лет.");

Информационные Сообщения

Функции note, info, warning, error и alert могут быть использованы для отображения информационных сообщений:

use function Laravel\Prompts\info;

info('Пакет успешно установлен.');

Таблицы

Функция table упрощает отображение нескольких строк и столбцов данных. Все, что вам нужно сделать, это указать имена столбцов и данные для таблицы:

use function Laravel\Prompts\table;

table(
    headers: ['Name', 'Email'],
    rows: User::all(['name', 'email'])->toArray()
);

Spin

Функция spin отображает спиннер вместе с необязательным сообщением во время выполнения указанного обратного вызова. Она служит для обозначения выполнения процессов и возвращает результаты обратного вызова по его завершении:

use function Laravel\Prompts\spin;

$response = spin(
    message: 'Получение ответа...',
    callback: fn () => Http::get('http://example.com')
);

Функция spin требует наличие расширения PHP pcntl для анимации спиннера. Когда это расширение недоступно, вместо этого будет отображаться статическая версия спиннера.

Прогресс-бар

Для длительных задач может быть полезно показать полосу прогресса, которая информирует пользователей о том, насколько завершена задача. Используя функцию progress, Laravel будет отображать полосу прогресса и продвигать ее для каждой итерации по заданному итерируемому значению:

use function Laravel\Prompts\progress;

$users = progress(
    label: 'Обновление пользователей',
    steps: User::all(),
    callback: fn ($user) => $this->performTask($user)
);

Функция progress действует как функция map и вернет массив, содержащий возвращаемое значение каждой итерации вашего обратного вызова.

Обратный вызов также может принимать экземпляр Laravel\Prompts\Progress, что позволяет вам изменять метку и подсказку на каждой итерации:

$users = progress(
    label: 'Обновление пользователей',
    steps: User::all(),
    callback: function ($user, $progress) {
        $progress
            ->label("Обновление {$user->name}")
            ->hint("Создано {$user->created_at}");

        return $this->performTask($user);
    },
    hint: 'Это может занять некоторое время.'
);

Иногда вам может потребоваться больше ручного контроля над тем, как продвигается полоса прогресса. Сначала определите общее количество шагов, через которые будет проходить процесс. Затем продвигайте полосу прогресса с помощью метода advance после обработки каждого элемента:

$progress = progress(label: 'Обновление пользователей', steps: 10);

$users = User::all();

$progress->start();

foreach ($users as $user) {
    $this->performTask($user);

    $progress->advance();
}

$progress->finish();

Очистка терминала

Функция clear может использоваться для очистки пользовательского терминала:

use function Laravel\Prompts\clear;

clear();

Учет Особенностей Терминала

Ширина Терминала

Если длина какой-либо метки, варианта или сообщения о валидации превышает количество “столбцов” в терминале пользователя, она будет автоматически усечена до соответствия. Рассмотрите возможность минимизации длины этих строк, если ваши пользователи могут использовать более узкие терминалы. Обычно безопасная максимальная длина составляет 74 символа для поддержки терминала шириной 80 символов.

Высота Терминала

Для всех запросов, которые принимают аргумент scroll, настроенное значение будет автоматически уменьшено для соответствия высоте терминала пользователя, включая место для сообщения о валидации.

Неподдерживаемые Окружения и Резервные Варианты

Laravel Prompts поддерживает macOS, Linux и Windows с использованием WSL. Из-за ограничений в версии PHP для Windows в настоящее время невозможно использовать Laravel Prompts на Windows вне WSL.

По этой причине Laravel Prompts поддерживает откат к альтернативной реализации, такой как Symfony Console Question Helper.

При использовании Laravel Prompts с фреймворком Laravel резервные варианты для каждого запроса настроены для вас и будут автоматически включены в неподдерживаемых окружениях.

Условия Резервных Вариантов

Если вы не используете Laravel или нуждаетесь в настройке условий использования резервного поведения, вы можете передать булево значение методу fallbackWhen статического класса Prompt:

use Laravel\Prompts\Prompt;

Prompt::fallbackWhen(
    ! $input->isInteractive() || windows_os() || app()->runningUnitTests()
);

Поведение Резервного Варианта

Если вы не используете Laravel или вам нужно настроить поведение резервного варианта, вы можете передать замыкание методу fallbackUsing статического класса каждого prompt:

use Laravel\Prompts\TextPrompt;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\Console\Style\SymfonyStyle;

TextPrompt::fallbackUsing(function (TextPrompt $prompt) use ($input, $output) {
    $question = (new Question($prompt->label, $prompt->default ?: null))
        ->setValidator(function ($answer) use ($prompt) {
            if ($prompt->required && $answer === null) {
                throw new \RuntimeException(
                    is_string($prompt->required) ? $prompt->required : 'Required.'
                );
            }

            if ($prompt->validate) {
                $error = ($prompt->validate)($answer ?? '');

                if ($error) {
                    throw new \RuntimeException($error);
                }
            }

            return $answer;
        });

    return (new SymfonyStyle($input, $output))
        ->askQuestion($question);
});

Резервные варианты должны быть настроены индивидуально для каждого класса prompt. Замыкание будет получать экземпляр класса prompt и должно возвращать соответствующий тип для prompt.

Поддержите нас - каждый вклад важен!

Prompts (Подсказки)