Skip to content
Laravel

프롬프트

소개

Laravel Prompts는 자리 표시자 텍스트 및 유효성 검사를 포함한 브라우저와 유사한 기능을 갖춘 명령줄 애플리케이션에 아름답고 사용자 친화적인 폼을 추가하기 위한 PHP 패키지입니다.

Laravel Prompts는 Artisan 콘솔 명령어에서 사용자 입력을 수락하는 데 적합하지만, 모든 명령줄 PHP 프로젝트에서도 사용할 수 있습니다.

lightbulb

Laravel Prompts는 macOS, Linux 및 WSL이 설치된 Windows를 지원합니다. 자세한 내용은 지원되지 않는 환경 및 폴백에 대한 문서를 참조하십시오.

설치

Laravel Prompts는 Laravel 최신 릴리스에 이미 포함되어 있습니다.

Laravel Prompts는 Composer 패키지 관리자를 사용하여 다른 PHP 프로젝트에 설치할 수도 있습니다.

composer require laravel/prompts

사용 가능한 프롬프트

텍스트

text 함수는 주어진 질문으로 사용자에게 프롬프트를 표시하고, 입력을 수락한 다음, 반환합니다.

use function Laravel\Prompts\text;
 
$name = text('What is your name?');

다음과 같이 자리 표시자 텍스트, 기본값 및 정보 힌트를 포함할 수도 있습니다.

$name = text(
    label: '이름이 무엇인가요?',
    placeholder: '예: Taylor Otwell',
    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의 validator 기능을 활용할 수 있습니다. 이렇게 하려면 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을 반환할 수 있습니다.

또는 Laravel의 validator의 기능을 활용할 수 있습니다. 그렇게 하려면 validate 인수에 속성 이름과 원하는 유효성 검사 규칙을 포함하는 배열을 제공하십시오:

$story = textarea(
    label: '이야기를 해주세요.',
    validate: ['story' => 'required|max:10000']
);

Password

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: '비밀번호는 필수 항목입니다.'
);

추가 유효성 검사

마지막으로, 추가적인 유효성 검사 로직을 수행하고 싶다면 validate 인수에 클로저를 전달할 수 있습니다:

$password = password(
    label: '비밀번호를 입력하세요.',
    validate: fn (string $value) => match (true) {
        strlen($value) < 8 => '비밀번호는 최소 8자 이상이어야 합니다.',
        default => null
    }
);

클로저는 입력된 값을 받아서 오류 메시지를 반환하거나, 유효성 검사가 통과되면 null을 반환할 수 있습니다.

또는 Laravel의 validator의 강력한 기능을 활용할 수도 있습니다. 그렇게 하려면 validate 인수에 속성 이름과 원하는 유효성 검사 규칙이 포함된 배열을 제공하십시오:

$password = password(
    label: '비밀번호를 입력하세요.',
    validate: ['password' => 'min:8']
);

Confirm

사용자에게 "예 또는 아니오" 확인을 요청해야 하는 경우 confirm 함수를 사용할 수 있습니다. 사용자는 화살표 키를 사용하거나 y 또는 n을 눌러 응답을 선택할 수 있습니다. 이 함수는 true 또는 false를 반환합니다.

use function Laravel\Prompts\confirm;
 
$confirmed = confirm('약관에 동의하십니까?');

기본값, "예" 및 "아니오" 레이블의 사용자 정의 문구 및 정보 힌트를 포함할 수도 있습니다:

$confirmed = confirm(
    label: 'Do you accept the terms?',
    default: false,
    yes: 'I accept',
    no: 'I decline',
    hint: 'The terms must be accepted to continue.'
);

"예" 응답 요구하기

필요한 경우, required 인자를 전달하여 사용자에게 "예"를 선택하도록 요구할 수 있습니다:

$confirmed = confirm(
    label: 'Do you accept the terms?',
    required: true
);

유효성 검사 메시지를 사용자 정의하고 싶다면, 문자열을 전달할 수도 있습니다:

$confirmed = confirm(
    label: 'Do you accept the terms?',
    required: 'You must accept the terms to continue.'
);

Select

사용자가 미리 정의된 선택지에서 선택해야 하는 경우, select 함수를 사용할 수 있습니다:

use function Laravel\Prompts\select;
 
$role = select(
    label: 'What role should the user have?',
    options: ['Member', 'Contributor', 'Owner']
);

기본 선택지와 정보성 힌트를 지정할 수도 있습니다:

$role = select(
    label: 'What role should the user have?',
    options: ['Member', 'Contributor', 'Owner'],
    default: 'Owner',
    hint: 'The role may be changed at any time.'
);

선택된 값 대신 해당 키가 반환되도록 options 인자에 연관 배열을 전달할 수도 있습니다:

