Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-14 22:34:24 +00:00
Code Issues Actions Projects Releases Wiki Activity

CustomFields/CustomFieldInterface.php : Improving the doc

Browse Source
This commit is contained in:
Marc Ducobu 2015-12-08 11:42:38 +01:00
parent ebfb24a3eb
commit 373edab629
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CustomFields/CustomFieldInterface.php
View File

@ -13,6 +13,8 @@ interface CustomFieldInterface
{ {
/** /**
* Return a form type to edit the custom field. This form is shown to the
* user.
* *
* @param \Chill\CustomFieldsBundle\CustomField\FormBuilderInterface $builder * @param \Chill\CustomFieldsBundle\CustomField\FormBuilderInterface $builder
* @param \Chill\CustomFieldsBundle\CustomField\CustomField $customField * @param \Chill\CustomFieldsBundle\CustomField\CustomField $customField
@ -21,7 +23,7 @@ interface CustomFieldInterface
public function buildForm(FormBuilderInterface $builder, CustomField $customField); public function buildForm(FormBuilderInterface $builder, CustomField $customField);
/** /**
* transform the value into a format that can be stored in DB * Transform the value into a format that can be stored in DB
* *
* @param mixed $value * @param mixed $value
* @param \Chill\CustomFieldsBundle\CustomField\CustomField $customField * @param \Chill\CustomFieldsBundle\CustomField\CustomField $customField
@ -38,6 +40,7 @@ interface CustomFieldInterface
public function deserialize($serialized, CustomField $customField); public function deserialize($serialized, CustomField $customField);
/** /**
* Return a repsentation of the value of the CustomField.
* *
* @param mixed $value the raw value, **not deserialized** (= as stored in the db) * @param mixed $value the raw value, **not deserialized** (= as stored in the db)
* @param \Chill\CustomFieldsBundle\CustomField\CustomField $customField * @param \Chill\CustomFieldsBundle\CustomField\CustomField $customField
@ -48,7 +51,7 @@ interface CustomFieldInterface
public function getName(); public function getName();
/** /**
* return a formType which allow to edit option for the custom type. * Return a formType which allow to edit option for the custom type.
* This FormType is shown in admin * This FormType is shown in admin
* *
* @param \Chill\CustomFieldsBundle\CustomField\FormBuilderInterface $builder * @param \Chill\CustomFieldsBundle\CustomField\FormBuilderInterface $builder