Class Shell

Constants summary

• integer
  CODE_ERROR ¶
  1
• integer
  NORMAL ¶
  1
• integer
  QUIET ¶
  0
• integer
  VERBOSE ¶
  2

Properties summary

• $OptionParser public
  ConsoleOptionParser
  An instance of ConsoleOptionParser that has been configured for this class.
• $Tasks public
  TaskCollection
  Task Collection for the command, used to create Tasks.
• $_helpers protected
  array
  Contains helpers which have been previously instantiated
• $_lastWritten protected
  integer

  The number of bytes last written to the output stream used when overwriting the previous message.

• $_taskMap protected
  string
  Normalized map of tasks.
• $args public
  array
  Contains arguments parsed from the command line.
• $command public
  string
  The command (method/task) that is being run.
• $interactive public
  boolean
  If true, the script will ask for permission to perform actions.
• $modelClass public
  string
  This shell's primary model class name, the first model in the $uses property
• $name public
  string
  The name of the shell in camelized.
• $params public
  array
  Contains command switches parsed from the command line.
• $plugin public
  string

  The name of the plugin the shell belongs to. Is automatically set by ShellDispatcher when a shell is constructed.

• $stderr public
  ConsoleOutput
  stderr object.
• $stdin public
  ConsoleInput
  stdin object
• $stdout public
  ConsoleOutput
  stdout object.
• $taskNames public
  array
  Contains the loaded tasks
• $tasks public
  array
  Contains tasks to load and instantiate
• $uses public
  array
  Contains models to load and instantiate

Method Summary

• __construct() public

  Constructs this Shell instance.

• __get() public

  Overload get for lazy building of tasks

• __isset() public

  Lazy loads models using the loadModel() method if declared in $uses

• _checkUnitTest() protected

  Action to create a Unit Test

• _configureStdErrLogger() protected

  Configure the stderr logger

• _configureStdOutLogger() protected

  Configure the stdout logger

• _controllerName() protected

  Creates the proper controller plural name for the specified controller class name

• _controllerPath() protected

  Creates the proper controller path for the specified controller class name

• _displayHelp() protected

  Display the help in the correct format

• _getInput() protected

  Prompts the user for input, and returns it.

• _loadModels() protected

  If $uses is an array load each of the models in the array

• _loggerIsConfigured() protected

  Checks if the given logger is configured

• _modelKey() protected

  Creates the proper underscored model key for associations

• _modelName() protected

  Creates the proper model camelized name (singularized) for the specified name

• _modelNameFromKey() protected

  Creates the proper model name from a foreign key

• _pluginPath() protected

  Find the correct path for a plugin. Scans $pluginPaths for the plugin you want.

• _pluralHumanName() protected

  Creates the plural human name used in views

• _pluralName() protected

  Creates the plural name for views

• _singularHumanName() protected

  Creates the singular human name used in views

• _singularName() protected

  creates the singular name for use in views.

• _useLogger() protected

  Used to enable or disable logging stream output to stdout and stderr If you don't wish to see in your stdout or stderr everything that is logged through CakeLog, call this function with first param as false

• _welcome() protected

  Displays a header for the shell

• clear() public

  Clear the console

• createFile() public

  Creates a file at given path

• dispatchShell() public

  Dispatch a command to another Shell. Similar to CakeObject::requestAction() but intended for running shells from other shells.

• err() public

  Outputs a single or multiple error messages to stderr. If no parameters are passed outputs just a newline.

• error() public

  Displays a formatted error message and exits the application with status code 1

• getOptionParser() public

  Gets the option parser instance and configures it.

• hasMethod() public

  Check to see if this shell has a callable method by the given name.

• hasTask() public

  Check to see if this shell has a task with the provided name.

• helper() public

  Load given shell helper class

• hr() public

  Outputs a series of minus characters to the standard output, acts as a visual separator.

• in() public

  Prompts the user for input, and returns it.

• initialize() public

  Initializes the Shell acts as constructor for subclasses allows configuration of tasks prior to shell execution

• loadModel() public

  Loads and instantiates models required by this shell.

• loadTasks() public

  Loads tasks defined in public $tasks

• nl() public

  Returns a single or multiple linefeeds sequences.

• out() public

  Outputs a single or multiple messages to stdout. If no parameters are passed outputs just a newline.

• overwrite() public

  Overwrite some already output text.

• param() public

  Safely access the values in $this->params.

• runCommand() public

  Runs the Shell with the provided argv.

• shortPath() public

  Makes absolute file path easier to read

• startup() public

  Starts up the Shell and displays the welcome message. Allows for checking and configuring prior to command or main execution

• wrapText() public

  Wrap a block of text. Allows you to set the width, and indenting on a block of text.

Method Detail

Methods inherited from CakeObject

Properties detail

array()

array()

array()

true

null

null

array()

null

array()

array()

array()