propel-map
[ class tree: propel-map ] [ index: propel-map ] [ all elements ]

Class: MapBuilder

Source Location: /map/MapBuilder.php

Interface Overview


MapBuilders are classes that construct a model of a database at runtime.


Author(s):

Version:

  • $Revision: 521 $

Methods



Class Details

[line 52]
MapBuilders are classes that construct a model of a database at runtime.

MapBuilders support a single database, so this class essentially serves as a wrapper around the DatabaseMap class. This interface can be used for any class that needs to construct a runtime database model; by default in Propel the MapBuilder.tpl generates a class for your datamodel that implements this interface and re-creates your database using the DatabaseMap, TableMap, ColumnMap, and ValidatorMap classes.

GENERAL NOTE ------------ The propel.map classes are abstract building-block classes for modeling the database at runtime. These classes are similar (a lite version) to the propel.engine.database.model classes, which are build-time modeling classes. These classes in themselves do not do any database metadata lookups, but instead are used by the MapBuilder classes that were generated for your datamodel. The MapBuilder that was created for your datamodel build a representation of your database by creating instances of the DatabaseMap, TableMap, ColumnMap, etc. classes. See propel/templates/om/php5/MapBuilder.tpl and the classes generated by that template for your datamodel to further understand how these are put together.




Tags:

author:  Hans Lellelid <hans@xmpl.org> (Propel)
author:  John D. McNally <jmcnally@collab.net> (Torque)
author:  Hans Lellelid <hans@xmpl.org> (Torque)
version:  $Revision: 521 $


[ Top ]


Class Methods


method doBuild [line 59]

void doBuild( )

Build up the database mapping.



Tags:

throws:  Exception Couldn't build mapping.


[ Top ]

method getDatabaseMap [line 74]

DatabaseMap getDatabaseMap( )

Gets the database mapping this map builder built.



Tags:

return:  A DatabaseMap.


[ Top ]

method isBuilt [line 67]

boolean isBuilt( )

Tells us if the database mapping is built so that we can avoid re-building it repeatedly.



Tags:

return:  Whether the DatabaseMap is built.


[ Top ]


Documentation generated on Thu, 22 Nov 2007 03:33:43 +0000 by phpDocumentor 1.4.0