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

  • ConsoleErrorHandler
  • ConsoleInput
  • ConsoleInputArgument
  • ConsoleInputOption
  • ConsoleInputSubcommand
  • ConsoleOptionParser
  • ConsoleOutput
  • HelpFormatter
  • Shell
  • ShellDispatcher
  • TaskCollection

Class ConsoleInputOption

An object to represent a single option used in the command line. ConsoleOptionParser creates these when you use addOption()

Package: Cake\Console
See: ConsoleOptionParser::addOption()
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Console/ConsoleInputOption.php

Properties summary

  • $_boolean protected
    boolean
    Is the option a boolean option. Boolean options do not consume a parameter.
  • $_choices protected
    array
    An array of choices for the option.
  • $_default protected
    mixed
    Default value for the option
  • $_help protected
    string
    Help text for the option.
  • $_name protected
    string
    Name of the option
  • $_short protected
    string
    Short (1 character) alias for the option.

Method Summary

  • __construct() public
    Make a new Input Option
  • defaultValue() public
    Get the default value for this option
  • help() public
    Generate the help for this this option.
  • isBoolean() public
    Check if this option is a boolean option
  • name() public
    Get the value of the name attribute.
  • short() public
    Get the value of the short attribute.
  • usage() public
    Get the usage value for this option
  • validChoice() public
    Check that a value is a valid choice for this option.
  • xml() public
    Append the option's xml into the parent.

Method Detail

__construct() public ¶

__construct( string|array $name , string $short = null , string $help = '' , boolean $boolean = false , string $default = '' , array $choices = array() )

Make a new Input Option

Parameters
string|array $name
The long name of the option, or an array with all the properties.
string $short optional null
The short alias for this option
string $help optional ''
The help text for this option
boolean $boolean optional false
Whether this option is a boolean option. Boolean options don't consume extra tokens
string $default optional ''
The default value for this option.
array $choices optional array()
Valid choices for this option.
Throws
ConsoleException

defaultValue() public ¶

defaultValue( )

Get the default value for this option

Returns
mixed

help() public ¶

help( integer $width = 0 )

Generate the help for this this option.

Parameters
integer $width optional 0
The width to make the name of the option.
Returns
string

isBoolean() public ¶

isBoolean( )

Check if this option is a boolean option

Returns
boolean

name() public ¶

name( )

Get the value of the name attribute.

Returns
string
Value of this->_name.

short() public ¶

short( )

Get the value of the short attribute.

Returns
string
Value of this->_short.

usage() public ¶

usage( )

Get the usage value for this option

Returns
string

validChoice() public ¶

validChoice( string $value )

Check that a value is a valid choice for this option.

Parameters
string $value
The choice to validate.
Returns
boolean
Throws
ConsoleException

xml() public ¶

xml( SimpleXmlElement $parent )

Append the option's xml into the parent.

Parameters
SimpleXmlElement $parent
The parent element.
Returns
SimpleXmlElement
The parent with this option appended.

Properties detail

$_boolean ¶

protected boolean

Is the option a boolean option. Boolean options do not consume a parameter.

$_choices ¶

protected array

An array of choices for the option.

$_default ¶

protected mixed

Default value for the option

$_help ¶

protected string

Help text for the option.

$_name ¶

protected string

Name of the option

$_short ¶

protected string

Short (1 character) alias for the option.

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