Docs For Class Xyster_Orm

Description

The entity/mapper/collection class loader for the Orm layer

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

Located in /Orm/Loader.php (line 28)

Variable Summary

static array $_paths

Method Summary

static void addPath (string $path)

static string loadClass (string $className)

static void loadEntityClass (string $className)

static string loadMapperClass (string $className)

static string loadSetClass (string $className, [boolean $autoSuffix = true])

Variables

static array $_paths = array() (line 35)

Paths where entities, mappers, and sets are stored

Methods

static method addPath (line 42)

Adds a path to where class files for entities can be found

static void addPath (string $path)

static method loadClass (line 64)

Tries to load the class in one of the paths defined for entities

return: the class name loaded
throws: Xyster_Orm_Exception if the class file cannot be loaded
throws: Xyster_Orm_Exception if the file is found but no class with the name given is defined
access: public

static string loadClass (string $className)

static method loadEntityClass (line 95)

Loads the class and makes sure it's a Xyster_Orm_Entity

throws: Xyster_Orm_Exception if the class loaded is not a derivitive of Xyster_Orm_Entity
access: public

static void loadEntityClass (string $className)

static method loadMapperClass (line 116)

Loads the mapper class for the entity class given

To load the 'PersonMapper' class, the $className parameter should just be 'Person'.

return: the class name
throws: Xyster_Orm_Exception if the class loaded is not a derivitive of Xyster_Orm_Mapper_Interface
access: public

static string loadMapperClass (string $className)

static method loadSetClass (line 141)

Loads the set class for the entity class given

return: the class name
throws: Xyster_Orm_Exception if the class loaded is not a derivitive of Xyster_Orm_Set
access: public

static string loadSetClass (string $className, [boolean $autoSuffix = true])

Class Xyster_Orm_Loader