Docs4dev
Docs
cakephp / 2.10 / class-apishell.html

Class ApiShell

API shell to show method signatures of CakePHP core classes.

Implementation of a Cake Shell to show CakePHP core method signatures.

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

Properties summary

  • $paths public
    array
    Map between short name for paths and real paths.

Method Summary

  • _parseClass() protected

    Parse a given class (located on given file) and get public methods and their signatures.

  • Gets the option parser instance and configures it.
  • help() public
    Show help for this shell.
  • initialize() public
    Override initialize of the Shell
  • main() public
    Override main() to handle action

Method Detail

_parseClass()source protected

_parseClass( string $path , string $class )

Parse a given class (located on given file) and get public methods and their signatures.

Parameters

string $path
File path
string $class
Class name

Returns

array
Methods and signatures indexed by method name

getOptionParser()source public

getOptionParser( )

Gets the option parser instance and configures it.

Returns

ConsoleOptionParser

help()source public

help( )

Show help for this shell.

initialize()source public

initialize( )

Override initialize of the Shell

main()source public

main( )

Override main() to handle action

Properties detail

$pathssource

public array

Map between short name for paths and real paths.

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-ApiShell.html