Tool/Framework/Provider/Signature.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: Signature.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Tool_Framework_Provider_Signature

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_Provider_Signature
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; $_provider; $_name; $_specialties; $_actionableMethods; $_actions; $_providerReflection; $_isProcessed
Methods: __construct; setRegistry; process; getName; getProvider; getProviderReflection; getSpecialties; getActions; getActionableMethods; getActionableMethod; getActionableMethodByActionName; _process; _processName; _processSpecialties; _processActionableMethods

Description

The purpose of Zend_Tool_Framework_Provider_Signature is to derive callable signatures from the provided provider.

Properties

$_actionableMethods
jump to class

array $_actionableMethods = 'array'

Details

$_actionableMethods: array
visibility: protected
default: array
final: false
static: false

$_actions
jump to class

unknown_type $_actions = 'array'

Details

$_actions: unknown_type
visibility: protected
default: array
final: false
static: false

$_isProcessed
jump to class

bool $_isProcessed = 'false'

Details

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

$_name
jump to class

string $_name = 'null'

Details

$_name: string
visibility: protected
default: null
final: false
static: false

$_provider
jump to class

Zend_Tool_Framework_Provider_Interface $_provider = 'null'

Details

$_provider: Zend_Tool_Framework_Provider_Interface
visibility: protected
default: null
final: false
static: false

$_providerReflection
jump to class

Zend_Reflection_Class $_providerReflection = 'null'

Details

$_providerReflection: Zend_Reflection_Class
visibility: protected
default: null
final: false
static: false

$_registry
jump to class

Zend_Tool_Framework_Registry $_registry = 'null'

Details

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

$_specialties
jump to class

array $_specialties = 'array'

Details

$_specialties: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          Zend_Tool_Framework_Provider_Interface $provider
          )
        
        :

Constructor

Arguments

$provider: Zend_Tool_Framework_Provider_Interface

Details

visibility: public
final: false
static: false

_process
jump to class

_process(
          
          )
        
        :

_process() is called at construction time and is what will build the signature information for determining what is actionable

Details

visibility: protected
final: false
static: false

_processActionableMethods
jump to class

_processActionableMethods(
          
          )
        
        :

_processActionableMethods() - process all methods that can be called on this provider.

Details

visibility: protected
final: false
static: false

_processName
jump to class

_processName(
          
          )
        
        :

_processName();

Details

visibility: protected
final: false
static: false

_processSpecialties
jump to class

_processSpecialties(
          
          )
        
        :

_processSpecialties() - Break out the specialty names for this provider

Details

visibility: protected
final: false
static: false

getActionableMethod
jump to class

getActionableMethod(
          string $methodName
          )
        
        :
        array

getActionableMethod() - Get an actionable method by name, this will return an array of useful information about what can be exectued on this provider

Arguments

$methodName: string

Output

array

Details

visibility: public
final: false
static: false

getActionableMethodByActionName
jump to class

getActionableMethodByActionName(
          string $actionName,  $specialtyName
              =
              _Global
          )
        
        :
        array

getActionableMethodByActionName() - Get an actionable method by its action name, this will return an array of useful information about what can be exectued on this provider

Arguments

$actionName: string
$specialtyName

Output

array

Details

visibility: public
final: false
static: false

getActionableMethods
jump to class

getActionableMethods(
          
          )
        
        :
        array

getActionableMethods()

Output

array

Details

visibility: public
final: false
static: false

getActions
jump to class

getActions(
          
          )
        
        :
        array

getActions()

Output

array: Array of Actions

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        unknown

getName() of the provider

Output

unknown

Details

visibility: public
final: false
static: false

getProvider
jump to class

getProvider(
          
          )
        
        :
        Zend_Tool_Framework_Provider_Interface

Get the provider for this signature

Output

Zend_Tool_Framework_Provider_Interface

Details

visibility: public
final: false
static: false

getProviderReflection
jump to class

getProviderReflection(
          
          )
        
        :
        Zend_Reflection_Class

getProviderReflection()

Output

Zend_Reflection_Class

Details

visibility: public
final: false
static: false

getSpecialties
jump to class

getSpecialties(
          
          )
        
        :
        array

getSpecialities()

Output

array

Details

visibility: public
final: false
static: false

process
jump to class

Details

visibility: public
final: false
static: false

setRegistry
jump to class

setRegistry(
          Zend_Tool_Framework_Registry_Interface $registry
          )
        
        :
        Zend_Tool_Framework_Provider_Signature

setRegistry()

Arguments

$registry: Zend_Tool_Framework_Registry_Interface

Output

Zend_Tool_Framework_Provider_Signature

Details

visibility: public
final: false
static: false

API Documentation

Tool/Framework/Provider/Signature.php

Description

Zend_Tool_Framework_Provider_Signaturejump to top

Description

Properties

$_actionableMethodsjump to class

Details

$_actionsjump to class

Details

$_isProcessedjump to class

Details

$_namejump to class

Details

$_providerjump to class

Details

$_providerReflectionjump to class

Details

$_registryjump to class

Details

$_specialtiesjump to class

Details

Methods

__constructjump to class

Arguments

Details

_processjump to class

Details

_processActionableMethodsjump to class

Details

_processNamejump to class

Details

_processSpecialtiesjump to class

Details

getActionableMethodjump to class

Arguments

Output

Details

getActionableMethodByActionNamejump to class

Arguments

Output

Details

getActionableMethodsjump to class

Output

Details

getActionsjump to class

Output

Details

getNamejump to class

Output

Details

getProviderjump to class

Output

Details

getProviderReflectionjump to class

Output

Details

getSpecialtiesjump to class

Output

Details

processjump to class

Details

setRegistryjump to class

Arguments

Output

Details

Zend_Tool_Framework_Provider_Signature
jump to top

$_actionableMethods
jump to class

$_actions
jump to class

$_isProcessed
jump to class

$_name
jump to class

$_provider
jump to class

$_providerReflection
jump to class

$_registry
jump to class

$_specialties
jump to class

__construct
jump to class

_process
jump to class

_processActionableMethods
jump to class

_processName
jump to class

_processSpecialties
jump to class

getActionableMethod
jump to class

getActionableMethodByActionName
jump to class

getActionableMethods
jump to class

getActions
jump to class

getName
jump to class

getProvider
jump to class

getProviderReflection
jump to class

getSpecialties
jump to class

process
jump to class

setRegistry
jump to class