EZP-27631: Implement editing support for Author FieldType

ezsystems · Sep 8, 2017 · cf0f328 · cf0f328
1 parent ea812cd
commit cf0f328
Show file tree

Hide file tree

Showing 7 changed files with 329 additions and 0 deletions.
diff --git a/bundle/Resources/config/services.yml b/bundle/Resources/config/services.yml
@@ -16,6 +16,7 @@ parameters:
 
     ezrepoforms.field_value.user_type.class: EzSystems\RepositoryForms\Form\Type\User\UserAccountType
 
+    ezrepoforms.field_type.form_mapper.ezauthor.class: EzSystems\RepositoryForms\FieldType\Mapper\AuthorFormMapper
     ezrepoforms.field_type.form_mapper.ezbinaryfile.class: EzSystems\RepositoryForms\FieldType\Mapper\BinaryFileFormMapper
     ezrepoforms.field_type.form_mapper.ezboolean.class: EzSystems\RepositoryForms\FieldType\Mapper\CheckboxFormMapper
     ezrepoforms.field_type.form_mapper.ezcountry.class: EzSystems\RepositoryForms\FieldType\Mapper\CountryFormMapper
@@ -126,6 +127,12 @@ services:
             - { name: form.type, alias: ezuser }
 
     # FieldType form mappers
+    ezrepoforms.field_type.form_mapper.ezauthor:
+        class: "%ezrepoforms.field_type.form_mapper.ezauthor.class%"
+        tags:
+            - { name: ez.fieldFormMapper.definition, fieldType: ezauthor }
+            - { name: ez.fieldFormMapper.value, fieldType: ezauthor }
+
     ezrepoforms.field_type.form_mapper.ezbinaryfile:
         class: "%ezrepoforms.field_type.form_mapper.ezbinaryfile.class%"
         tags:

diff --git a/bundle/Resources/views/Content/form_fields.html.twig b/bundle/Resources/views/Content/form_fields.html.twig
@@ -114,3 +114,40 @@
     {%- set type = type|default('number') -%}
     {{ parent() }}
 {%- endblock number_widget -%}
