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
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.1 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.1
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 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

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
      • Exception
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class ConsoleInputOption

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

Namespace: Cake\Console
See: ConsoleOptionParser::addOption()

Property Summary

  • $_boolean protected
    bool

    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 = '', string $help = '', bool $boolean = false, string $default = '', array $choices = [])

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

The short alias for this option

string $help optional

The help text for this option

bool $boolean optional

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

Valid choices for this option.

Throws
Cake\Console\Exception\ConsoleException

defaultValue() ¶ public

defaultValue(): mixed

Get the default value for this option

Returns
mixed

help() ¶ public

help(int $width = 0): string

Generate the help for this this option.

Parameters
int $width optional

The width to make the name of the option.

Returns
string

isBoolean() ¶ public

isBoolean(): bool

Check if this option is a boolean option

Returns
bool

name() ¶ public

name(): string

Get the value of the name attribute.

Returns
string

short() ¶ public

short(): string

Get the value of the short attribute.

Returns
string

usage() ¶ public

usage(): string

Get the usage value for this option

Returns
string

validChoice() ¶ public

validChoice(string $value): bool

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

Parameters
string $value

The choice to validate.

Returns
bool
Throws
Cake\Console\Exception\ConsoleException

xml() ¶ public

xml(SimpleXmlElement $parent): SimpleXmlElement

Append the option's xml into the parent.

Parameters
SimpleXmlElement $parent

The parent element.

Returns
SimpleXmlElement

Property Detail

$_boolean ¶ protected

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

Type
bool

$_choices ¶ protected

An array of choices for the option.

Type
array

$_default ¶ protected

Default value for the option

Type
mixed

$_help ¶ protected

Help text for the option.

Type
string

$_name ¶ protected

Name of the option

Type
string

$_short ¶ protected

Short (1 character) alias for the option.

Type
string
OpenHub
Pingping
Linode
  • 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
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs