Tool/Framework/Metadata/Tool.php
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: Tool.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Tool_Framework_Metadata_Tool
- Parent(s)
- \Zend_Tool_Framework_Metadata_Basic
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

ATTRIBUTES_ALL
= 'attributesAll'
- Inherited_from
- \Zend_Tool_Framework_Metadata_Basic::ATTRIBUTES_ALL

ATTRIBUTES_NO_PARENT
= 'attributesParent'
Properties


$_name = null
null
Details- Type
- n/a
- Inherited_from
- \Zend_Tool_Framework_Metadata_Basic::$$_name


mixed $_reference = null
null
Details- Type
- mixed
- Inherited_from
- \Zend_Tool_Framework_Metadata_Basic::$$_reference


$_value = null
null
Details- Type
- n/a
- Inherited_from
- \Zend_Tool_Framework_Metadata_Basic::$$_value
Methods


__construct(array $options = array()) : void
Constructor - allows for the setting of options
Inherited from: \Zend_Tool_Framework_Metadata_Basic::__construct()Name | Type | Description |
---|---|---|
$options | array |


getActionReference() : \Zend_Tool_Framework_Action_Interface
getActionReference()
Type | Description |
---|---|
\Zend_Tool_Framework_Action_Interface |


getAttributes(\const $type = self::ATTRIBUTES_ALL, $stringRepresentationOfNonScalars = false) : array
getAttributes() - this will retrieve any attributes of this object that exist as properties This is most useful for printing metadata.
Inherited from: \Zend_Tool_Framework_Metadata_Basic::getAttributes()Name | Type | Description |
---|---|---|
$type | \const | |
$stringRepresentationOfNonScalars |
Type | Description |
---|---|
array |


getClientReference() : \Zend_Tool_Framework_Client_Abstract
getClientReference()
Type | Description |
---|---|
\Zend_Tool_Framework_Client_Abstract |


getProviderReference() : \Zend_Tool_Framework_Provider_Interface
getProviderReference()
Type | Description |
---|---|
\Zend_Tool_Framework_Provider_Interface |


setActionName(string $actionName) : \Zend_Tool_Framework_Metadata_Tool
setActionName()
Name | Type | Description |
---|---|---|
$actionName | string |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Tool |


setActionReference(\Zend_Tool_Framework_Action_Interface $action) : \Zend_Tool_Framework_Metadata_Tool
setActionReference()
Name | Type | Description |
---|---|---|
$action | \Zend_Tool_Framework_Action_Interface |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Tool |


setClientReference(\Zend_Tool_Framework_Client_Abstract $client) : \Zend_Tool_Framework_Metadata_Tool
setClientReference()
Name | Type | Description |
---|---|---|
$client | \Zend_Tool_Framework_Client_Abstract |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Tool |


setName(string $name) : \Zend_Tool_Framework_Metadata_Basic
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Basic |


setOptions(array $options) : \Zend_Tool_Framework_Metadata_Basic
setOptions() - standard issue implementation, this will set any options that are supported via a set method.
Inherited from: \Zend_Tool_Framework_Metadata_Basic::setOptions()Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Basic |


setProviderName(string $providerName) : \Zend_Tool_Framework_Metadata_Tool
setProviderName()
Name | Type | Description |
---|---|---|
$providerName | string |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Tool |


setProviderReference(\Zend_Tool_Framework_Provider_Interface $provider) : \Zend_Tool_Framework_Metadata_Tool
setProviderReference()
Name | Type | Description |
---|---|---|
$provider | \Zend_Tool_Framework_Provider_Interface |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Tool |


setReference(mixed $reference) : \Zend_Tool_Framework_Metadata_Basic
Name | Type | Description |
---|---|---|
$reference | mixed |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Basic |


setSpecialtyName(string $specialtyName) : \Zend_Tool_Framework_Metadata_Tool
setSpecialtyName()
Name | Type | Description |
---|---|---|
$specialtyName | string |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Tool |


setType(string $type) : \Zend_Tool_Framework_Metadata_Basic
Name | Type | Description |
---|---|---|
$type | string |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Basic |


setValue( $value) : \Zend_Tool_Framework_Metadata_Basic
Name | Type | Description |
---|---|---|
$value |
Type | Description |
---|---|
\Zend_Tool_Framework_Metadata_Basic |