Documentation

This commit is contained in:
Simon Vieille 2016-09-23 11:48:22 +02:00
parent e2a15244ee
commit acb3935103

View file

@ -11,15 +11,15 @@ This a propel behavior to auto-generate methods of [FOSRestBundle](http://symfon
``` ```
<table name="foo"> <table name="foo">
<column name="id" type="INTEGER" primaryKey="true" autoIncrement="true" required="true" /> <column name="id" type="INTEGER" primaryKey="true" autoIncrement="true" required="true" />
<column name="label" type="VARCHAR" size="256"/> <column name="label" type="VARCHAR" size="256"/>
<column name="is_active" type="BOOLEAN" size="1"/> <column name="is_active" type="BOOLEAN" size="1"/>
<behavior name="Deblan\Propel\Behavior\FOSRestBehavior"> <behavior name="Deblan\Propel\Behavior\FOSRestBehavior">
<parameter name="id" value="all"/> <parameter name="id" value="all"/>
<parameter name="label" value="myGroup"/> <parameter name="label" value="myGroup"/>
<parameter name="is_active" value="myGroup, anotherGroup"/> <parameter name="is_active" value="myGroup, anotherGroup"/>
</behavior> </behavior>
</table> </table>
``` ```
@ -33,7 +33,7 @@ After the model generation, the abstract class `Foo` will be updated with new an
*/ */
abstract class Foo implements ActiveRecordInterface abstract class Foo implements ActiveRecordInterface
{ {
... ...
/** /**
* @JMS\Serializer\Annotation\SerializedName("id") * @JMS\Serializer\Annotation\SerializedName("id")
@ -45,7 +45,7 @@ abstract class Foo implements ActiveRecordInterface
return $this->getId(); return $this->getId();
} }
/** /**
* @JMS\Serializer\Annotation\SerializedName("label") * @JMS\Serializer\Annotation\SerializedName("label")
* @JMS\Serializer\Annotation\Groups({"myGroup"}) * @JMS\Serializer\Annotation\Groups({"myGroup"})
* @JMS\Serializer\Annotation\VirtualProperty * @JMS\Serializer\Annotation\VirtualProperty
@ -55,7 +55,7 @@ abstract class Foo implements ActiveRecordInterface
return $this->getLabel(); return $this->getLabel();
} }
/** /**
* @JMS\Serializer\Annotation\SerializedName("is_active") * @JMS\Serializer\Annotation\SerializedName("is_active")
* @JMS\Serializer\Annotation\Groups({"myGroup", "anotherGroup"}) * @JMS\Serializer\Annotation\Groups({"myGroup", "anotherGroup"})
* @JMS\Serializer\Annotation\VirtualProperty * @JMS\Serializer\Annotation\VirtualProperty
@ -65,6 +65,6 @@ abstract class Foo implements ActiveRecordInterface
return $this->getIsActive(); return $this->getIsActive();
} }
... ...
} }
``` ```