Tool/Framework/Metadata/Tool.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 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

Package: Zend\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

>VConstant  ATTRIBUTES_ALL = 'attributesAll'
>VConstant  ATTRIBUTES_NO_PARENT = 'attributesParent'

Properties

>VPropertyprotected$_actionName = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_actionReference = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_clientName = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_clientReference = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_name = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Tool_Framework_Metadata_Basic::$$_name  
>VPropertyprotected$_providerName = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_providerReference = null
Default valuenullDetails
Type
n/a
>VPropertyprotectedmixed $_reference = null
Default valuenullDetails
Type
mixed
Inherited_from
\Zend_Tool_Framework_Metadata_Basic::$$_reference  
>VPropertyprotected$_specialtyName = null
Default valuenullDetails
Type
n/a
>VPropertyprotectedstring $_type = 'Tool'
Default value'Tool'Details
Type
string
>VPropertyprotected$_value = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Tool_Framework_Metadata_Basic::$$_value  

Methods

methodpublic__construct(array $options = array()) : void
inherited

Constructor - allows for the setting of options

Inherited from: \Zend_Tool_Framework_Metadata_Basic::__construct()
Parameters
NameTypeDescription
$optionsarray
methodpublic__toString() : string

__toString() cast to string

Returns
TypeDescription
string
methodpublicgetActionName() : string

getActionName()

Returns
TypeDescription
string
methodpublicgetActionReference() : \Zend_Tool_Framework_Action_Interface

getActionReference()

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

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()
Parameters
NameTypeDescription
$type\const
$stringRepresentationOfNonScalars
Returns
TypeDescription
array
methodpublicgetClientName() : void

methodpublicgetClientReference() : \Zend_Tool_Framework_Client_Abstract

getClientReference()

methodpublicgetName() : string
inherited

getName()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getName()
Returns
TypeDescription
string
methodpublicgetProviderName() : string

getProviderName()

Returns
TypeDescription
string
methodpublicgetProviderReference() : \Zend_Tool_Framework_Provider_Interface

getProviderReference()

methodpublicgetReference() : mixed
inherited

getReference()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getReference()
Returns
TypeDescription
mixed
methodpublicgetSpecialtyName() : string

getSpecialtyName()

Returns
TypeDescription
string
methodpublicgetType() : string
inherited

getType()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getType()

The type of metadata this describes

Returns
TypeDescription
string
methodpublicgetValue() : mixed
inherited

getValue()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getValue()
Returns
TypeDescription
mixed
methodpublicsetActionName(string $actionName) : \Zend_Tool_Framework_Metadata_Tool

setActionName()

Parameters
NameTypeDescription
$actionNamestring
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetActionReference(\Zend_Tool_Framework_Action_Interface $action) : \Zend_Tool_Framework_Metadata_Tool

setActionReference()

Parameters
NameTypeDescription
$action\Zend_Tool_Framework_Action_Interface
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetClientName( $clientName) : void

Parameters
NameTypeDescription
$clientName
methodpublicsetClientReference(\Zend_Tool_Framework_Client_Abstract $client) : \Zend_Tool_Framework_Metadata_Tool

setClientReference()

Parameters
NameTypeDescription
$client\Zend_Tool_Framework_Client_Abstract
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetName(string $name) : \Zend_Tool_Framework_Metadata_Basic
inherited

setName()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setName()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetOptions(array $options) : \Zend_Tool_Framework_Metadata_Basic
inherited

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

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetProviderName(string $providerName) : \Zend_Tool_Framework_Metadata_Tool

setProviderName()

Parameters
NameTypeDescription
$providerNamestring
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetProviderReference(\Zend_Tool_Framework_Provider_Interface $provider) : \Zend_Tool_Framework_Metadata_Tool

setProviderReference()

Parameters
NameTypeDescription
$provider\Zend_Tool_Framework_Provider_Interface
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetReference(mixed $reference) : \Zend_Tool_Framework_Metadata_Basic
inherited

setReference()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setReference()
Parameters
NameTypeDescription
$referencemixed
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetSpecialtyName(string $specialtyName) : \Zend_Tool_Framework_Metadata_Tool

setSpecialtyName()

Parameters
NameTypeDescription
$specialtyNamestring
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetType(string $type) : \Zend_Tool_Framework_Metadata_Basic
inherited

setType()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setType()
Parameters
NameTypeDescription
$typestring
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetValue( $value) : \Zend_Tool_Framework_Metadata_Basic
inherited

setValue()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setValue()
Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
Documentation was generated by phpDocumentor 2.0.0a12.