deblan/propel-bundle
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated documentation

Browse source
This commit is contained in:
William DURAND 2011-09-14 22:35:51 +02:00
parent e25feaf441
commit ed131b2b36
2 changed files with 19 additions and 296 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

299
README.markdown
View file

@ -1,7 +1,7 @@
Propel Bundle
=============
PropelBundle
============
This is the implementation of Propel in Symfony2.
This is the official implementation of [Propel](http://www.propelorm.org/) in Symfony2.
Currently supports:
@ -9,297 +9,18 @@ Currently supports:
* Insertion of SQL statements.
* Runtime autoloading of Propel and generated classes.
* Propel runtime initialization through the XML configuration.
* Migrations [Propel 1.6](http://www.propelorm.org/wiki/Documentation/1.6/Migrations).
* Migrations [Propel 1.6](http://www.propelorm.org/documentation/10-migrations.html).
* Reverse engineering from [existing database](http://www.propelorm.org/wiki/Documentation/1.6/Existing-Database).
* Integration to the Symfony2 Profiler.
* Load SQL, YAML and XML fixtures.
* Create/Drop databases.
* Dump data into YAML fixtures.
* Integration with the Form component.
* Integration with the Security component.
Installation
------------
For documentation, see:
* Clone this bundle in the `vendor/bundles/Propel` directory:
Resources/doc
> git submodule add https://github.com/propelorm/PropelBundle.git vendor/bundles/Propel/PropelBundle
For license, see:
* Checkout Propel and Phing in the `vendor` directory:
> svn checkout http://svn.github.com/propelorm/Propel.git vendor/propel
> svn checkout http://phing.mirror.svn.symfony-project.com/tags/2.3.3 vendor/phing
* Instead of using svn, you can clone the unofficial Git repositories:
> git submodule add https://github.com/Xosofox/phing.git vendor/phing
> git submodule add https://github.com/propelorm/Propel.git vendor/propel
* Register this bundle in the `AppKernel` class:
``` php
public function registerBundles()
{
$bundles = array(
...
// PropelBundle
new Propel\PropelBundle\PropelBundle(),
// register your bundles
new Sensio\HelloBundle\HelloBundle(),
);
...
}
```
* Don't forget to register the PropelBundle namespace in `app/autoload.php`:
``` php
$loader->registerNamespaces(array(
...
'Propel' => __DIR__.'/../vendor/bundles',
));
```
Sample Configuration
--------------------
### Project configuration
``` yaml
# in app/config/config.yml
propel:
path: "%kernel.root_dir%/../vendor/propel"
phing_path: "%kernel.root_dir%/../vendor/phing"
# logging: %kernel.debug%
# build_properties:
# xxxxx.xxxxx: xxxxxx
# xxxxx.xxxxx: xxxxxx
# in app/config/config*.yml
propel:
dbal:
driver: mysql
user: root
password: null
dsn: mysql:host=localhost;dbname=test;charset=UTF8
options: {}
attributes: {}
# default_connection: default
# connections:
# default:
# driver: mysql
# user: root
# password: null
# dsn: mysql:host=localhost;dbname=test
# options:
# ATTR_PERSISTENT: false
# attributes:
# ATTR_EMULATE_PREPARES: true
# settings:
# charset: { value: UTF8 }
# queries: { query: 'INSERT INTO BAR ('hey', 'there')' }
```
`options`, `attributes` and `settings` are parts of the runtime configuration. See [Runtime Configuration File](http://propelorm.github.com/propel-docs/reference/runtime-configuration.html) documentation for more explanation.
### Build properties
You can define _build properties_ by creating a `propel.ini` file in `app/config` and put build properties (see [Build properties Reference](http://www.propelorm.org/wiki/Documentation/1.6/BuildConfiguration)).
# in app/config/propel.ini
xxxx.xxxx.xxxx = XXXX
But you can follow the Symfony2 way by adding build properties in `app/config/config.yml`:
``` yaml
# in app/config/config.yml
propel:
build_properties:
xxxxx.xxxx.xxxxx: XXXX
xxxxx.xxxx.xxxxx: XXXX
...
```
### Sample Schema
Place the following schema in `src/Sensio/HelloBundle/Resources/config/schema.xml` :
``` xml
<?xml version="1.0" encoding="UTF-8"?>
<database name="default" namespace="Sensio\HelloBundle\Model" defaultIdMethod="native">
<table name="book">
<column name="id" type="integer" required="true" primaryKey="true" autoIncrement="true" />
<column name="title" type="varchar" primaryString="1" size="100" />
<column name="ISBN" type="varchar" size="20" />
<column name="author_id" type="integer" />
<foreign-key foreignTable="author">
<reference local="author_id" foreign="id" />
</foreign-key>
</table>
<table name="author">
<column name="id" type="integer" required="true" primaryKey="true" autoIncrement="true" />
<column name="first_name" type="varchar" size="100" />
<column name="last_name" type="varchar" size="100" />
</table>
</database>
```
Commands
--------
### Build Process
Call the application console with the `propel:build` command:
> php app/console propel:build [--classes] [--sql] [--insert-sql]
### Insert SQL
Call the application console with the `propel:insert-sql` command:
> php app/console propel:insert-sql [--force]
Note that the `--force` option is needed to actually execute the SQL statements.
### Use The Model Classes
Use the Model classes as any other class in Symfony2. Just use the correct namespace, and Symfony2 will autoload them:
class HelloController extends Controller
{
public function indexAction($name)
{
$author = new \Sensio\HelloBundle\Model\Author();
$author->setFirstName($name);
$author->save();
return $this->render('HelloBundle:Hello:index.html.twig', array('name' => $name, 'author' => $author));
}
}
### Migrations
Generates SQL diff between the XML schemas and the current database structure:
> php app/console propel:migration:generate-diff
Executes the migrations:
> php app/console propel:migration:migrate
Executes the next migration up:
> php app/console propel:migration:migrate --up
Executes the previous migration down:
> php app/console propel:migration:migrate --down
Lists the migrations yet to be executed:
> php app/console propel:migration:status
### Working with existing databases
Run the following command to generate an XML schema from your `default` database:
> php app/console propel:reverse
You can define which connection to use:
> php app/console propel:reverse --connection=default
### Fixtures
You can load your own fixtures by using the following command:
> php app/console propel:fixtures:load [-d|--dir[="..."]] [--xml] [--sql] [--yml] [--connection[="..."]]
As usual, `--connection` allows to specify a connection.
The `--dir` option allows to specify a directory containing the fixtures (default is: `app/propel/fixtures/`).
Note that the `--dir` expects a relative path from the root dir (which is `app/`).
The `--xml` parameter allows you to load only XML fixtures.
The `--sql` parameter allows you to load only SQL fixtures.
The `--yml` parameter allows you to load only YAML fixtures.
You can mix `--xml`, `--yml` and `--sql` parameters to load XML, YAML and SQL fixtures.
If none of this parameter are set all files YAML, XML and SQL in the directory will be load.
A valid _XML fixtures file_ is:
``` xml
<Fixtures>
<Object Namespace="Awesome">
<o1 Title="My title" MyFoo="bar" />
</Object>
<Related Namespace="Awesome">
<r1 ObjectId="o1" Description="Hello world !" />
</Related>
</Fixtures>
```
A valid _YAML fixtures file_ is:
``` yaml
\Awesome\Object:
o1:
Title: My title
MyFoo: bar
\Awesome\Related:
r1:
ObjectId: o1
Description: Hello world !
```
You can dump data into YAML fixtures file by using this command:
> php app/console propel:fixtures:dump [--connection[="..."]]
Dumped files will be written in the fixtures directory: `app/propel/fixtures/` with the following name: `fixtures_99999.yml` where `99999`
is a timestamp.
Once done, you will be able to load this files by using the `propel:fixtures:load` command.
### Graphviz
You can generate **Graphviz** file for your project by using the following command line:
> php app/console propel:graphviz
It will write files in `app/propel/graph/`.
### Database
You can create a **database**:
> php app/console propel:database:create [--connection[=""]]
As usual, `--connection` allows to specify a connection.
You can drop a **database**:
> php app/console propel:database:drop [--connection[=""]] [--force]
As usual, `--connection` allows to specify a connection.
Note that the `--force` option is needed to actually execute the SQL statements.
Resources/meta/LICENSE

16
Resources/doc/README.markdown
View file

@ -1,7 +1,7 @@
Propel Bundle
=============
PropelBundle
============
This is the implementation of Propel in Symfony2.
This is the official implementation of [Propel](http://www.propelorm.org/) in Symfony2.
Currently supports:
@ -9,12 +9,14 @@ Currently supports:
* Insertion of SQL statements.
* Runtime autoloading of Propel and generated classes.
* Propel runtime initialization through the XML configuration.
* Migrations [Propel 1.6](http://www.propelorm.org/wiki/Documentation/1.6/Migrations).
* Migrations [Propel 1.6](http://www.propelorm.org/documentation/10-migrations.html).
* Reverse engineering from [existing database](http://www.propelorm.org/wiki/Documentation/1.6/Existing-Database).
* Integration to the Symfony2 Profiler.
* Load SQL, YAML and XML fixtures.
* Create/Drop databases.
* Dump data into YAML fixtures.
* Integration with the Form component.
* Integration with the Security component.
Installation
------------
@ -104,12 +106,12 @@ propel:
# queries: { query: 'INSERT INTO BAR ('hey', 'there')' }
```
`options`, `attributes` and `settings` are parts of the runtime configuration. See [Runtime Configuration File](http://propelorm.github.com/propel-docs/reference/runtime-configuration.html) documentation for more explanation.
`options`, `attributes` and `settings` are parts of the runtime configuration. See [Runtime Configuration File](http://www.propelorm.org/reference/runtime-configuration.html) documentation for more explanation.
### Build properties
You can define _build properties_ by creating a `propel.ini` file in `app/config` and put build properties (see [Build properties Reference](http://www.propelorm.org/wiki/Documentation/1.6/BuildConfiguration)).
You can define _build properties_ by creating a `propel.ini` file in `app/config` and put build properties (see [Build properties Reference](http://www.propelorm.org/reference/buildtime-configuration.html)).
# in app/config/propel.ini
xxxx.xxxx.xxxx = XXXX