Prototyped named types

ezsystems · Feb 18, 2020 · e28f815 · e28f815
1 parent e30726e
commit e28f815
Show file tree

Hide file tree

Showing 10 changed files with 594 additions and 1 deletion.
diff --git a/doc/research/named_field_types.md b/doc/research/named_field_types.md
@@ -10,7 +10,7 @@ ezplatform:
     children:
       query_type: eZ:Children
       default_parameters:
-        location: '@=location'
+        location: '@=mainLocation'
         type: '@=returnedType'
     relating_content:
       query_type: eZ:ContentRelatedTo

diff --git a/src/Symfony/DependencyInjection/EzSystemsEzPlatformQueryFieldTypeExtension.php b/src/Symfony/DependencyInjection/EzSystemsEzPlatformQueryFieldTypeExtension.php
@@ -6,8 +6,12 @@
  */
 namespace EzSystems\EzPlatformQueryFieldType\Symfony\DependencyInjection;
 
+use EzSystems\EzPlatformQueryFieldType\eZ\FieldType\NamedQuery;
+use EzSystems\EzPlatformQueryFieldType\eZ\Persistence\Legacy\Content\FieldValue\Converter\QueryConverter;
 use Symfony\Component\Config\Resource\FileResource;
+use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\Config\FileLocator;
@@ -27,6 +31,7 @@ public function load(array $configs, ContainerBuilder $container)
         $loader->load('services.yml');
 
         $this->addContentViewConfig($container);
+        $this->handleNamedTypes($container);
     }
 
     public function prepend(ContainerBuilder $container)
@@ -100,4 +105,51 @@ protected function prependFieldTemplateConfig(ContainerBuilder $container): void
         $container->prependExtensionConfig('ezpublish', $config);
         $container->addResource(new FileResource($configFile));
     }
+
+    private function handleNamedTypes(ContainerBuilder $container)
+    {
+        if (!$container->hasParameter('ezcontentquery_named')) {
+            return;
+        }
+
+        foreach ($container->getParameter('ezcontentquery_named') as $name => $config) {
+            // @todo validate name syntax
+            $fieldTypeIdentifier = 'ezcontentquery_' . $name;
+
+            $this->defineFieldTypeService($container, $fieldTypeIdentifier, $config);
+            $this->tagFieldTypeConverter($container, $fieldTypeIdentifier);
+            $this->tagFieldTypeFormMapper($container, $config, $fieldTypeIdentifier);
+        }
+    }
+
+    private function defineFieldTypeService(ContainerBuilder $container, string $fieldTypeIdentifier, array $config)
+    {
+        $serviceId = NamedQuery\Type::class . '\\' . $fieldTypeIdentifier;
+
+        $definition = new ChildDefinition('ezpublish.fieldType');
+        $definition->setClass(NamedQuery\Type::class);
+        $definition->setAutowired(true);
+        $definition->setPublic(true);
+        $definition->addTag('ezpublish.fieldType', ['alias' => $fieldTypeIdentifier]);
+        $definition->setArgument('$identifier', $fieldTypeIdentifier);
+        $definition->setArgument('$config', $config);
+        $container->setDefinition($serviceId, $definition);
+    }
+
+    private function tagFieldTypeConverter(ContainerBuilder $container, string $fieldTypeIdentifier)
+    {
+        $container->getDefinition(QueryConverter::class)->addTag(
+            'ezpublish.storageEngine.legacy.converter',
+            ['alias' => $fieldTypeIdentifier]
+        );
+    }
+
+    private function tagFieldTypeFormMapper(ContainerBuilder $container, array $config, string $fieldTypeIdentifier)
+    {
+        $definition = new Definition(NamedQuery\Mapper::class);
+        $definition->addTag('ez.fieldFormMapper.definition', ['fieldType' => $fieldTypeIdentifier]);
+        $definition->setAutowired(true);
+        $definition->setArgument('$queryType', $config['query_type']);
+        $container->setDefinition(NamedQuery\Mapper::class . '\\' . $fieldTypeIdentifier, $definition);
+    }
 }
diff --git a/src/Symfony/Resources/config/default_parameters.yml b/src/Symfony/Resources/config/default_parameters.yml
@@ -2,3 +2,14 @@ parameters:
     ezcontentquery_field_view: 'content_query_field'
     ezcontentquery_item_view: 'line'
     ezcontentquery_identifier: 'ezcontentquery'
+    ezcontentquery_named:
+        children:
+            query_type: eZ:Children
+            default_parameters:
+                location: 'mainLocation'
+                type: 'returnedType'
+        relating:
+            query_type: AppBundle:RelatedToContent
+            default_parameters:
+                to_content: 'content'
+                type: 'returnedType'
diff --git a/src/Symfony/Resources/config/services/ezplatform.yml b/src/Symfony/Resources/config/services/ezplatform.yml
@@ -43,3 +43,8 @@ services:
             $views: { field: '%ezcontentquery_field_view%', item: '%ezcontentquery_item_view%' }
         tags:
             - { name: kernel.event_subscriber }
