API Documentation

Zend/Tool/Framework/Provider/Signature.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Tool  
Subpackage
Framework  
Version
$Id: Signature.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tool_Framework_Provider_Signature

Package: Zend\Tool

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

Implements
\Zend_Tool_Framework_Registry_EnabledInterface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_actionableMethods= 'array()'

Default valuearray()Details
Type
array
Propertyprotected\unknown_type  $_actions= 'array()'

Default valuearray()Details
Type
\unknown_type
Propertyprotectedbool  $_isProcessed= 'false'

Default valuefalseDetails
Type
bool
Propertyprotectedstring  $_name= 'null'

Default valuenullDetails
Type
string
Propertyprotected\Zend_Tool_Framework_Provider_Interface  $_provider= 'null'

Default valuenullDetails
Type
\Zend_Tool_Framework_Provider_Interface
Propertyprotected\Zend_Reflection_Class  $_providerReflection= 'null'

Default valuenullDetails
Type
\Zend_Reflection_Class
Propertyprotected\Zend_Tool_Framework_Registry  $_registry= 'null'

Default valuenullDetails
Type
\Zend_Tool_Framework_Registry
Propertyprotectedarray  $_specialties= 'array()'

Default valuearray()Details
Type
array

Methods

methodpublic__construct( \Zend_Tool_Framework_Provider_Interface $provider ) : void

Constructor

Parameters
Name Type Description
$provider \Zend_Tool_Framework_Provider_Interface
methodprotected_process( ) : void

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

methodprotected_processActionableMethods( ) : void

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

methodprotected_processName( ) : void

_processName();

methodprotected_processSpecialties( ) : void

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

methodpublicgetActionableMethod( 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

Parameters
Name Type Description
$methodName string
Returns
Type Description
array
methodpublicgetActionableMethodByActionName( 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

Parameters
Name Type Description
$actionName string
$specialtyName
Returns
Type Description
array
methodpublicgetActionableMethods( ) : array

getActionableMethods()

Returns
Type Description
array
methodpublicgetActions( ) : array

getActions()

Returns
Type Description
array Array of Actions
methodpublicgetName( ) : \unknown

getName() of the provider

Returns
Type Description
\unknown
methodpublicgetProvider( ) : \Zend_Tool_Framework_Provider_Interface

Get the provider for this signature

Returns
Type Description
\Zend_Tool_Framework_Provider_Interface
methodpublicgetProviderReflection( ) : \Zend_Reflection_Class

getProviderReflection()

Returns
Type Description
\Zend_Reflection_Class
methodpublicgetSpecialties( ) : array

getSpecialities()

Returns
Type Description
array
methodpublicprocess( ) : void

methodpublicsetRegistry( \Zend_Tool_Framework_Registry_Interface $registry ) : \Zend_Tool_Framework_Provider_Signature

setRegistry()

Parameters
Name Type Description
$registry \Zend_Tool_Framework_Registry_Interface
Returns
Type Description
\Zend_Tool_Framework_Provider_Signature
Documentation was generated by DocBlox 0.15.1.