CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.1 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.1
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
    • Network
      • Email
      • Http
    • Routing
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • AclShell
  • ApiShell
  • BakeShell
  • CommandListShell
  • ConsoleShell
  • I18nShell
  • SchemaShell
  • TestShell
  • TestsuiteShell
  • UpgradeShell

Class ConsoleShell

Provides a very basic 'interactive' console for CakePHP apps.

AppShell
Extended by ConsoleShell
Package: Cake\Console\Command
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Console/Command/ConsoleShell.php

Properties summary

  • $associations public
    array
    Available binding types
  • $badCommandChars public
    array
    Chars that describe invalid commands
  • $models public
    array
    Available models

Method Summary

  • _isValidModel() protected
    Tells if the specified model is included in the list of available models
  • _loadRoutes() protected

    Reloads the routes configuration from app/Config/routes.php, and compiles all routes found

  • help() public
    Prints the help message
  • main() public
    Override main() to handle action
  • startup() public
    Override startup of the Shell

Method Detail

_isValidModel() protected ¶

_isValidModel( string $modelToCheck )

Tells if the specified model is included in the list of available models

Parameters
string $modelToCheck
Returns
boolean
true if is an available model, false otherwise

_loadRoutes() protected ¶

_loadRoutes( )

Reloads the routes configuration from app/Config/routes.php, and compiles all routes found

Returns
boolean
True if config reload was a success, otherwise false

help() public ¶

help( )

Prints the help message

main() public ¶

main( string $command = null )

Override main() to handle action

Parameters
string $command optional null

startup() public ¶

startup( )

Override startup of the Shell

Properties detail

$associations ¶

public array

Available binding types

array('hasOne', 'hasMany', 'belongsTo', 'hasAndBelongsToMany')

$badCommandChars ¶

public array

Chars that describe invalid commands

array('$', ';')

$models ¶

public array

Available models

array()
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs