add InternalExternalLink form type

Author: bdejacobet

composer.json

@@ -13,6 +13,7 @@
     "php": "^7.1",
     "sonata-project/admin-bundle": "^3.1",
     "sonata-project/doctrine-orm-admin-bundle": "^3.0",
+    "sonata-project/page-bundle": "^3.8",
     "symfony/framework-bundle": "^3.0 || ^4.0"
   },
   "require-dev": {

docs/00-docs.md

@@ -3,3 +3,5 @@
 ## Immutable tabs form type
 
 - [Immutable Tabs Form Type](./10-immutable-tabs-type.md)
+
+- [Internal External Form Type](./20-internal-external-form-type.md)

docs/10-immutable-tabs-type.md

@@ -12,17 +12,17 @@ To get tabs into a block of page or admin form.
 
 It extends the `Sonata\CoreBundle\Form\Type\ImmutableArrayType`
 
-And use a specific widget defined in `src/AdminBundle/Ressources/Views/form_admin_fields.html.twig` so you must add it to your admin sonata config
+And uses a specific widget defined in `src/Ressources/views/Form/form_admin_fields.html.twig` so you must add it to your admin sonata config
 
-```
+```yaml
 sonata_admin:
     admin_services:
-        canalplus.awaken.admin.item:
+        your.admin.entity:
             templates:
-                form: ['CanalPlusAwakenAdminBundle:Form:form_admin_fields.html.twig']
+                form: ['SonataHelperBundle:Form:form_admin_fields.html.twig']
 ```
 
-Don't forget to add the css `src/AdminBundle/Ressources/public/css/immutableTabsType.css` to have cute tabs
+Don't forget to add the css `src/Ressources/public/css/immutableTabsType.css` to have cute tabs
 
 An array of tabs must be set
  key :   key of tab that will be used to record value in database
@@ -32,7 +32,7 @@ This array must be send in the options array with the key 'tabs'
 
 ### Example of page block with an immutableTabsType
 
-```
+```php
 /**
  * Class TitleBlockService.
  */
@@ -98,7 +98,7 @@ data are a json with the key of the immutableTabsType then the key of tabs as su
 
 ### Exemple of data
 
-````
+````json
 {
   "settings": {
     "fr": {

docs/20-internal-external-form-type.md

@@ -0,0 +1,162 @@
+# Internal External Form Type
+
+## For what
+
+Form type to input an link in an admin form
+
+You can choice a type of link :
+- no link
+- link to an external link
+- link to an internal page of your admin. they can be filtered by current site if needed.
+
+![internal-external-link-choices.png](img/internal-external-link-choices.png)
+
+
+For no link, there nothing to do :
+
+![internal-external-link-none.png](img/internal-external-link-none.png)
+
+
+For an external link, only input target url :
+
+![internal-external-link-external.png](img/internal-external-link-external.png)
+
+
+For an internal link, first choose the internal target page among all available pages :
+
+![internal-external-link-internal-choice](img/internal-external-link-internal-choice.png)
+
+Then input parameters if there are some :
+
+![internal-external-link-internal-params](img/internal-external-link-internal-params.png)
+
+When admin form is loaded the link form is collpased but a button allows to open and update it. 
+
+![internal-external-link-external-closed](img/internal-external-link-external-closed.png)
+
+![internal-external-link-internal-closed](img/internal-external-link-internal-closed.png)
+
+
+## How it works
+
+InternalExternalLink form type groups many fields to record each type of values.
+Javascript is used to display form and manage interaction between each field.
+
+A specific Twig block is used to format all fields and add classes that will be used as selector by javascript :
+block `sonata_type_internal_external_link_type_widget` of `src/Ressources/views/Form/form_admin_fields.html.twig`
+
+
+## Installation
+
+You must include css `src/Ressources/public/css/linkWidget.css` to your project
+
+You must call the `src/Ressources/public/js/backoffice.js` to init InternalExternalLink form type if present in current admin
+
+## How to implement an InternalExternalLink form type to your admin
+
+It uses a specific widget defined in `src/Ressources/views/Form/form_admin_fields.html.twig` so you must add it to your admin sonata config
+
+```yaml
+sonata_admin:
+    admin_services:
+        your.admin.entity:
+            templates:
+                form: ['SonataHelperBundle:Form:form_admin_fields.html.twig']
+```
+
+You must inject to your admin the service `sonata.page.manager.page` with method `setPageManager`. It will be passed to InternalExternalLink form types to get internal pages. 
+
+You can add each field of InternalExternalLink form type to your entity to save them in separated properties but it is more easy to encapsulate an 
+InternalExternalLink form type in an ImmutableArrayType form type so all fields will be save in one property of your entity with a json format.
+
+So you must add property and getter/setter to your entity.
+
+```php
+class YourEntity
+{
+    /**
+     * @var string
+     */
+    protected $backLink;
+
+    /**
+     * @return array
+     */
+    public function getLink()
+    {
+        return json_decode($this->link, true);
+    }
+
+    /**
+     * @param array $link This should be an array containing the following keys:
+     *                     - linkType
+     *                     - link
+     *                     - page
+     *                     - params
+     *
+     * @return $this
+     */
+    public function setLink(array $link)
+    {
+        $this->link = json_encode($link);
+
+        return $this;
+    }
+
+    ...
+}    
+```
+
+Then you can use an InternalExternalLink form type to your admin form by example :
+
+```php
+use Sonata\SonataHelpersBundle\Form\DataTransformer\PageDataTransformer;
+use Sonata\SonataHelpersBundle\Manager\PageManagerInterface;
+
+class YourAdmin extends AbstractAdmin
+{
+    /**
+     * @var PageManagerInterface
+     */
+    private $pageManager;
+
+    /**
+     * @param PageManagerInterface $pageManager
+     */
+    public function setPageManager(PageManagerInterface $pageManager)
+    {
+        $this->pageManager = $pageManager;
+    }
+
+    ...
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configureFormFields(FormMapper $formMapper)
+    {
+        $site = $this->getSubject()->getSite(); // To filter page by the site of the current object
+
+        $formMapper
+            ->with('Lien de retour', ['class' => 'col-md-6'])
+                ->add('backLabel', TextType::class, [
+                    'label'    => 'Libellé du lien',
+                    'required' => true,
+                ])
+                ->add('Link', ImmutableArrayType::class, [
+                    'keys' => [
+                        ['link', InternalExternalLinkType::class, ['site' => $site, 'label' => false, 'required' => false]],
+                    ],
+                    'label' => false,
+                ])
+            ->end()
+    }
+
+    ...
+}
+```
+
+
+## Validator
+
+You can check InternalExternalLink form type data with validator `src/Validator/Constraints/InternalExternalLinkValidator.php`.