Tool/Framework/Metadata/Basic.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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Tool  
Subpackage
Framework  
Version
$Id$  

\Zend_Tool_Framework_Metadata_Basic

Package: Zend_Tool
Implements
Children
\Zend_Tool_Framework_Metadata_Tool
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

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

Properties

>VPropertyprotected$_name = null
Default valuenullDetails
Type
n/a
>VPropertyprotectedmixed $_reference = null
Default valuenullDetails
Type
mixed
>VPropertyprotected$_type = 'Basic'
Default value'Basic'Details
Type
n/a
>VPropertyprotected$_value = null
Default valuenullDetails
Type
n/a

Methods

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

Constructor - allows for the setting of options

Parameters
NameTypeDescription
$optionsarray
methodpublic__toString() : string

__toString() - string representation of this object

Returns
TypeDescription
string
methodpublicgetAttributes(\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.

Parameters
NameTypeDescription
$type\const
$stringRepresentationOfNonScalars
Returns
TypeDescription
array
methodpublicgetName() : string

getName()

Returns
TypeDescription
string
methodpublicgetReference() : mixed

getReference()

Returns
TypeDescription
mixed
methodpublicgetType() : string

getType()

Returns
TypeDescription
string
methodpublicgetValue() : mixed

getValue()

Returns
TypeDescription
mixed
methodpublicsetName(string $name) : \Zend_Tool_Framework_Metadata_Basic

setName()

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\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.

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetReference(mixed $reference) : \Zend_Tool_Framework_Metadata_Basic

setReference()

Parameters
NameTypeDescription
$referencemixed
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetType(string $type) : \Zend_Tool_Framework_Metadata_Basic

setType()

Parameters
NameTypeDescription
$typestring
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetValue( $value) : \Zend_Tool_Framework_Metadata_Basic

setValue()

Parameters
NameTypeDescription
$value
Returns
TypeDescription
\Zend_Tool_Framework_Metadata_Basic
Documentation was generated by phpDocumentor 2.2.0 .