Docs For Class Xyster_Orm_Entity

Description

An field description object

copyright: Copyright (c) 2007-2008 Irrational Logic (http://irrationallogic.net)
license: New BSD License

Located in /Orm/Entity/Field.php (line 24)

Variable Summary

mixed $_default

mixed $_identity

mixed $_length

mixed $_name

mixed $_null

mixed $_original

mixed $_primary

mixed $_primaryPosition

mixed $_type

Zend_Validate $_validator

Method Summary

Xyster_Orm_Entity_Field __construct ( $name, $details)

Xyster_Orm_Entity_Field addValidator ( $validator, [boolean $breakChainOnFailure = false])

boolean getDefault ()

int getLength ()

string getName ()

string getOriginalName ()

int getPrimaryPosition ()

string getType ()

Zend_Validate getValidator ()

boolean isIdentity ()

boolean isNullable ()

boolean isPrimary ()

Variables

mixed $_default (line 30)

access: protected

mixed $_identity (line 34)

access: protected

mixed $_length (line 29)

access: protected

mixed $_name (line 26)

access: protected

mixed $_null (line 31)

access: protected

mixed $_original (line 27)

access: protected

mixed $_primary (line 32)

access: protected

mixed $_primaryPosition (line 33)

access: protected

mixed $_type (line 28)

access: protected

Zend_Validate $_validator (line 39)

access: protected

Methods

Constructor __construct (line 50)

Create a new entity field

The array passed should be in the format returned by the describeTable method of the Zend_Db_Adapter_Abstract class

see: Zend_Db_Adapter_Abstract::describeTable
access: public

Xyster_Orm_Entity_Field __construct ( $name, $details)

array $details
$name

addValidator (line 152)

Adds a validator to this field

return: provides a fluent interface
access: public

Xyster_Orm_Entity_Field addValidator ( $validator, [boolean $breakChainOnFailure = false])

Zend_Validate_Interface $validator
boolean $breakChainOnFailure

getDefault (line 113)

Gets the default value for the field

access: public

boolean getDefault ()

getLength (line 95)

Gets the length of the field

access: public

int getLength ()

getName (line 68)

Gets the name of the field

access: public

string getName ()

getOriginalName (line 77)

Gets the original name

access: public

string getOriginalName ()

getPrimaryPosition (line 131)

Gets the index of this field in the primary key

access: public

int getPrimaryPosition ()

getType (line 86)

Gets the native type of the field

access: public

string getType ()

getValidator (line 167)

Gets the validator for this field

access: public

Zend_Validate getValidator ()

isIdentity (line 140)

Gets whether the field uses an autonumbering scheme

access: public

boolean isIdentity ()

isNullable (line 104)

Gets whether the field can have a null value

access: public

boolean isNullable ()

isPrimary (line 122)

Gets whether the field is part of a primary key

access: public

boolean isPrimary ()

Class Xyster_Orm_Entity_Field