API Documentation

Tool/Framework/Metadata/Tool.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Tool  
subpackage
Framework  
version
$Id: Tool.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Tool_Framework_Metadata_Tool

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

Properties

Propertyprotected  $_actionName= 'null'
Default valuenullDetails
Type
Propertyprotected  $_actionReference= 'null'
Default valuenullDetails
Type
Propertyprotected  $_clientName= 'null'
Default valuenullDetails
Type
Propertyprotected  $_clientReference= 'null'
Default valuenullDetails
Type
Propertyprotected  $_providerName= 'null'
Default valuenullDetails
Type
Propertyprotected  $_providerReference= 'null'
Default valuenullDetails
Type
Propertyprotected  $_specialtyName= 'null'
Default valuenullDetails
Type
Propertyprotectedstring  $_type= 'Tool'

Default valueToolDetails
Type
string

Methods

methodpublic__construct( array $options = array ) : void

Constructor - allows for the setting of options

Inherited from: \Zend_Tool_Framework_Metadata_Basic::__construct()
Parameters
Name Type Description
$options array
methodpublic__toString( ) : string

__toString() cast to string

Returns
Type Description
string
methodpublicgetActionName( ) : string

getActionName()

Returns
Type Description
string
methodpublicgetActionReference( ) : \Zend_Tool_Framework_Action_Interface

getActionReference()

Returns
Type Description
\Zend_Tool_Framework_Action_Interface
methodpublicgetAttributes( \const $type = self,  $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()
Parameters
Name Type Description
$type \const
$stringRepresentationOfNonScalars
Returns
Type Description
array
methodpublicgetClientName( ) : void

methodpublicgetClientReference( ) : \Zend_Tool_Framework_Client_Abstract

getClientReference()

Returns
Type Description
\Zend_Tool_Framework_Client_Abstract
methodpublicgetName( ) : string
Returns
Type Description
string
methodpublicgetProviderName( ) : string

getProviderName()

Returns
Type Description
string
methodpublicgetProviderReference( ) : \Zend_Tool_Framework_Provider_Interface

getProviderReference()

Returns
Type Description
\Zend_Tool_Framework_Provider_Interface
methodpublicgetReference( ) : mixed
Returns
Type Description
mixed
methodpublicgetSpecialtyName( ) : string

getSpecialtyName()

Returns
Type Description
string
methodpublicgetType( ) : string

The type of metadata this describes

Returns
Type Description
string
methodpublicgetValue( ) : mixed
Returns
Type Description
mixed
methodpublicsetActionName( string $actionName ) : \Zend_Tool_Framework_Metadata_Tool

setActionName()

Parameters
Name Type Description
$actionName string
Returns
Type Description
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetActionReference( \Zend_Tool_Framework_Action_Interface $action ) : \Zend_Tool_Framework_Metadata_Tool

setActionReference()

Parameters
Name Type Description
$action \Zend_Tool_Framework_Action_Interface
Returns
Type Description
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetClientName(  $clientName ) : void

Parameters
Name Type Description
$clientName
methodpublicsetClientReference( \Zend_Tool_Framework_Client_Abstract $client ) : \Zend_Tool_Framework_Metadata_Tool

setClientReference()

Parameters
Name Type Description
$client \Zend_Tool_Framework_Client_Abstract
Returns
Type Description
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetName( string $name ) : \Zend_Tool_Framework_Metadata_Basic
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetOptions( 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()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetProviderName( string $providerName ) : \Zend_Tool_Framework_Metadata_Tool

setProviderName()

Parameters
Name Type Description
$providerName string
Returns
Type Description
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetProviderReference( \Zend_Tool_Framework_Provider_Interface $provider ) : \Zend_Tool_Framework_Metadata_Tool

setProviderReference()

Parameters
Name Type Description
$provider \Zend_Tool_Framework_Provider_Interface
Returns
Type Description
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetReference( mixed $reference ) : \Zend_Tool_Framework_Metadata_Basic
Parameters
Name Type Description
$reference mixed
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetSpecialtyName( string $specialtyName ) : \Zend_Tool_Framework_Metadata_Tool

setSpecialtyName()

Parameters
Name Type Description
$specialtyName string
Returns
Type Description
\Zend_Tool_Framework_Metadata_Tool
methodpublicsetType( string $type ) : \Zend_Tool_Framework_Metadata_Basic
Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetValue(  $value ) : \Zend_Tool_Framework_Metadata_Basic
Parameters
Name Type Description
$value
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
Documentation was generated by DocBlox 0.13.3.