Tool/Framework/Metadata/Tool.php

Show:

inherited

Classes
- \Zend_Tool_Framework_Metadata_Tool

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
jump to top

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

 
                ATTRIBUTES_ALL
                = 'attributesAll'

inheritedInherited from: \Zend_Tool_Framework_Metadata_Basic::ATTRIBUTES_ALL

Inherited_from: \Zend_Tool_Framework_Metadata_Basic::ATTRIBUTES_ALL

 
                ATTRIBUTES_NO_PARENT
                = 'attributesParent'

inheritedInherited from: \Zend_Tool_Framework_Metadata_Basic::ATTRIBUTES_NO_PARENT

Inherited_from: \Zend_Tool_Framework_Metadata_Basic::ATTRIBUTES_NO_PARENT

Properties

$_actionName = null

Default valuenullDetails

Type: n/a

$_actionReference = null

Default valuenullDetails

Type: n/a

$_clientName = null

Default valuenullDetails

Type: n/a

$_clientReference = null

Default valuenullDetails

Type: n/a

$_name = null

inheritedInherited from: \Zend_Tool_Framework_Metadata_Basic::$$_name

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Tool_Framework_Metadata_Basic::$$_name

$_providerName = null

Default valuenullDetails

Type: n/a

$_providerReference = null

Default valuenullDetails

Type: n/a

mixed $_reference = null

inherited

Inherited from: \Zend_Tool_Framework_Metadata_Basic::$$_reference

Default valuenullDetails

Type: mixed
Inherited_from: \Zend_Tool_Framework_Metadata_Basic::$$_reference

$_specialtyName = null

Default valuenullDetails

Type: n/a

string $_type = 'Tool'

Default value'Tool'Details

Type: string

$_value = null

inheritedInherited from: \Zend_Tool_Framework_Metadata_Basic::$$_value

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Tool_Framework_Metadata_Basic::$$_value

Methods

__construct(array $options = array()) : void

inherited

Constructor - allows for the setting of options

Inherited from: \Zend_Tool_Framework_Metadata_Basic::__construct()

Parameters

Name	Type	Description
$options	array

__toString() : string

__toString() cast to string

Returns

Type	Description
string

getActionName() : string

getActionName()

Returns

Type	Description
string

getActionReference() : \Zend_Tool_Framework_Action_Interface

getActionReference()

Returns

Type	Description
\Zend_Tool_Framework_Action_Interface

getAttributes(\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

Name	Type	Description
$type	\const
$stringRepresentationOfNonScalars

Returns

Type	Description
array

getClientName() : void

getClientReference() : \Zend_Tool_Framework_Client_Abstract

getClientReference()

Returns

Type	Description
\Zend_Tool_Framework_Client_Abstract

getName() : string

inherited

getName()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getName()

Returns

Type	Description
string

getProviderName() : string

getProviderName()

Returns

Type	Description
string

getProviderReference() : \Zend_Tool_Framework_Provider_Interface

getProviderReference()

Returns

Type	Description
\Zend_Tool_Framework_Provider_Interface

getReference() : mixed

inherited

getReference()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getReference()

Returns

Type	Description
mixed

getSpecialtyName() : string

getSpecialtyName()

Returns

Type	Description
string

getType() : string

inherited

getType()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getType()

The type of metadata this describes

Returns

Type	Description
string

getValue() : mixed

inherited

getValue()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::getValue()

Returns

Type	Description
mixed

setActionName(string $actionName) : \Zend_Tool_Framework_Metadata_Tool

setActionName()

Parameters

Name	Type	Description
$actionName	string

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Tool

setActionReference(\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

setClientName( $clientName) : void

Parameters

Name	Type	Description
$clientName

setClientReference(\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

setName(string $name) : \Zend_Tool_Framework_Metadata_Basic

inherited

setName()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Basic

setOptions(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

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Basic

setProviderName(string $providerName) : \Zend_Tool_Framework_Metadata_Tool

setProviderName()

Parameters

Name	Type	Description
$providerName	string

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Tool

setProviderReference(\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

setReference(mixed $reference) : \Zend_Tool_Framework_Metadata_Basic

inherited

setReference()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setReference()

Parameters

Name	Type	Description
$reference	mixed

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Basic

setSpecialtyName(string $specialtyName) : \Zend_Tool_Framework_Metadata_Tool

setSpecialtyName()

Parameters

Name	Type	Description
$specialtyName	string

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Tool

setType(string $type) : \Zend_Tool_Framework_Metadata_Basic

inherited

setType()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setType()

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Basic

setValue( $value) : \Zend_Tool_Framework_Metadata_Basic

inherited

setValue()

Inherited from: \Zend_Tool_Framework_Metadata_Basic::setValue()

Parameters

Name	Type	Description
$value

Returns

Type	Description
\Zend_Tool_Framework_Metadata_Basic

Tool/Framework/Metadata/Tool.php

\Zend_Tool_Framework_Metadata_Tooljump to top

Constants

Properties

Methods

\Zend_Tool_Framework_Metadata_Tool
jump to top