Introduction

Welcome to Flextrine

Flextrine is an ORM (object relational mapper) for Flex that provides transparent persistence for Actionscript 3 objects. The server side component of Flextrine uses PHP 5.3+ and is built upon Doctrine 2. Doctrine itself uses its own database abstraction layer (DBAL) so Flextrine is not tied to a particular database.

Requirements

Flextrine works with Flex 3 and Flex 4 on the client, and requires a mimimum of PHP 5.3 on the server. Note that Flextrine does not work with the Flash IDE (see FAQ for more details).

Flextrine has been developed using the wonderful FlashDevelop, and all Flex code has a FlashDevelop project file packaged along with it. If you want to compile the code using Flex Builder 3 or Flash Builder 4 you need to add the src directory to the project classpath and then include the swc files in the lib directory into the project.

The Flextrine Manager requires mod_rewrite to be enabled on your web server.

Installing

You can install Flextrine via one of the zips on the downloads page or via svn. Svn will always have the most up to date version.

The trunk directory can be found at http://flextrine2.googlecode.com/svn/trunk/

The repository contains three folders:

• flextrine

This is the main Flextrine package. It contains a src folder, which contains the client-side Flex libraries. When coding a Flextrine project in Flex you need to add this folder to your classpath.

It also contains a web folder, which contains a blank server side project which you can use as a base for your own projects (flextrineproject), and the Flextrine server-side PHP libraries (lib).

• manager

The manager is a web interface to manage your Flextrine project. It gives information about the database and entites, and allows you to create, update and drop the schema as well as generate AS3 entity classes from your PHP entities.

• tests

This contains the Flextrine test suite (tests are written using FlexUnit 4). This has a src directory containing the Flex test suites, and a web directory containing the Flextrine server-side component for the tests. To run the tests you need to make the web directory accessible through a URL (by default the test suite expects to find web/testsuite at http://localhost/testsuite).

tests also contains an examples folder, which contains MXML examples demonstrating various features of Flextrine.

You will also need to install Doctrine 2 from http://www.doctrine-project.org/projects/orm/download. You can either install via PEAR or download the package and extract it to somewhere in your PHP include_path.