| .. | ||
| README.markdown | ||
PropelBundle
This is the official implementation of Propel in Symfony2.
Installation
-
Clone this bundle in the
vendor/bundles/Propeldirectory:git submodule add https://github.com/propelorm/PropelBundle.git vendor/bundles/Propel/PropelBundle
-
Checkout Propel and Phing in the
vendordirectory:svn checkout http://svn.github.com/propelorm/Propel.git vendor/propel
svn checkout http://svn.phing.info/tags/2.4.6/ vendor/phing
-
Instead of using svn, you can clone the unofficial Git repositories:
git submodule add https://github.com/phingofficial/phing.git vendor/phing
git submodule add https://github.com/propelorm/Propel.git vendor/propel
-
Instead of doing this manually, you can use the Symfony vendor management via the deps file:
See http://www.propelorm.org/cookbook/symfony2/working-with-symfony2.html#via_symfony2_vendor_management
If you are using a Symfony2 2.x.x version (actually, a version which is not 2.1 or above), be sure to deps.lock the PropelBundle to a commit on the 2.0 branch, which does not use the Bridge
-
Register this bundle in the
AppKernelclass:
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:
$loader->registerNamespaces(array(
...
'Propel' => __DIR__.'/../vendor/bundles',
));
Sample Configuration
Project configuration
# 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
# slaves:
# slave_server_1:
# user: root
# password: null
# dsn: mysql:host=localhost;dbname=test_slave_1
#
# 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 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).
# 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:
# 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 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:sql:insert command:
> php app/console propel:sql:insert [--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[="..."]] [bundle]
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:
<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:
\Awesome\Object:
o1:
Title: My title
MyFoo: bar
\Awesome\Related:
r1:
ObjectId: o1
Description: Hello world !
You can load all fixtures files from a given bundle:
> php app/console propel:fixtures:load @MySuperBundle
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.
Table
You can drop one or several table:
> php app/console propel:table:drop [--force] [--connection[="..."]] [table1] ... [tableN]
As usual, --connection allows to specify a connection.
The table arguments define which table will be delete, by default all table.
Note that the --force option is needed to actually execute the deletion.
Form Types
You can generate stub classes based on your schema.xml in a given bundle:
> php app/console propel:form:generate [-f|--force] bundle [models1] ... [modelsN]
It will write Form Type classes in src/YourVendor/YourBundle/Form/Type.
You can choose which Form Type to build by specifing Model names:
> php app/console propel:form:generate @MySuperBundle Book Author
PropelParamConverter
You can use the Propel ParamConverter with the SensioFrameworkExtraBundle. You just need to put the right Annotation on top of your controller:
<?php
/**
* @ParamConverter("post", class="BlogBundle\Model\Post")
*/
public function myAction(Post $post)
{
}
Your request needs to have an id parameter or any field as parameter (slug, title, ...).
The Annotation is optional if your parameter is typed you could only have this:
<?php
public function myAction(Post $post)
{
}
Exclude some parameters:
You can exclude some attributes from being used by the converter:
If you have a route like /my-route/{slug}/{name}/edit/{id}
you can exclude name and slug by setting the option "exclude":
<?php
/**
* @ParamConverter("post", class="BlogBundle\Model\Post", options={"exclude"={"name", "slug"}})
*/
public function myAction(Post $post)
{
}
UniqueObjectValidator
In a form, if you want to validate the unicity of a field in a table you have to use the UniqueObjectValidator. The only way to use it is in a validation.yml file, like this:
BundleNamespace\Model\User:
constraints:
- Propel\PropelBundle\Validator\Constraints\UniqueObject: username
For validate the unicity of more than just one fields:
BundleNamespace\Model\User:
constraints:
- Propel\PropelBundle\Validator\Constraints\UniqueObject: [username, login]
As many validator of this type as you want can be used.
Bundle Inheritance
The PropelBundle makes use of the bundle inheritance.
Currently only schema inheritance is provided.
Schema Inheritance
You can override the defined schema of a bundle from within its child bundle.
To make use of the inheritance you only need to drop a schema file in the Resources/config folder of the child bundle.
Each file can be overridden without interfering with other schema files. If you want to remove parts of a schema, you only need to add an empty schema file.
ACL implementation
The PropelBundle provides a model-based implementation of the Security components' interfaces.
To make us of this AuditableAclProvider you only need to change your security configuration.
security:
acl:
provider: propel.security.acl.provider
This will switch the provider to be the AuditableAclProvider of the PropelBundle.
The auditing of this provider is set to a sensible default. It will audit all ACL failures but no success by default. If you also want to audit successful authorizations, you need to update the auditing of the given ACL accordingly.
After adding the provider, you only need to run the propel:init:acl command in order to get the model generated.
If you already got an ACL database, the schema of the PropelBundle is compatible with the default schema of Symfony2.
Separate database connection for ACL
In case you want to use a different database for your ACL than your business model, you only need to configure this service.
services:
propel.security.acl.connection:
class: PropelPDO
factory_class: Propel
factory_method: getConnection
arguments:
- "acl"
The PropelBundle looks for this service, and if given uses the provided connection for all ACL related operations.
The given argument (acl in the example) is the name of the connection to use, as defined in your runtime configuration.