Docs4dev
Docs
cakephp / 2.10 / class-commandtask.html

Class CommandTask

Base class for Shell Command reflection.

AppShell
Extended by CommandTask
Package: Cake\Console\Command\Task
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Console/Command/Task/CommandTask.php

Method Summary

  • _appendShells() protected
    Scan the provided paths for shells, and append them into $shellList
  • commands() public
    Return a list of all commands
  • getShell() public
    Get Shell instance for the given command
  • Gets the shell command listing.
  • options() public
    Get Shell instance for the given command
  • Return a list of subcommands for a given command

Method Detail

_appendShells()source protected

_appendShells( string $type , array $shells , array $shellList )

Scan the provided paths for shells, and append them into $shellList

Parameters

string $type
The type of object.
array $shells
The shell name.
array $shellList
$shellList List of shells.

commands()source public

commands( )

Return a list of all commands

Returns

array

getShell()source public

getShell( mixed $commandName )

Get Shell instance for the given command

Parameters

mixed $commandName
The command you want.

Returns

mixed

getShellList()source public

getShellList( )

Gets the shell command listing.

Returns

array

options()source public

options( mixed $commandName )

Get Shell instance for the given command

Parameters

mixed $commandName
The command to get options for.

Returns

array

subCommands()source public

subCommands( string $commandName )

Return a list of subcommands for a given command

Parameters

string $commandName
The command you want subcommands from.

Returns

array

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-CommandTask.html