$role = select(
    label: 'What role should the user have?',
    options: [
        'member' => 'Member',
        'contributor' => 'Contributor',
        'owner' => 'Owner',
    ],
    default: 'owner'
);

최대 5개의 옵션이 표시된 후 목록이 스크롤되기 시작합니다. scroll 인자를 전달하여 이를 사용자 정의할 수 있습니다:

$role = select(
    label: 'Which category would you like to assign?',
    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: ['읽기', '생성', '업데이트', '삭제']
);

기본 선택 사항과 정보 힌트를 지정할 수도 있습니다.

use function Laravel\Prompts\multiselect;
 
$permissions = multiselect(
    label: '어떤 권한을 할당해야 할까요?',
    options: ['읽기', '생성', '업데이트', '삭제'],
    default: ['읽기', '생성'],
    hint: '권한은 언제든지 업데이트할 수 있습니다.'
);

선택한 옵션의 값을 대신 키를 반환하기 위해 options 인수에 연관 배열을 전달할 수도 있습니다.

$permissions = multiselect(
    label: '어떤 권한을 할당해야 할까요?',
    options: [
        'read' => '읽기',
        'create' => '생성',
        'update' => '업데이트',
        'delete' => '삭제',
    ],
    default: ['read', 'create']
);

목록이 스크롤되기 전까지 최대 5개의 옵션이 표시됩니다. scroll 인수를 전달하여 이를 사용자 정의할 수 있습니다.

$categories = multiselect(
    label: '어떤 카테고리를 할당해야 할까요?',
    options: Category::pluck('name', 'id'),
    scroll: 10
);

값 요구 사항

기본적으로 사용자는 0개 이상의 옵션을 선택할 수 있습니다. 대신 하나 이상의 옵션을 강제하려면 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

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: ['Taylor', 'Dayle'],
    placeholder: '예: Taylor',
    default: $user?->name,
    hint: '이것은 당신의 프로필에 표시됩니다.'
);

필수 값

값을 입력해야 하는 경우 required 인자를 전달할 수 있습니다.

$name = suggest(
    label: '당신의 이름은 무엇입니까?',
    options: ['Taylor', 'Dayle'],
    required: true
);

유효성 검사 메시지를 사용자 지정하려면 문자열을 전달할 수도 있습니다.

$name = suggest(
    label: '당신의 이름은 무엇입니까?',
    options: ['Taylor', 'Dayle'],
    required: '이름은 필수 입력 사항입니다.'
);

추가 유효성 검사

마지막으로, 추가 유효성 검사 로직을 수행하려면 validate 인자에 클로저를 전달할 수 있습니다.

$name = suggest(
    label: '당신의 이름은 무엇입니까?',
    options: ['Taylor', 'Dayle'],
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => '이름은 최소 3자 이상이어야 합니다.',
        strlen($value) > 255 => '이름은 255자를 초과할 수 없습니다.',
        default => null
    }
);

클로저는 입력된 값을 받아서 오류 메시지를 반환하거나, 유효성 검사를 통과한 경우 null을 반환할 수 있습니다.

또는 라라벨의 validator 기능을 활용할 수도 있습니다. 그렇게 하려면, validate 인자에 속성 이름과 원하는 유효성 검사 규칙을 담은 배열을 제공하세요:

$name = suggest(
    label: '당신의 이름은 무엇입니까?',
    options: ['Taylor', 'Dayle'],
    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 함수나 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: '예: Taylor Otwell',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    hint: '사용자는 즉시 이메일을 받게 됩니다.'
);

목록이 스크롤되기 전에 최대 5개의 옵션이 표시됩니다. 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()
        : []
);

클로저는 지금까지 사용자가 입력한 텍스트를 받아서 옵션 배열을 반환해야 합니다. 만약 연관 배열을 반환하면 선택된 옵션의 키가 반환되고, 그렇지 않으면 값이 대신 반환됩니다.

값을 반환하려는 배열을 필터링할 때, 배열이 연관 배열이 되지 않도록 array_values 함수 또는 values 컬렉션 메서드를 사용해야 합니다.

$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: '예: Taylor Otwell',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    hint: '사용자는 즉시 이메일을 받게 됩니다.'
);

목록이 스크롤되기 전에 최대 5개의 옵션이 표시됩니다. scroll 인수를 제공하여 이를 사용자 정의할 수 있습니다.

$ids = multisearch(
    label: '메일을 받을 사용자를 검색하세요',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    scroll: 10
);

값 필수 지정

기본적으로 사용자는 0개 이상의 옵션을 선택할 수 있습니다. 대신 하나 이상의 옵션을 강제하려면 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 ').'님이 수신 거부했습니다.';
        }
    }
);