+
+{# ezauthor #}
+
+{%- block ezrepoforms_fieldtype_ezauthor_row -%}
+    {{ block('form_row') }}
+    {% if form.authors.vars.prototype is defined %}
+        <template class="author-template">
+            {{ form_row(form.authors.vars.prototype) }}
+        </template>
+    {% endif %}
+{%- endblock ezrepoforms_fieldtype_ezauthor_row -%}
+
+{%- block ezrepoforms_fieldtype_ezauthor_widget -%}
+    {{ block('form_rows') }}
+{%- endblock ezrepoforms_fieldtype_ezauthor_widget -%}
+
+{%- block ezrepoforms_fieldtype_ezauthor_authors_row -%}
+    {{- form_widget(form) -}}
+{%- endblock ezrepoforms_fieldtype_ezauthor_authors_row -%}
+
+{%- block ezrepoforms_fieldtype_ezauthor_authors_widget -%}
+    {{ block('form_rows') }}
+{%- endblock ezrepoforms_fieldtype_ezauthor_authors_widget -%}
+
+{%- block ezrepoforms_fieldtype_ezauthor_authors_entry_row -%}
+    {{- block('ezrepoforms_fieldtype_ezauthor_authors_entry_widget') -}}
+{%- endblock ezrepoforms_fieldtype_ezauthor_authors_entry_row -%}
+
+{%- block ezrepoforms_fieldtype_ezauthor_authors_entry_widget -%}
+    <fieldset>
+        {{- block('form_rows') -}}
+        <div class="ez-author-tools">
+            <button type="button" class="ez-button ez-button-secondary ez-js-remove-author">{{ 'Remove'|trans }}</button>
+            <button type="button" class="ez-button ez-button-secondary ez-js-add-author">{{ 'Add'|trans }}</button>
+        </div>
+    </fieldset>
+{%- endblock ezrepoforms_fieldtype_ezauthor_authors_entry_widget -%}
diff --git a/lib/FieldType/DataTransformer/AuthorValueTransformer.php b/lib/FieldType/DataTransformer/AuthorValueTransformer.php
@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * This file is part of the eZ RepositoryForms package.
+ *
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ * @version //autogentag//
+ */
+namespace EzSystems\RepositoryForms\FieldType\DataTransformer;
+
+use eZ\Publish\Core\FieldType\Author\Author;
+use eZ\Publish\Core\FieldType\Author\Value;
+use Symfony\Component\Form\DataTransformerInterface;
+
+/**
+ * DataTransformer for Author\Value.
+ */
+class AuthorValueTransformer implements DataTransformerInterface
+{
+    public function transform($value)
+    {
+        if (is_array($value)) {
+            return $value;
+        }
+
+        if (!$value instanceof Value || $value->authors->count() == 0) {
+            return [[]];
+        }
+
+        $authors = [];
+        foreach ($value->authors as $author) {
+            $authors[] = [
+                'id' => $author->id,
+                'name' => $author->name,
+                'email' => $author->email,
+            ];
+        }
+
+        return $authors;
+    }
+
+    public function reverseTransform($value)
+    {
+        if ($value === null || !is_array($value)) {
+            return null;
+        }
+
+        $authors = [];
+        foreach ($value as $authorProperties) {
+            $authors[] = new Author($authorProperties);
+        }
+
+        return new Value($authors);
+    }
+}
diff --git a/lib/FieldType/Mapper/AuthorFormMapper.php b/lib/FieldType/Mapper/AuthorFormMapper.php
@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * This file is part of the eZ RepositoryForms package.
+ *
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace EzSystems\RepositoryForms\FieldType\Mapper;
+
+use EzSystems\RepositoryForms\Data\Content\FieldData;
+use EzSystems\RepositoryForms\FieldType\FieldValueFormMapperInterface;
+use EzSystems\RepositoryForms\Form\Type\FieldValue\AuthorsType;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * FormMapper for ezauthor FieldType.
+ */
+class AuthorFormMapper implements FieldValueFormMapperInterface
+{
+    /**
+     * @param FormInterface $fieldForm
+     * @param FieldData $data
+     */
+    public function mapFieldValueForm(FormInterface $fieldForm, FieldData $data)
+    {
+        $fieldDefinition = $data->fieldDefinition;
+        $formConfig = $fieldForm->getConfig();
+
+        $fieldForm
+            ->add(
+                $formConfig->getFormFactory()->createBuilder()
+                    ->create('value', AuthorsType::class, [
+                        'required' => $fieldDefinition->isRequired,
+                        'label' => $fieldDefinition->getName($formConfig->getOption('languageCode')),
+                    ])
+                    ->setAutoInitialize(false)
+                    ->getForm()
+            );
+    }
+
+    /**
+     * Fake method to set the translation domain for the extractor.
+     *
+     * @param OptionsResolver $resolver
+     */
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver
+            ->setDefaults([
+                'translation_domain' => 'ezrepoforms_content_type',
+            ]);
+    }
+}
diff --git a/lib/Form/Type/FieldValue/Author/AuthorCollectionType.php b/lib/Form/Type/FieldValue/Author/AuthorCollectionType.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace EzSystems\RepositoryForms\Form\Type\FieldValue\Author;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\CollectionType;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Combined Type for ezauthor.
+ */
+class AuthorCollectionType extends AbstractType
+{
+    public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    public function getBlockPrefix()
+    {
+        return 'ezrepoforms_fieldtype_ezauthor_authors';
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefaults([
+            'allow_add' => true,
+            'allow_delete' => true,
+            'entry_type' => AuthorEntryType::class,
+            'prototype' => true,
+            'prototype_name' => '__index__',
+        ]);
+    }
+
+    public function getParent()
+    {
+        return CollectionType::class;
+    }
+}
diff --git a/lib/Form/Type/FieldValue/Author/AuthorEntryType.php b/lib/Form/Type/FieldValue/Author/AuthorEntryType.php
@@ -0,0 +1,75 @@
+<?php
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace EzSystems\RepositoryForms\Form\Type\FieldValue\Author;
+
+use eZ\Publish\Core\FieldType\Author\Author;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\EmailType;
+use Symfony\Component\Form\Extension\Core\Type\HiddenType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Combined entry type for ezauthor.
+ */
+class AuthorEntryType extends AbstractType
+{
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * @return string
+     */
+    public function getBlockPrefix()
+    {
+        return 'ezrepoforms_fieldtype_ezauthor_authors_entry';
+    }
+
+    /**
+     * @param FormBuilderInterface $builder
+     * @param array $options
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add(
+                'id',
+                HiddenType::class,
+                [
+                    'label' => 'content.field_type.ezauthor.id',
+                ]
+            )
+            ->add(
+                'name',
+                TextType::class,
+                [
+                    'label' => 'content.field_type.ezauthor.name',
+                    'required' => $options['required'],
+                ]
+            )
+            ->add(
+                'email',
+                EmailType::class,
+                [
+                    'label' => 'content.field_type.ezauthor.email',
+                    'required' => $options['required'],
+                ]
+            );
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefault('data_class', Author::class);
+    }
+}
diff --git a/lib/Form/Type/FieldValue/AuthorsType.php b/lib/Form/Type/FieldValue/AuthorsType.php
@@ -0,0 +1,55 @@
+<?php
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace EzSystems\RepositoryForms\Form\Type\FieldValue;
+
+use eZ\Publish\Core\FieldType\Author\Author;
+use eZ\Publish\Core\FieldType\Author\Value;
+use EzSystems\RepositoryForms\Form\Type\FieldValue\Author\AuthorCollectionType;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * Combined Type for ezauthor.
+ */
+class AuthorsType extends AbstractType
+{
+    public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    public function getBlockPrefix()
+    {
+        return 'ezrepoforms_fieldtype_ezauthor';
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('authors', AuthorCollectionType::class, [])
+            ->addEventListener(FormEvents::PRE_SET_DATA, [$this, 'addEmptyEntry']);
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver->setDefault('data_class', Value::class);
+    }
+
+    public function addEmptyEntry(FormEvent $event)
+    {
+        $data = $event->getData();
+        $contentStruct = $event->getForm()->getRoot()->getData();
+
+        if ($contentStruct->isNew()) {
+            $data->authors->offsetSet(0, new Author(['id' => null, 'name' => null, 'email' => null]));
+        }
+    }
+}