PHP_CodeSniffer_CLI::printPHPCBFUsage PHP Method

printPHPCBFUsage() public method

Prints out the usage information for PHPCBF.
public printPHPCBFUsage ( ) : void
return void
    public function printPHPCBFUsage()
    {
        echo 'Usage: phpcbf [-nwli] [-d key[=value]] [--stdin-path=<stdinPath>]' . PHP_EOL;
        echo '    [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>] [--suffix=<suffix>]' . PHP_EOL;
        echo '    [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]' . PHP_EOL;
        echo '    [--tab-width=<tabWidth>] [--encoding=<encoding>]' . PHP_EOL;
        echo '    [--extensions=<extensions>] [--ignore=<patterns>] [--bootstrap=<bootstrap>]' . PHP_EOL;
        echo '    [--file-list=<fileList>] <file> ...' . PHP_EOL;
        echo '        -n            Do not fix warnings (shortcut for --warning-severity=0)' . PHP_EOL;
        echo '        -w            Fix both warnings and errors (on by default)' . PHP_EOL;
        echo '        -l            Local directory only, no recursion' . PHP_EOL;
        echo '        -i            Show a list of installed coding standards' . PHP_EOL;
        echo '        -d            Set the [key] php.ini value to [value] or [true] if value is omitted' . PHP_EOL;
        echo '        --help        Print this help message' . PHP_EOL;
        echo '        --version     Print version information' . PHP_EOL;
        echo '        --no-patch    Do not make use of the "diff" or "patch" programs' . PHP_EOL;
        echo '        <file>        One or more files and/or directories to fix' . PHP_EOL;
        echo '        <fileList>    A file containing a list of files and/or directories to fix (one per line)' . PHP_EOL;
        echo '        <stdinPath>   If processing STDIN, the file path that STDIN will be processed as ' . PHP_EOL;
        echo '        <bootstrap>   A comma separated list of files to run before processing starts' . PHP_EOL;
        echo '        <encoding>    The encoding of the files being fixed (default is iso-8859-1)' . PHP_EOL;
        echo '        <extensions>  A comma separated list of file extensions to fix' . PHP_EOL;
        echo '                      (extension filtering only valid when checking a directory)' . PHP_EOL;
        echo '                      The type of the file can be specified using: ext/type' . PHP_EOL;
        echo '                      e.g., module/php,es/js' . PHP_EOL;
        echo '        <patterns>    A comma separated list of patterns to ignore files and directories' . PHP_EOL;
        echo '        <sniffs>      A comma separated list of sniff codes to include or exclude during fixing' . PHP_EOL;
        echo '                      (all sniffs must be part of the specified standard)' . PHP_EOL;
        echo '        <severity>    The minimum severity required to fix an error or warning' . PHP_EOL;
        echo '        <standard>    The name or path of the coding standard to use' . PHP_EOL;
        echo '        <suffix>      Write modified files to a filename using this suffix' . PHP_EOL;
        echo '                      ("diff" and "patch" are not used in this mode)' . PHP_EOL;
        echo '        <tabWidth>    The number of spaces each tab represents' . PHP_EOL;
    }