options 클로저가 연관 배열을 반환하면 클로저는 선택된 키를 받습니다. 그렇지 않으면 선택된 값을 받습니다. 클로저는 오류 메시지를 반환하거나 유효성 검사가 통과되면 null을 반환할 수 있습니다.

Pause

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: ['이름', '이메일'],
    rows: User::all(['name', 'email'])->toArray()
);

스핀

spin 함수는 지정된 콜백을 실행하는 동안 선택적 메시지와 함께 스피너를 표시합니다. 이는 진행 중인 프로세스를 나타내고 완료 시 콜백 결과를 반환하는 역할을 합니다:

use function Laravel\Prompts\spin;
 
$response = spin(
    message: '응답 가져오는 중...',
    callback: fn () => Http::get('http://example.com')
);
exclamation

spin 함수는 스피너를 애니메이션으로 표시하기 위해 pcntl PHP 확장 기능이 필요합니다. 이 확장 기능을 사용할 수 없는 경우 스피너의 정적 버전이 대신 표시됩니다.

진행률 표시줄

실행 시간이 오래 걸리는 작업의 경우, 사용자에게 작업 완료 정도를 알려주는 진행률 표시줄을 표시하는 것이 유용할 수 있습니다. progress 함수를 사용하면 Laravel은 진행률 표시줄을 표시하고 주어진 iterable 값에 대한 각 반복에 대해 진행률을 증가시킵니다.

use function Laravel\Prompts\progress;
 
$users = progress(
    label: 'Updating users',
    steps: User::all(),
    callback: fn ($user) => $this->performTask($user)
);

progress 함수는 map 함수처럼 작동하며, 콜백의 각 반복의 반환 값을 포함하는 배열을 반환합니다.

콜백은 각 반복에서 레이블 및 힌트를 수정할 수 있도록 Laravel\Prompts\Progress 인스턴스를 수락할 수도 있습니다.

$users = progress(
    label: 'Updating users',
    steps: User::all(),
    callback: function ($user, $progress) {
        $progress
            ->label("Updating {$user->name}")
            ->hint("Created on {$user->created_at}");
 
        return $this->performTask($user);
    },
    hint: 'This may take some time.'
);

경우에 따라 진행률 표시줄이 진행되는 방식을 더 수동으로 제어해야 할 수도 있습니다. 먼저 프로세스가 반복할 총 단계 수를 정의합니다. 그런 다음 각 항목을 처리한 후 advance 메서드를 통해 진행률 표시줄을 진행합니다.

$progress = progress(label: 'Updating users', 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();

터미널 고려 사항

터미널 너비

레이블, 옵션 또는 유효성 검사 메시지의 길이가 사용자 터미널의 "열" 수를 초과하면 자동으로 맞게 잘립니다. 사용자가 좁은 터미널을 사용할 수 있는 경우 이러한 문자열의 길이를 최소화하는 것을 고려하십시오. 일반적으로 안전한 최대 길이는 80자 터미널을 지원하기 위해 74자입니다.

터미널 높이

scroll 인수를 허용하는 모든 프롬프트에 대해 구성된 값은 유효성 검사 메시지를 위한 공간을 포함하여 사용자 터미널의 높이에 맞게 자동으로 줄어듭니다.

지원되지 않는 환경 및 폴백

Laravel Prompts는 macOS, Linux 및 WSL이 설치된 Windows를 지원합니다. PHP의 Windows 버전의 제한 사항으로 인해 현재 WSL 외부의 Windows에서는 Laravel Prompts를 사용할 수 없습니다.

이러한 이유로 Laravel Prompts는 Symfony Console Question Helper와 같은 대체 구현으로 폴백하는 것을 지원합니다.

lightbulb

Laravel 프레임워크와 함께 Laravel Prompts를 사용하는 경우 각 프롬프트에 대한 폴백이 구성되어 있으며 지원되지 않는 환경에서 자동으로 활성화됩니다.

폴백 조건

Laravel을 사용하지 않거나 폴백 동작이 사용되는 시점을 사용자 정의해야 하는 경우 Prompt 클래스의 fallbackWhen 정적 메서드에 부울 값을 전달할 수 있습니다.

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

폴백 동작

Laravel을 사용하지 않거나 폴백 동작을 사용자 정의해야 하는 경우 각 프롬프트 클래스의 fallbackUsing 정적 메서드에 클로저를 전달할 수 있습니다.

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);
});

폴백은 각 프롬프트 클래스별로 개별적으로 구성해야 합니다. 클로저는 프롬프트 클래스의 인스턴스를 수신하고 프롬프트에 적절한 유형을 반환해야 합니다.