Zend Framework API Documentation » \Zend_Tool_Framework_Metadata

Methods
Properties

Constants
- ATTRIBUTES_ALL
```
ATTRIBUTES_ALL
```
- ATTRIBUTES_NO_PARENT
```
ATTRIBUTES_NO_PARENT
```

category	Zend
package	Zend_Tool
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_Tool_Framework_Metadata_Basic

Methods

Constructor - allows for the setting of options

__construct(array $options = array())

Inherited

Parameters

$options

array

__toString() cast to string

__toString() : string

inherited_from	\Zend_Tool_Framework_Metadata_Basic::__toString()

Returns

string

__toString() - string representation of this object

__toString() : string

Inherited

Returns

string

getActionName()

getActionName() : string

Returns

string

getActionReference()

getActionReference() : \Zend_Tool_Framework_Action_Interface

Returns

\Zend_Tool_Framework_Action_Interface

getAttributes() - this will retrieve any attributes of this object that exist as properties This is most useful for printing metadata.

getAttributes(\const $type = self::ATTRIBUTES_ALL, $stringRepresentationOfNonScalars = false) : array

Inherited

inherited_from	\Zend_Tool_Framework_Metadata_Attributable::getAttributes()

Parameters

$type

\const

$stringRepresentationOfNonScalars

Returns

array

getClientName()

getClientName()

getClientReference()

getClientReference() : \Zend_Tool_Framework_Client_Abstract

Returns

\Zend_Tool_Framework_Client_Abstract

getName()

getName() : string

Inherited

inherited_from	\Zend_Tool_Framework_Metadata_Interface::getName()

Returns

string

getProviderName()

getProviderName() : string

Returns

string

getProviderReference()

getProviderReference() : \Zend_Tool_Framework_Provider_Interface

Returns

\Zend_Tool_Framework_Provider_Interface

getReference()

getReference() : mixed

Inherited

Returns

mixed

getSpecialtyName()

getSpecialtyName() : string

Returns

string

getType()

getType() : string

Inherited

The type of metadata this describes

inherited_from	\Zend_Tool_Framework_Metadata_Interface::getType()

Returns

string

getValue()

getValue() : mixed

Inherited

inherited_from	\Zend_Tool_Framework_Metadata_Interface::getValue()

Returns

mixed

setActionName()

setActionName(string $actionName) : \Zend_Tool_Framework_Metadata_Tool

Parameters

$actionName

string

Returns

\Zend_Tool_Framework_Metadata_Tool

setActionReference()

setActionReference(\Zend_Tool_Framework_Action_Interface $action) : \Zend_Tool_Framework_Metadata_Tool

Parameters

$action

\Zend_Tool_Framework_Action_Interface

Returns

\Zend_Tool_Framework_Metadata_Tool

setClientName()

setClientName($clientName)

Parameters

$clientName

setClientReference()

setClientReference(\Zend_Tool_Framework_Client_Abstract $client) : \Zend_Tool_Framework_Metadata_Tool

Parameters

$client

\Zend_Tool_Framework_Client_Abstract

Returns

\Zend_Tool_Framework_Metadata_Tool

setName()

setName(string $name) : \Zend_Tool_Framework_Metadata_Basic

Inherited

Parameters

$name

string

Returns

\Zend_Tool_Framework_Metadata_Basic

setOptions() - standard issue implementation, this will set any options that are supported via a set method.

setOptions(array $options) : \Zend_Tool_Framework_Metadata_Basic

Inherited

Parameters

$options

array

Returns

\Zend_Tool_Framework_Metadata_Basic

setProviderName()

setProviderName(string $providerName) : \Zend_Tool_Framework_Metadata_Tool

Parameters

$providerName

string

Returns

\Zend_Tool_Framework_Metadata_Tool

setProviderReference()

setProviderReference(\Zend_Tool_Framework_Provider_Interface $provider) : \Zend_Tool_Framework_Metadata_Tool

Parameters

$provider

\Zend_Tool_Framework_Provider_Interface

Returns

\Zend_Tool_Framework_Metadata_Tool

setReference()

setReference(mixed $reference) : \Zend_Tool_Framework_Metadata_Basic

Inherited

Parameters

$reference

mixed

Returns

\Zend_Tool_Framework_Metadata_Basic

setSpecialtyName()

setSpecialtyName(string $specialtyName) : \Zend_Tool_Framework_Metadata_Tool

Parameters

$specialtyName

string

Returns

\Zend_Tool_Framework_Metadata_Tool

setType()

setType(string $type) : \Zend_Tool_Framework_Metadata_Basic

Inherited

Parameters

$type

string

Returns

\Zend_Tool_Framework_Metadata_Basic

setValue()

setValue($value) : \Zend_Tool_Framework_Metadata_Basic

Inherited

Parameters

$value

Returns

\Zend_Tool_Framework_Metadata_Basic

Properties

$_actionName

$_actionName

Default

null

$_actionReference

$_actionReference

Default

null

$_clientName

$_clientName

Default

null

$_clientReference

$_clientReference

Default

null

$_name

$_name

Default

null

$_providerName

$_providerName

Default

null

$_providerReference

$_providerReference

Default

null

$_reference

$_reference : mixed

Default

null

$_specialtyName

$_specialtyName

Default

null

$_type

$_type : string

Default

'Tool'

inherited_from	\Zend_Tool_Framework_Metadata_Basic::_type

$_type

$_type

Default

'Basic'

$_value

$_value

Default

null

Constants

ATTRIBUTES_ALL

ATTRIBUTES_ALL = 'attributesAll'

ATTRIBUTES_NO_PARENT

ATTRIBUTES_NO_PARENT = 'attributesParent'