Class Xyster_Orm_Entity_Lookup_Date

Description
Description | Vars (details) | Methods (details)

Property lookups for date values

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

Located in /Orm/Entity/Lookup/Date.php (line 32) 

Xyster_Orm_Entity_Lookup_Abstract
   |
   --Xyster_Orm_Entity_Lookup_Date
Variable Summary
Description | Vars (details) | Methods (details)
string $_field
mixed $_format
Zend_Locale $_locale
Method Summary
Description | Vars (details) | Methods (details)
Xyster_Orm_Entity_Lookup_Date __construct (Xyster_Orm_Entity_Type $type, string $field, [string $name = null])
mixed get (Xyster_Orm_Entity $entity)
Zend_Locale getLocale ()
Xyster_Type getType ()
void set (Xyster_Orm_Entity $entity, mixed $value)
void setLocale ( $locale)
Variables
Description | Vars (details) | Methods (details)
string $_field (line 38)

The entity date field name to use for the lookup

  • access: protected
mixed $_format = Zend_Date::ISO_8601 (line 44)

The date output format

  • access: protected
Zend_Locale $_locale (line 50)

The current locale

  • access: protected
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 67)

Creates a new date lookup

The default field name for this lookup will be the field name provided appended with 'Date' (ex. 'createdOn' will yield 'createdOnDate'). This field name should not already exist

  • access: public
Xyster_Orm_Entity_Lookup_Date __construct (Xyster_Orm_Entity_Type $type, string $field, [string $name = null])
  • string $field: The name of the field on the entity
  • string $name: Optional. The name of this lookup field
  • Xyster_Orm_Entity_Type $type
Redefinition of:
Xyster_Orm_Entity_Lookup_Abstract::__construct()
Creates a new lookup
get (line 105)

Gets the lookup value for the entity given

  • return: The lookup value or object
  • access: public
mixed get (Xyster_Orm_Entity $entity)
getLocale (line 81)

Gets the assigned locale

  • return: or null if none is specified
  • access: public
Zend_Locale getLocale ()
getType (line 91)

Gets the type of object or value returned by this lookup

  • return: The value type
  • access: public
Xyster_Type getType ()
set (line 125)

Sets any fields affected by changing the value of this lookup

  • throws: Xyster_Orm_Entity_Exception if the value is invalid
  • access: public
void set (Xyster_Orm_Entity $entity, mixed $value)
setLocale (line 141)

Sets the current locale

  • access: public
void setLocale ( $locale)
  • Zend_Locale $locale

Inherited Methods

Inherited From Xyster_Orm_Entity_Lookup_Abstract

Xyster_Orm_Entity_Lookup_Abstract::__construct()
Xyster_Orm_Entity_Lookup_Abstract::getEntityType()
Xyster_Orm_Entity_Lookup_Abstract::getName()
Xyster_Orm_Entity_Lookup_Abstract::_checkEntity()
Xyster_Orm_Entity_Lookup_Abstract::_checkSet()

Documentation generated on Mon, 19 May 2008 17:07:04 -0400 by phpDocumentor 1.4.2