C CakePHP 3.10 Red Velvet API

Namespace Console

Namespaces

Cake\Console\Exception

Interfaces

CommandCollectionAwareInterface

An interface for shells that take a CommandCollection during initialization.
CommandFactoryInterface

An interface for abstracting creation of command and shell instances.

Classes

Arguments

Provides an interface for interacting with a command's options and arguments.
Command

Base class for console commands.
CommandCollection

Collection for Commands.
CommandFactory

This is a factory for creating Command and Shell instances.
CommandRunner

Run CLI commands for the provided application.
CommandScanner

Used by CommandCollection and CommandTask to scan the filesystem for command classes.
ConsoleErrorHandler

Error Handler for Cake console. Does simple printing of the exception that occurred and the stack trace of the error.
ConsoleInput

Object wrapper for interacting with stdin
ConsoleInputArgument

An object to represent a single argument used in the command line. ConsoleOptionParser creates these when you use addArgument()
ConsoleInputOption

An object to represent a single option used in the command line. ConsoleOptionParser creates these when you use addOption()
ConsoleInputSubcommand

An object to represent a single subcommand used in the command line. Created when you call ConsoleOptionParser::addSubcommand()
ConsoleIo

A wrapper around the various IO operations shell tasks need to do.
ConsoleOptionParser

Handles parsing the ARGV in the command line and provides support for GetOpt compatible option definition. Provides a builder pattern implementation for creating shell option parsers.
ConsoleOutput

Object wrapper for outputting information from a shell application. Can be connected to any stream resource that can be used with fopen()
HelpFormatter

HelpFormatter formats help for console shells. Can format to either text or XML formats. Uses ConsoleOptionParser methods to generate help.
Helper

Base class for Helpers.
HelperRegistry

Registry for Helpers. Provides features for lazily loading helpers.
Shell

Base class for command-line utilities for automating programmer chores.
ShellDispatcher

Shell dispatcher handles dispatching cli commands.
TaskRegistry

Registry for Tasks. Provides features for lazily loading tasks.