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.9 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.9
      • 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
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper
  • None

Classes

  • BaseShellHelper
  • ConsoleOutputStub
  • ProgressShellHelper
  • TableShellHelper

Class BaseShellHelper

CakePHP(tm) : Rapid Development Framework (http://cakephp.org) Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)

Licensed under The MIT License For full copyright and license information, please see the LICENSE.txt Redistributions of files must retain the above copyright notice.

Direct Subclasses
  • ProgressShellHelper
  • TableShellHelper
Abstract
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Link: CakePHP(tm) Project
Since: 2.8
License: MIT License
Location: Cake/Console/Helper/BaseShellHelper.php

Properties summary

  • $_config protected
    array
    Runtime config
  • $_configInitialized protected
    boolean
    Whether the config property has already been configured with defaults
  • $_consoleOutput protected
    ConsoleOutput
    ConsoleOutput instance.
  • $_defaultConfig protected
    array
    Default config for this helper.

Method Summary

  • __construct() public
    Constructor.
  • config() public
    Initialize config & store config values
  • output() abstract public
    This method should output content using $this->_consoleOutput.

Method Detail

__construct() public ¶

__construct( ConsoleOutput $consoleOutput , array $config = array() )

Constructor.

Parameters
ConsoleOutput $consoleOutput
The ConsoleOutput instance to use.
array $config optional array()
The settings for this helper.

config() public ¶

config( null $config = null )

Initialize config & store config values

Parameters
null $config optional null
Config values to set
Returns
array|

output() abstract public ¶

output( array $args )

This method should output content using $this->_consoleOutput.

Parameters
array $args
The arguments for the helper.

Properties detail

$_config ¶

protected array

Runtime config

array()

$_configInitialized ¶

protected boolean

Whether the config property has already been configured with defaults

false

$_consoleOutput ¶

protected ConsoleOutput

ConsoleOutput instance.

$_defaultConfig ¶

protected array

Default config for this helper.

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