CLI.php

Static "constructor".

Get input from the shell, using readline or the standard STDIN Named options must be in the following formats: php index.php user -v --v -name=John --name=John

Asks the user for input. Usage: Takes any input $color = CLI::prompt('What is your favorite color?'); Takes any input, but offers default $color = CLI::prompt('What is your favourite color?', 'white'); Will validate options with the in_list rule and accept only if one of the list $color = CLI::prompt('What is your favourite color?', array('red','blue')); Do not provide options but requires a valid email $email = CLI::prompt('What is your email?', null, 'required|valid_email');

prompt(), but based on the option's key and the second value the text before asking to select one option. Provide empty string to omit

This method is the same as promptByKey(), but this method supports multiple keys, separated by commas. and the second value the text before asking to select one option. Provide empty string to omit

Validation for $options in promptByKey() and promptByMultipleKeys(). Return an error if $options is an empty array.

Print each key and value one by one

Validate one prompt "field" at a time

Outputs a string to the CLI without any surrounding newlines. Useful for showing repeating elements on a single line.

Outputs a string to the cli on its own line.

Outputs an error to the CLI using STDERR instead of STDOUT

Beeps a certain number of times.

Waits a certain number of seconds, optionally showing a wait message and waiting for a key press.

if operating system === windows

Enter a number of empty lines

Clears the screen of output

Returns the given text with the correct color codes for a foreground and optionally a background color.

Get the number of characters in string having encoded characters and ignores styles set by the color() function

Checks whether the current stream resource supports or refers to a valid terminal type device.

Returns true if the stream resource supports colors. This is tricky on Windows, because Cygwin, Msys2 etc. emulate pseudo terminals via named pipes, so we can only check the environment. Reference: https://github.com/composer/xdebug-handler/blob/master/src/Process.php

Attempts to determine the width of the viewable CLI window.

Attempts to determine the height of the viewable CLI window.

Populates the CLI's dimensions.

Displays a progress bar on the CLI. You must call it repeatedly to update it. Set $thisStep = false to erase the progress bar.

Takes a string and writes it to the command line, wrapping to a maximum width. If no maximum width is specified, will wrap to the window's max width. If an int is passed into $pad_left, then all strings after the first will pad with that many spaces to the left. Useful when printing short descriptions that need to start on an existing line.

Parses the command line it was called from and collects all options and valid segments.

Returns the command line string portions of the arguments, minus any options, as a string. This is used to pass along to the main CodeIgniter application.

Returns an individual segment. This ignores any options that might have been dispersed between valid segments in the command: segment(3) is 'three', not '-f' or 'anOption' > php spark one two -f anOption three IMPORTANT:** The index here is one-based instead of zero-based.

Returns the raw array of segments found.

Gets a single command-line option. Returns TRUE if the option exists, but doesn't have a value, and is simply acting as a flag.

Returns the raw array of options found.

Returns the options as a string, suitable for passing along on the CLI to other commands.

Returns a well formatted table

While the library is intended for use on CLI commands, commands can be called from controllers and elsewhere so we need a way to allow them to still work. For now, just echo the content, but look into a better solution down the road.

Testing purpose only

Testing purpose only