From 373edab629595e6f5edcf4f2bf111fe1be2174d8 Mon Sep 17 00:00:00 2001 From: Marc Ducobu Date: Tue, 8 Dec 2015 11:42:38 +0100 Subject: [PATCH] CustomFields/CustomFieldInterface.php : Improving the doc --- CustomFields/CustomFieldInterface.php | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CustomFields/CustomFieldInterface.php b/CustomFields/CustomFieldInterface.php index 149e5500b..994172e41 100644 --- a/CustomFields/CustomFieldInterface.php +++ b/CustomFields/CustomFieldInterface.php @@ -13,7 +13,9 @@ 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\CustomField $customField * @return \Symfony\Component\Form\FormTypeInterface the form type @@ -21,7 +23,7 @@ interface CustomFieldInterface 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 \Chill\CustomFieldsBundle\CustomField\CustomField $customField @@ -38,6 +40,7 @@ interface CustomFieldInterface 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 \Chill\CustomFieldsBundle\CustomField\CustomField $customField @@ -48,7 +51,7 @@ interface CustomFieldInterface 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 * * @param \Chill\CustomFieldsBundle\CustomField\FormBuilderInterface $builder