+
+    EzSystems\EzPlatformQueryFieldType\eZ\Twig\QueryFieldBlockRenderer:
+        decorates: ezpublish.templating.field_block_renderer.twig
+        arguments:
+            $innerRenderer: '@EzSystems\EzPlatformQueryFieldType\eZ\Twig\QueryFieldBlockRenderer.inner'
diff --git a/src/Symfony/Resources/views/fieldtype/fielddefinition_edit.html.twig b/src/Symfony/Resources/views/fieldtype/fielddefinition_edit.html.twig
@@ -31,3 +31,17 @@
         {{- form_widget(form.Parameters) -}}
     </div>
 {% endblock %}
+
+{% block ezcontentquery_named_field_definition_edit %}
+    <div class="query-returned-type{% if group_class is not empty %} {{ group_class }}{% endif %}">
+        {{- form_label(form.ReturnedType) -}}
+        {{- form_errors(form.ReturnedType) -}}
+        {{- form_widget(form.ReturnedType) -}}
+    </div>
+
+    <div class="query-parameters{% if group_class is not empty %} {{ group_class }}{% endif %}">
+        {{- form_label(form.Parameters) -}}
+        {{- form_errors(form.Parameters) -}}
+        {{- form_widget(form.Parameters) -}}
+    </div>
+{% endblock %}
diff --git a/src/Symfony/Resources/views/fieldtype/fielddefinition_settings.html.html.twig b/src/Symfony/Resources/views/fieldtype/fielddefinition_settings.html.html.twig
@@ -21,3 +21,6 @@
         {{ block( 'settings_defaultvalue' ) }}
     </ul>
 {% endblock %}
+
+{% block ezcontentquery_named_settings %}
+{% endblock %}
diff --git a/src/eZ/FieldType/NamedQuery/Mapper.php b/src/eZ/FieldType/NamedQuery/Mapper.php
@@ -0,0 +1,81 @@
+<?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\EzPlatformQueryFieldType\eZ\FieldType\NamedQuery;
+
+use eZ\Publish\API\Repository\ContentTypeService;
+use eZ\Publish\Core\QueryType\QueryTypeRegistry;
+use EzSystems\EzPlatformQueryFieldType\eZ\FieldType\Mapper\ParametersTransformer;
+use EzSystems\RepositoryForms\Data\FieldDefinitionData;
+use EzSystems\RepositoryForms\FieldType\FieldDefinitionFormMapperInterface;
+use Symfony\Component\Form\Extension\Core\Type;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class Mapper implements FieldDefinitionFormMapperInterface
+{
+    /** @var ContentTypeService */
+    private $contentTypeService;
+    /**
+     * @var string
+     */
+    private $queryType;
+    /**
+     * @var \eZ\Publish\Core\QueryType\QueryTypeRegistry
+     */
+    private $queryTypeRegistry;
+
+    public function __construct(ContentTypeService $contentTypeService, QueryTypeRegistry $queryTypeRegistry, string $queryType)
+    {
+        $this->contentTypeService = $contentTypeService;
+        $this->queryType = $queryType;
+        $this->queryTypeRegistry = $queryTypeRegistry;
+    }
+
+    public function mapFieldDefinitionForm(FormInterface $fieldDefinitionForm, FieldDefinitionData $data)
+    {
+        $parametersForm = $fieldDefinitionForm->getConfig()->getFormFactory()->createBuilder()
+            ->create(
+                'Parameters',
+                Type\TextareaType::class,
+                [
+                    'label' => 'Parameters',
+                    'property_path' => 'fieldSettings[Parameters]',
+                ]
+            )
+            ->addModelTransformer(new ParametersTransformer())
+            ->setAutoInitialize(false)
+            ->getForm();
+
+        $fieldDefinitionForm
+            ->add('ReturnedType', Type\ChoiceType::class,
+                [
+                    'label' => 'Returned type',
+                    'property_path' => 'fieldSettings[ReturnedType]',
+                    'choices' => $this->getContentTypes(),
+                    'required' => true,
+                ]
+            )
+            ->add($parametersForm);
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver
+            ->setDefaults([
+                'translation_domain' => 'ezrepoforms_content_type',
+            ]);
+    }
+
+    private function getContentTypes()
+    {
+        foreach ($this->contentTypeService->loadContentTypeGroups() as $contentTypeGroup) {
+            foreach ($this->contentTypeService->loadContentTypes($contentTypeGroup) as $contentType) {
+                yield $contentType->getName() => $contentType->identifier;
+            }
+        }
+    }
+}