API Documentation

Tool/Framework/Metadata/Basic.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
subpackage
Framework
version
$Id: Basic.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Tool_Framework_Metadata_Basic

Description

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.

Zend_Tool_Framework_Metadata_Basic

Implements
Zend_Tool_Framework_Metadata_Interface
Zend_Tool_Framework_Metadata_Attributable
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
Constants
ATTRIBUTES_ALL
ATTRIBUTES_NO_PARENT
Properties
$_type
$_name
$_value
$_reference
Methods
__construct
setOptions
getType
setType
getName
setName
getValue
setValue
setReference
getReference
getAttributes
__toString

Description

Constants

ATTRIBUTES_ALL

 ATTRIBUTES_ALL = 'attributesAll'

Details

value
attributesAll

ATTRIBUTES_NO_PARENT

 ATTRIBUTES_NO_PARENT = 'attributesParent'

Details

value
attributesParent

Properties

$_name

 $_name = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_reference

mixed $_reference = 'null'

Details

$_reference
mixed
visibility
protected
default
null
final
false
static
false

$_type

 $_type = 'Basic'

Details

visibility
protected
default
Basic
final
false
static
false

$_value

 $_value = 'null'

Details

visibility
protected
default
null
final
false
static
false

Methods

__construct

__construct( array $options = array ) :

Constructor - allows for the setting of options

Arguments
$options
array
Details
visibility
public
final
false
static
false

__toString

__toString( ) : string

__toString() - string representation of this object

Output
string
Details
visibility
public
final
false
static
false

getAttributes

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

Arguments
$type
const
$stringRepresentationOfNonScalars
Output
array
Details
visibility
public
final
false
static
false

getName

getName( ) : string

getName()

Output
string
Details
visibility
public
final
false
static
false

getReference

getReference( ) : mixed

getReference()

Output
mixed
Details
visibility
public
final
false
static
false

getType

getType( ) : string

getType()

Output
string
Details
visibility
public
final
false
static
false

getValue

getValue( ) : mixed

getValue()

Output
mixed
Details
visibility
public
final
false
static
false

setName

setName( string $name ) : Zend_Tool_Framework_Metadata_Basic

setName()

Arguments
$name
string
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options ) : Zend_Tool_Framework_Metadata_Basic

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

Arguments
$options
array
Details
visibility
public
final
false
static
false

setReference

setReference( mixed $reference ) : Zend_Tool_Framework_Metadata_Basic

setReference()

Arguments
$reference
mixed
Details
visibility
public
final
false
static
false

setType

setType( string $type ) : Zend_Tool_Framework_Metadata_Basic

setType()

Arguments
$type
string
Details
visibility
public
final
false
static
false

setValue

setValue(  $value ) : Zend_Tool_Framework_Metadata_Basic

setValue()

Arguments
$value
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.