## Zend_Environment_Field

Description

- license: New BSD License
- copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Environment/Field.php (line 42)

    Zend_Environment_Container_Abstract
       |
       --Zend_Environment_Field

Direct descendents

Class | Description
--- | ---
Zend_Environment_Security_Field |

Class Constant Summary
VERSION_EXACT = '=='
VERSION_MAX = '<='
VERSION_MIN = '>='
Variable Summary
array $_data
Method Summary
void __construct ([array $params = null])
boolean isValid ()
boolean|null isVersion (string $required, [boolean $fail = false], [string $compare = null])
Variables
array $_data = array('name' => null,
'title' => null,
'value' => null,
'version' => null,
'info' => null) (line 56)

Default properties for a field

- access: protected

Redefinition of:

Zend_Environment_Container_Abstract::$_data
  Container for class properties

Redefined in descendants as:

- Zend_Environment_Security_Field::$_data : Default properties for a field

#### Inherited Variables

Inherited from Zend_Environment_Container_Abstract

> Zend_Environment_Container_Abstract::$_ptr

Methods
Constructor __construct (line 68)

An array of default values can be passed to this component

- access: public

void __construct ([array $params = null])

- array $params

isValid (line 84)

Provides base method for checking behaviour of individual fields within a section. Modules such as 'Security' may subclass this to provide more relevant results.

- access: public

boolean isValid ()
isVersion (line 111)

Returns the result of a comparison with a section module and a version number

Provides a wrapper of the version_compare php native function, but will allow full-string comparisons against verbose module names. By default will return true if the module version number is equal or greater than the version number provided to this function.

If the fail parameter is set to true, an exception will be thrown for failed comparisons

A compare constant can be used to provide matching for minimum versions (VERSION_MIN), maximum versions (VERSION_MAX) and identical matches (VERSION_EXACT).

- access: public
- throws: Zend_Environment_Exception

boolean|null isVersion (string $required, [boolean $fail = false], [string $compare = null])

- string $required
- boolean $fail
- string $compare

#### Inherited Methods

Inherited From Zend_Environment_Container_Abstract

> Zend_Environment_Container_Abstract::asArray()
> Zend_Environment_Container_Abstract::count()
> Zend_Environment_Container_Abstract::current()
> Zend_Environment_Container_Abstract::key()
> Zend_Environment_Container_Abstract::next()
> Zend_Environment_Container_Abstract::rewind()
> Zend_Environment_Container_Abstract::valid()
> Zend_Environment_Container_Abstract::__get()
> Zend_Environment_Container_Abstract::__isset()
> Zend_Environment_Container_Abstract::__set()

Class Constants
VERSION_EXACT = '==' (line 49)
VERSION_MAX = '<=' (line 48)
VERSION_MIN = '>=' (line 47)

Constants to map to version_compare

Documentation generated on Wed, 21 Feb 2007 12:02:29 -0800 by phpDocumentor 1.3.1