Tool/Framework/Client/Console/ArgumentParser.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Tool
subpackage: Framework
version: $Id: ArgumentParser.php 22878 2010-08-21 19:59:35Z ramon $
Classes: Zend_Tool_Framework_Client_Console_ArgumentParser

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Tool_Framework_Client_Console_ArgumentParser
jump to top

Implements: Zend_Tool_Framework_Registry_EnabledInterface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Tool
Properties: $_registry; $_manifestRepository; $_request; $_response; $_argumentsOriginal; $_argumentsWorking; $_help; $_helpKnownAction; $_helpKnownProvider; $_helpKnownSpecialty
Methods: setArguments; setRegistry; parse; _parseGlobalPart; _parseActionPart; _parseProviderPart; _parseProviderOptionsPart; _createHelpResponse

Description

Properties

$_argumentsOriginal
jump to class

$_argumentsOriginal = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_argumentsWorking
jump to class

$_argumentsWorking = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_help
jump to class

bool $_help = 'false'

Details

$_help: bool
visibility: protected
default: false
final: false
static: false

$_helpKnownAction
jump to class

$_helpKnownAction = 'false'

Details

visibility: protected
default: false
final: false
static: false

$_helpKnownProvider
jump to class

$_helpKnownProvider = 'false'

Details

visibility: protected
default: false
final: false
static: false

$_helpKnownSpecialty
jump to class

$_helpKnownSpecialty = 'false'

Details

visibility: protected
default: false
final: false
static: false

$_manifestRepository
jump to class

Zend_Tool_Framework_Manifest_Repository $_manifestRepository = 'null'

Holds the manifest repository taken from the registry.

Details

$_manifestRepository: Zend_Tool_Framework_Manifest_Repository
visibility: protected
default: null
final: false
static: false

$_registry
jump to class

Zend_Tool_Framework_Registry_Interface $_registry = 'null'

Details

$_registry: Zend_Tool_Framework_Registry_Interface
visibility: protected
default: null
final: false
static: false

$_request
jump to class

Zend_Tool_Framework_Client_Request $_request = 'null'

Details

$_request: Zend_Tool_Framework_Client_Request
visibility: protected
default: null
final: false
static: false

$_response
jump to class

Zend_Tool_Framework_Client_Response $_response = 'null'

Details

$_response: Zend_Tool_Framework_Client_Response
visibility: protected
default: null
final: false
static: false

Methods

_createHelpResponse
jump to class

_createHelpResponse(
          unknown_type $options
              =
              array
          )
        
        :

_createHelpResponse

Arguments

$options: unknown_type

Details

visibility: protected
final: false
static: false

_parseActionPart
jump to class

_parseActionPart(
          
          )
        
        :
        null

Internal routine for parsing the action name from the arguments

Output

null

Details

visibility: protected
final: false
static: false

_parseGlobalPart
jump to class

_parseGlobalPart(
          
          )
        
        :
        null

Internal routine for parsing global options from the command line

Output

null

Details

visibility: protected
final: false
static: false

_parseProviderOptionsPart
jump to class

_parseProviderOptionsPart(
          
          )
        
        :
        null

Internal routine for parsing the provider options from the command line

Output

null

Details

visibility: protected
final: false
static: false

_parseProviderPart
jump to class

_parseProviderPart(
          
          )
        
        :
        null

Internal routine for parsing the provider part of the command line arguments

Output

null

Details

visibility: protected
final: false
static: false

parse
jump to class

Parse() - This method does the work of parsing the arguments into the enpooint request, this will also (during help operations) fill the response in with information as needed

Output

null

Details

visibility: public
final: false
static: false

setArguments
jump to class

setArguments(
          array $arguments
          )
        
        :
        Zend_Tool_Framework_Client_Console_ArgumentParser

setArguments

Arguments

$arguments: array

Output

Zend_Tool_Framework_Client_Console_ArgumentParser

Details

visibility: public
final: false
static: false

setRegistry
jump to class

setRegistry(
          Zend_Tool_Framework_Registry_Interface $registry
          )
        
        :
        Zend_Tool_Framework_Client_Console_ArgumentParser

setRegistry()

Arguments

$registry: Zend_Tool_Framework_Registry_Interface

Output

Zend_Tool_Framework_Client_Console_ArgumentParser

Details

visibility: public
final: false
static: false

API Documentation

Tool/Framework/Client/Console/ArgumentParser.php

Description

Zend_Tool_Framework_Client_Console_ArgumentParserjump to top

Description

Properties

$_argumentsOriginaljump to class

Details

$_argumentsWorkingjump to class

Details

$_helpjump to class

Details

$_helpKnownActionjump to class

Details

$_helpKnownProviderjump to class

Details

$_helpKnownSpecialtyjump to class

Details

$_manifestRepositoryjump to class

Details

$_registryjump to class

Details

$_requestjump to class

Details

$_responsejump to class

Details

Methods

_createHelpResponsejump to class

Arguments

Details

_parseActionPartjump to class

Output

Details

_parseGlobalPartjump to class

Output

Details

_parseProviderOptionsPartjump to class

Output

Details

_parseProviderPartjump to class

Output

Details

parsejump to class

Output

Details

setArgumentsjump to class

Arguments

Output

Details

setRegistryjump to class

Arguments

Output

Details

Zend_Tool_Framework_Client_Console_ArgumentParser
jump to top

$_argumentsOriginal
jump to class

$_argumentsWorking
jump to class

$_help
jump to class

$_helpKnownAction
jump to class

$_helpKnownProvider
jump to class

$_helpKnownSpecialty
jump to class

$_manifestRepository
jump to class

$_registry
jump to class

$_request
jump to class

$_response
jump to class

_createHelpResponse
jump to class

_parseActionPart
jump to class

_parseGlobalPart
jump to class

_parseProviderOptionsPart
jump to class

_parseProviderPart
jump to class

parse
jump to class

setArguments
jump to class

setRegistry
jump to class