Class ServerShell

built-in Server Shell

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

Constants summary

Properties summary

Method Summary

  • _welcome() protected
    Displays a header for the shell
  • Gets the option parser instance and configures it.
  • initialize() public
    Override initialize of the Shell
  • main() public
    Override main() to handle action
  • startup() public

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

Method Detail

_welcome()source protected

_welcome( )

Displays a header for the shell

getOptionParser()source public

getOptionParser( )

Gets the option parser instance and configures it.

Returns

ConsoleOptionParser

initialize()source public

initialize( )

Override initialize of the Shell

main()source public

main( )

Override main() to handle action

startup()source public

startup( )

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

Override this method if you want to remove the welcome information, or otherwise modify the pre-command flow.

Link

https://book.cakephp.org/2.0/en/console-and-shells.html#Shell::startup

Properties detail

$_documentRootsource

protected string

document root

null

$_hostsource

protected string

server host

null

$_portsource

protected string

listen port

null

© 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-ServerShell.html