Skip to content
This repository has been archived by the owner. It is now read-only.


Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Full Stop

I still like the idea but there is currently no use case to develop it anymore.

Entity Instantiator Generator Behavior for Propel

This free as in freedom behavior that easy up entity instantiation for your propel query and object classes.

Thanks to the ExtraPropertiesBehavior to act as such a great template.

The build status of the current master branch is tracked by Travis CI: Build Status Latest stable

The scrutinizer status are: code quality | build status

The versioneye status is: dependencies

Downloads: Downloads this Month

It is available at

If you want to control things in more detail, you should have a look to the locator generator component for php and its propel examples

The current change log can be found here.


  • no new in your code anymore
  • no static Query::create call in your code anymore
  • eases up writing test code (createMyEntity and createMyEntityQuery can be mocked)


  • make sure you have enabled if you want to run phpunit
  • the behavior creates a instantiator class and file
  • the behavior has following parameters
    • entity_instantiator_add_to_entity_instantiator - ("true"|"false") allowed to add or not add this table to the instantiator, default is true
    • entity_instantiator_class_name - (string) that represents the class name, default is DatabaseEntityInstantiator
    • entity_instantiator_extends - (string) that represents the full qualified class name, default is ``
    • entity_instantiator_indention- (string) that represents the indention in the instantiator, default is
    • entity_instantiator_namespace- (string) that represents the namespace in the instantiator, default is `` (no namespace)
    • entity_instantiator_path_to_output- (string) that represents the path (relative to vendor/../) where the instantiator file will be written, default is data
    • entity_instantiator_method_name_prefix- (string) that represents the prefix for each instantiation method in the instantiator, default is create<DatabaseName>
    • entity_instantiator_default_connection_mode - (string) that represents the content of the second optional argument in Propel::getConnection($name, $mode)
    • entity_instantiator_default_connection_name - (string) that represents the content of the first optional argument in Propel::getConnection($name, $mode)
    • entity_instantiator_use_fully_qualified_name - ("true"|"false") allows to switch usage between fully qualified name or class name, default is false


Given a database with following settings

<database name="exampleDatabase">
    <behavior name="add_to_entity_instantiator">
        <parameter name="entity_instantiator_class_name" value="MyEntityInstantiator" />
        <parameter name="entity_instantiator_extends" value="MyAbstractEntityInstantiator" />
        <parameter name="entity_instantiator_indention" value="  " />
        <parameter name="entity_instantiator_namespace" value="Database\Service" />
        <parameter name="entity_instantiator_path_to_output" value="module/Database/src/Database/Service" />
        <parameter name="entity_instantiator_method_name_prefix" value="create" />
        <paramater name="entity_instantiator_default_connection_name" value="exampleDatabase" />
        <paramater name="entity_instantiator_default_connection_mode" value="Propel::CONNECTION_READ" />
        <paramater name="entity_instantiator_use_fully_qualified_name" value="true" />
    <table name="user">
        <column name="id" type="INTEGER" primaryKey="true" autoincrement="true" />
        <column name="name" type="VARCHAR" size="255" />
        <!-- turn it on - default -->
        <behavior name="add_to_entity_instantiator">
            <parameter name="entity_instantiator_add_to_entity_instantiator" value="true" />
    <table name="product">
        <column name="id" type="INTEGER" primaryKey="true" autoincrement="true" />
        <column name="name" type="VARCHAR" size="255" />
        <!-- turn it on -->
        <behavior name="add_to_entity_instantiator">
            <parameter name="entity_instantiator_add_to_entity_instantiator" value="false" />

will create a file called MyEntityInstantiator.php in the path module/Database/src/Database/Service with following content.


namespace Database\Service;

use PDO;
use Propel;

 * Class MyEntityInstantiator
 * @author Net\Bazzline\Propel\Behavior\EntityInstantiatorNet\Bazzline\Propel\Behavior\EntityInstantiator\EntityInstantiatorGenerator
 * @since 2015-08-29
 * @see
class MyEntityInstantiator extends MyAbstractEntityInstantiator
     * @return PDO
    public function getConnection($name = 'exampleDatabase', $mode = \Propel::CONNECTION_WRITE)
        return Propel::getConnection($name, $mode);

     * @return \Database\User
    public function createUser()
        return new \Database\User();

     * @return \Database\UserQuery
    public function createUserQuery()
        return new \Database\UserQuery::create();


By Hand

mkdir -p vendor/net_bazzline/php_propel_behavior_entity_instantiator
cd vendor/net_bazzline/php_propel_behavior_entity_instantiator
git clone

With Packagist

"net_bazzline/php_propel_behavior_entity_instantiator": "dev-master"

Enable Behavior in Propel

  • add the following to your propel.ini
propel.behavior.create_entity_instantiator.class = lib.vendor.net_bazzline.php_propel_behavior_create_entity.source.AddToEntityInstantiatorBehavior


API available at

Final Words

Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it. Donate something if you love it :-].


This free as in freedom behavior that easy up entity instantiation for propel







No packages published