https://github.com/eddiriarte/console-select
A fancy selection interface for symfony's console component.
https://github.com/eddiriarte/console-select
cli laravel laravel-zero symfony
Last synced: 2 months ago
JSON representation
A fancy selection interface for symfony's console component.
- Host: GitHub
- URL: https://github.com/eddiriarte/console-select
- Owner: eddiriarte
- License: mit
- Created: 2018-01-26T09:33:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-04T16:00:23.000Z (over 3 years ago)
- Last Synced: 2025-10-22T01:24:18.453Z (5 months ago)
- Topics: cli, laravel, laravel-zero, symfony
- Language: PHP
- Size: 109 KB
- Stars: 12
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Console-Selection
A fancy selection interface for symfony's console component.
[](https://scrutinizer-ci.com/g/eddiriarte/console-select/?branch=master)
[](https://scrutinizer-ci.com/g/eddiriarte/console-select/?branch=master)
[](https://scrutinizer-ci.com/g/eddiriarte/console-select/build-status/master)
## Requirements
This project is inteded to be runned with one of this frameworks:
- laravel 5.6+
- symfony 5.0+
- laravel-zero 5.6+
## Install
```sh
composer require eddiriarte/console-select
```
### On Laravel/Laravel-Zero
Add the `SelectServiceProvider` to your provider list
```php
// app.php
'providers' => [
EddIriarte\Console\Providers\SelectServiceProvider::class,
],
```
### On Symfony
Add the `EddIriarte\Console\Traits\SelectableInputs` trait to your command class
```php
# importing : \EddIriarte\Console\Helpers\SelectionHelper
# pasing the input and output interfaces
$this->getHelperSet()->set(
new SelectionHelper($this->input, $this->output)
);
```
## Checkboxes
Useful when you need several answers from the user.
```php
$selected = $this->select(
'Select characters that appeared in "Star Wars, Episode I - The phantom menace"',
[
'Ahsoka Tano',
'Anakin Skywalker',
'Boba Fett',
'Chewbacca',
'Count Dooku',
'Darth Maul',
'Darth Vader',
'Finn',
'Han Solo',
'Jabba the Hutt',
'Jar Jar Binks',
'Kylo Ren',
'Lando Calrissian',
'Luke Skywalker',
'Mace Windu',
'Obi-Wan Kenobi',
'Padmé Amidala',
'Sheev Palpatine',
'Poe Dameron',
'Princess Leia Organa',
'Qui-Gon Jinn',
'Rey',
'Watto',
'Yoda',
]
);
```
## Radio
Useful when you need the user to pick only one anwer from the list.
```php
$selected = $this->select(
'What is the name of the ancient Jedi master that lives at the swamps of Dagobah',
[
'Ahsoka Tano',
'Anakin Skywalker',
'Boba Fett',
'Chewbacca',
'Count Dooku',
'Darth Maul',
'Darth Vader',
'Finn',
'Han Solo',
'Jabba the Hutt',
'Jar Jar Binks',
'Kylo Ren',
'Lando Calrissian',
'Luke Skywalker',
'Mace Windu',
'Obi-Wan Kenobi',
'Padmé Amidala',
'Sheev Palpatine',
'Poe Dameron',
'Princess Leia Organa',
'Qui-Gon Jinn',
'Rey',
'Watto',
'Yoda',
],
false // third argument(bool) that allows multiple selections (default: true)
);
```
## Still to do
- Handle user-interruptions, such as `Ctrl+C`
## MIT License
Copyright (c) 2018 Eduardo Iriarte
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.