API Documentation

Zend/Tool/Framework/Metadata/Basic.php

Show: inherited
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: Basic.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tool_Framework_Metadata_Basic

Package: Zend\Tool

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

Constants

Constant  ATTRIBUTES_ALL = 'attributesAll'
Constant  ATTRIBUTES_NO_PARENT = 'attributesParent'

Properties

Propertyprotected  $_name= 'null'
Default valuenullDetails
Type
Propertyprotectedmixed  $_reference= 'null'

Default valuenullDetails
Type
mixed
Propertyprotected  $_type= ''Basic''
Default value'Basic'Details
Type
Propertyprotected  $_value= 'null'
Default valuenullDetails
Type

Methods

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

Constructor - allows for the setting of options

Parameters
Name Type Description
$options array
methodpublic__toString( ) : string

__toString() - string representation of this object

Returns
Type Description
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
Name Type Description
$type \const
$stringRepresentationOfNonScalars
Returns
Type Description
array
methodpublicgetName( ) : string

getName()

Returns
Type Description
string
methodpublicgetReference( ) : mixed

getReference()

Returns
Type Description
mixed
methodpublicgetType( ) : string

getType()

Returns
Type Description
string
methodpublicgetValue( ) : mixed

getValue()

Returns
Type Description
mixed
methodpublicsetName( string $name ) : \Zend_Tool_Framework_Metadata_Basic

setName()

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.

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetReference( mixed $reference ) : \Zend_Tool_Framework_Metadata_Basic

setReference()

Parameters
Name Type Description
$reference mixed
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetType( string $type ) : \Zend_Tool_Framework_Metadata_Basic

setType()

Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
methodpublicsetValue(  $value ) : \Zend_Tool_Framework_Metadata_Basic

setValue()

Parameters
Name Type Description
$value
Returns
Type Description
\Zend_Tool_Framework_Metadata_Basic
Documentation was generated by DocBlox 0.15.1.