Workflow

You can use any text editor to modify your own EZPDO configuration file. Configuration options can be specified in either an XML file or an .ini file. A complete list of options with detailed descriptions can be found here. Most of the options are self-explanatory.

You start with your existing PHP source code or totally from scratch. Once you decide what classes you want to persist, you insert a few lines of comments in the class files with the special @orm tag.

To map complex object relationships, please take a look at how relationships are handled in EZPDO.

If you enable auto_compile in your configuration file, this step is not even needed.

You can explicitly run the EZPDO compiler script on the class files. For example,

  cd /path/to/ezpdo/install
  ./scripts/epc.sh -c path/to/your/config.xml

The special @orm comments you put in the classes give the compiler enough information to generate runtime configuration. Warning and errors are output to the compiler log (which can be specified to either a file or your standard console in your configuration file).

Again, if you enable auto_compile in your configuration file, you can skip this step. Your class will be compiled the first time you persist it.

At runtime, you call the persistence manager to manage objects. Make sure to include the EZPDO runtime before you call the manager,

include_once('/path/to/ezpdo/install/ezpdo_runtime.php');

If your config file (config.xml) is in a different directory, you need to load it explicitly. (This is not needed if your scripts and config file live in the same directory.)

include_once('/path/to/ezpdo/install/ezpdo_runtime.php');
epLoadConfig('/path/to/your/config.xml');

For most of the times, you need only six methods (i.e. create, commit, refresh, delete, deleteAll and find) provided from the manager (as shown in the simple example).