willdurand/propel-typehintable-behavior

Insane Propel behavior that helps you to be compliant with third-party interfaces by adding type hint to generated methods.

TypehintableBehavior

, _(*1)

The TypehintableBehavior behavior allows you to add typehints to generated methods (in Base classes)., _(*2)

Installation

Cherry-pick the TypehintableBehavior.php file is src/, put it somewhere, then add the following line to your propel.ini or build.properties configuration file:, _(*3)

``` ini propel.behavior.typehintable.class = path.to.TypehintableBehavior, <sub>(*4)</sub>

Usage
-----

Just add the following XML tag in your `schema.xml` file:

``` xml
<behavior name="typehintable">
    <parameter name="COLUMN_NAME" value="TYPEHINT" />
    <parameter name="RELATED_TABLE_NAME" value="TYPEHINT" />
</behavior>

If you fill in a column name as parameter's name, the typehint will be added to the corresponding setter methods (setRoles() for instance). If you fill in a related table name as parameter's name, the typehint will be added to the adder/remover methods (addGroup(), removeGroup() for instance)., <sub>(*5)</sub>

You can also specify nullable method signatures (setFoo(Foo $foo = null)):, <sub>(*6)</sub>

``` xml , <sub>(*7)</sub>

Example
-------

``` xml

It will generate the following code in the BaseUser class:, <sub>(*8)</sub>

``` php <?php, <sub>(*9)</sub>

use FOS\UserBundle\Model\GroupInterface;, <sub>(*10)</sub>

// ..., <sub>(*11)</sub>

public function setRoles(array $v) { if ($this->roles_unserialized !== $v) { $this->roles_unserialized = $v; $this->roles = '| ' . implode(' | ', $v) . ' |'; $this->modifiedColumns[] = UserPeer::ROLES; }, <sub>(*12)</sub>

return $this;

}, <sub>(*13)</sub>

public function addGroup(GroupInterface $group) { if ($this->collGroups === null) { $this->initGroups(); } if (!$this->collGroups->contains($group)) { // only add it if the same object is not already associated $this->doAddGroup($group);, <sub>(*14)</sub>

    $this->collGroups[]= $group;
}

} ```, <sub>(*15)</sub>

Credits

William Durand william.durand1@gmail.com, <sub>(*16)</sub>