Updated documentation

This commit is contained in:
William DURAND 2011-09-02 16:04:50 +02:00
parent bfc0e24c88
commit ca2f60d6be
3 changed files with 63 additions and 15 deletions

View file

@ -231,17 +231,19 @@ SQL will be write in `app/propel/sql/`.
You can load your own fixtures by using the following command:
> php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--connection[="..."]]
> php app/console propel:load-fixtures [-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.
You can mix --xml parameter and --sql parameter to load XML and SQL fixtures.
If none of this parameter are set all files, XML and SQL, in the directory will be load.
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:
@ -252,6 +254,20 @@ A valid _XML fixtures file_ is:
</dataset>
```
A valid _YAML fixtures file_ is:
``` yaml
\Awesome\Object:
o1:
Title: My title
MyFoo: bar
\Awesome\Related:
r1:
ObjectId: o1
Description: Hello world !
```
### Graphviz

View file

@ -231,17 +231,19 @@ SQL will be write in `app/propel/sql/`.
You can load your own fixtures by using the following command:
> php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--connection[="..."]]
> php app/console propel:load-fixtures [-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.
You can mix --xml parameter and --sql parameter to load XML and SQL fixtures.
If none of this parameter are set all files, XML and SQL, in the directory will be load.
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:
@ -252,6 +254,20 @@ A valid _XML fixtures file_ is:
</dataset>
```
A valid _YAML fixtures file_ is:
``` yaml
\Awesome\Object:
o1:
Title: My title
MyFoo: bar
\Awesome\Related:
r1:
ObjectId: o1
Description: Hello world !
```
### Graphviz

View file

@ -231,17 +231,19 @@ SQL will be write in `app/propel/sql/`.
You can load your own fixtures by using the following command:
> php app/console propel:load-fixtures [-d|--dir[="..."]] [--xml] [--sql] [--connection[="..."]]
> php app/console propel:load-fixtures [-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.
You can mix --xml parameter and --sql parameter to load XML and SQL fixtures.
If none of this parameter are set all files, XML and SQL, in the directory will be load.
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:
@ -252,6 +254,20 @@ A valid _XML fixtures file_ is:
</dataset>
```
A valid _YAML fixtures file_ is:
``` yaml
\Awesome\Object:
o1:
Title: My title
MyFoo: bar
\Awesome\Related:
r1:
ObjectId: o1
Description: Hello world !
```
### Graphviz