function Config::printShortUsage

Prints out the short usage information for this script.

Parameters

bool $return If TRUE, the usage string is returned: instead of output to screen.

Return value

string|void

3 calls to Config::printShortUsage()

Config::processFilePath in vendor/squizlabs/php_codesniffer/src/Config.php: Processes a file path and add it to the file list.
Config::processLongArgument in vendor/squizlabs/php_codesniffer/src/Config.php: Processes a long (--example) command-line argument.
Config::processUnknownArgument in vendor/squizlabs/php_codesniffer/src/Config.php: Processes an unknown command line argument.

File

vendor/squizlabs/php_codesniffer/src/Config.php, line 1373

Class

Config: Stores the configuration used to run PHPCS and PHPCBF.

Namespace

PHP_CodeSniffer

Code

public function printShortUsage($return = false) {
    if (PHP_CODESNIFFER_CBF === true) {
        $usage = 'Run "phpcbf --help" for usage information';
    }
    else {
        $usage = 'Run "phpcs --help" for usage information';
    }
    $usage .= PHP_EOL . PHP_EOL;
    if ($return === true) {
        return $usage;
    }
    echo $usage;
}