Tool/Framework/Provider/Signature.php

Show: PublicProtectedPrivateinherited
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Tool  
Subpackage
Framework  
Version
$Id$  

\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
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_actionableMethods = array()
Default valuearray()Details
Type
array
>VPropertyprotected\unknown_type $_actions = array()
Default valuearray()Details
Type
\unknown_type
>VPropertyprotectedbool $_isProcessed = false
Default valuefalseDetails
Type
bool
>VPropertyprotectedstring $_name = null
Default valuenullDetails
Type
string
>VPropertyprotected\Zend_Tool_Framework_Provider_Interface $_provider = null
Default valuenullDetails
Type
\Zend_Tool_Framework_Provider_Interface
>VPropertyprotected\Zend_Reflection_Class $_providerReflection = null
Default valuenullDetails
Type
\Zend_Reflection_Class
>VPropertyprotected\Zend_Tool_Framework_Registry $_registry = null
Default valuenullDetails
Type
\Zend_Tool_Framework_Registry
>VPropertyprotectedarray $_specialties = array()
Default valuearray()Details
Type
array

Methods

methodpublic__construct(\Zend_Tool_Framework_Provider_Interface $provider) : void

Constructor

Parameters
NameTypeDescription
$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
NameTypeDescription
$methodNamestring
Returns
TypeDescription
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
NameTypeDescription
$actionNamestring
$specialtyName
Returns
TypeDescription
array
methodpublicgetActionableMethods() : array

getActionableMethods()

Returns
TypeDescription
array
methodpublicgetActions() : array

getActions()

Returns
TypeDescription
arrayArray of Actions
methodpublicgetName() : \unknown

getName() of the provider

Returns
TypeDescription
\unknown
methodpublicgetProvider() : \Zend_Tool_Framework_Provider_Interface

Get the provider for this signature

methodpublicgetProviderReflection() : \Zend_Reflection_Class

getProviderReflection()

Returns
TypeDescription
\Zend_Reflection_Class
methodpublicgetSpecialties() : array

getSpecialities()

Returns
TypeDescription
array
methodpublicprocess() : void

Documentation was generated by phpDocumentor 2.2.0 .