rollerworks-graveyard · sstok · Sep 26, 2016 · Sep 26, 2016 · Sep 26, 2016 · Sep 26, 2016
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -149,6 +149,12 @@ powerful and developer friendly way to create and register a CompoundColumn.**
   And a minor bug with the `date_format` and `time_format` options was fixed, both now
   only accept an integer and no longer fallback to the default.
 
+* The `ColumnType` and `CompoundColumnType` now define the 'preferred' template blocks.
+  Together with a small addition of other data, like attributes and (label) translator domain.
+
+  Whenever using a Template engine to render the Datagrid the template block-names
+  must be honored. They are stored only in the `HeaderView`.
+
 ### DatagridBuilder
 
 * The `DatagridBuilder` now allows re-usage of the Builder instance.

diff --git a/src/Extension/Core/Type/BaseType.php b/src/Extension/Core/Type/BaseType.php
@@ -0,0 +1,92 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the RollerworksDatagrid package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Component\Datagrid\Extension\Core\Type;
+
+use Rollerworks\Component\Datagrid\Column\AbstractType;
+use Rollerworks\Component\Datagrid\Column\ColumnInterface;
+use Rollerworks\Component\Datagrid\Column\HeaderView;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+use Symfony\Component\PropertyAccess\PropertyPath;
+
+/**
+ * Encapsulates common logic of {@link ColumnType} and {@link ComponendColumnType}.
+ *
+ * This type does not appear in the column's type inheritance chain and as such
+ * cannot be extended (via {@link \Rollerworks\Component\Datagrid\Column\ColumnTypeExtensionInterface}) nor themed.
+ *
+ * @author Sebastiaan Stok <s.stok@rollerscapes.net>
+ */
+abstract class BaseType extends AbstractType
+{
+    public function buildHeaderView(HeaderView $view, ColumnInterface $column, array $options)
+    {
+        $blockName = (string) $options['block_name'];
+
+        if ('' === $blockName) {
+            $blockName = $view->datagrid->name.'_';
+
+            // Child-columns must be prefixed with there parents name to prevent collisions.
+            if (isset($options['parent_column'])) {
+                $blockName .= $options['parent_column']->getName().'_';
+            }
+
+            $blockName .= $column->getName();
+        }
+
+        $uniqueBlockPrefix = '_'.$blockName;
+        $blockPrefixes = [];
+
+        for ($type = $column->getType(); null !== $type; $type = $type->getParent()) {
+            array_unshift($blockPrefixes, $type->getBlockPrefix());
+        }
+
+        $blockPrefixes[] = $uniqueBlockPrefix;
+
+        $view->attributes = array_replace($view->attributes, [
+            'label_attr' => $options['label_attr'],
+            'header_attr' => $options['header_attr'],
+            'cell_attr' => $options['header_attr'],
+            'label_translation_domain' => $options['label_translation_domain'],
+            'unique_block_prefix' => $uniqueBlockPrefix,
+            'block_prefixes' => $blockPrefixes,
+        ]);
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'label' => null,
+            'label_attr' => [],
+            'header_attr' => [],
+            'cell_attr' => [],
+            'label_translation_domain' => null,
+            'block_name' => null,
+        ]);
+
+        $resolver->setDefault('parent_column', null);
+        $resolver->setDefault('data_provider', null);
+
+        $resolver->setAllowedTypes('label', ['string', 'null']);
+        $resolver->setAllowedTypes('label_attr', 'array');
+        $resolver->setAllowedTypes('header_attr', 'array');
+        $resolver->setAllowedTypes('cell_attr', 'array');
+
+        $resolver->setAllowedTypes('data_provider', ['Closure', 'null', 'string', PropertyPath::class]);
+    }
+
+    public function getParent()
+    {
+        // no-op.
+    }
+}
diff --git a/src/Extension/Core/Type/ColumnType.php b/src/Extension/Core/Type/ColumnType.php
@@ -13,10 +13,7 @@
 
 namespace Rollerworks\Component\Datagrid\Extension\Core\Type;
 
-use Rollerworks\Component\Datagrid\Column\CellView;
 use Rollerworks\Component\Datagrid\Column\ColumnInterface;
-use Rollerworks\Component\Datagrid\Column\ColumnTypeInterface;
-use Rollerworks\Component\Datagrid\Column\HeaderView;
 use Rollerworks\Component\Datagrid\Exception\DataProviderException;
 use Rollerworks\Component\Datagrid\Util\StringUtil;
 use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -25,7 +22,7 @@
 use Symfony\Component\PropertyAccess\PropertyAccessor;
 use Symfony\Component\PropertyAccess\PropertyPath;
 
-class ColumnType implements ColumnTypeInterface
+class ColumnType extends BaseType
 {
     /**
      * @var PropertyAccessor
@@ -51,11 +48,10 @@ public function __construct(PropertyAccessor $propertyAccessor = null)
      */
     public function configureOptions(OptionsResolver $resolver)
     {
-        $resolver->setDefaults(['data_provider' => null, 'label' => null]);
-        $resolver->setDefault('parent_column', null);
+        parent::configureOptions($resolver);
 
-        $resolver->setAllowedTypes('label', ['string', 'null']);
-        $resolver->setAllowedTypes('data_provider', ['Closure', 'null', 'string', PropertyPath::class]);
+        $resolver->setDefault('parent_data_provider', null);
+        $resolver->setAllowedTypes('parent_data_provider', ['Closure', 'null']);
     }
 
     /**
@@ -64,9 +60,10 @@ public function configureOptions(OptionsResolver $resolver)
     public function buildColumn(ColumnInterface $column, array $options)
     {
         $dataProvider = $options['data_provider'];
+        $parentDataProvider = $options['parent_data_provider'];
 
         if (!$dataProvider instanceof \Closure) {
-            $dataProvider = function ($data) use ($column, $dataProvider) {
+            $dataProvider = $parentDataProvider ?: function ($data) use ($column, $dataProvider) {
                 static $path;
 
                 if (null === $path) {
@@ -80,27 +77,6 @@ public function buildColumn(ColumnInterface $column, array $options)
         $column->setDataProvider($dataProvider);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function buildCellView(CellView $view, ColumnInterface $column, array $options)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function buildHeaderView(HeaderView $view, ColumnInterface $column, array $options)
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getParent()
-    {
-    }
-
     /**
      * Returns the prefix of the template block name for this type.
      *

diff --git a/src/Extension/Core/Type/CompoundColumnType.php b/src/Extension/Core/Type/CompoundColumnType.php
@@ -13,45 +13,23 @@
 
 namespace Rollerworks\Component\Datagrid\Extension\Core\Type;
 
-use Rollerworks\Component\Datagrid\Column\AbstractType;
 use Rollerworks\Component\Datagrid\Column\CellView;
 use Rollerworks\Component\Datagrid\Column\ColumnInterface;
 use Rollerworks\Component\Datagrid\Column\CompoundColumn;
-use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
  * CompoundColumn allows multiple sub-columns for advanced view building.
  *
  * @author Sebastiaan Stok <s.stok@rollerscapes.net>
  */
-class CompoundColumnType extends AbstractType
+class CompoundColumnType extends BaseType
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function getParent()
-    {
-        return;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function configureOptions(OptionsResolver $resolver)
-    {
-        $resolver->setDefault('label', null);
-        $resolver->setDefault('parent_column', null);
-
-        // Not used but required by the ResolvedColumnType
-        $resolver->setAllowedTypes('label', ['string', 'null']);
-    }
-
     /**
      * {@inheritdoc}
      */
     public function buildColumn(ColumnInterface $column, array $options)
     {
-        // Simple pass all $data to the sub-columns;
+        // Simple pass all $data to the sub-columns.
         $column->setDataProvider(
             function ($data) {
                 return $data;

diff --git a/src/Util/CompoundColumnBuilder.php b/src/Util/CompoundColumnBuilder.php
@@ -24,10 +24,13 @@
  * A CompoundColumn allows to group multiple columns together,
  * eg. one more more date value or one or more row actions.
  *
+ * The 'data_provider' of the CompoundColumn will be set as the 'data_provider'
+ * for each sub-column, unless a sub column sets the 'data_provider' explicitly.
+ *
  * <code>
- * createCompound('actions', ['label' => 'Actions'])
- *   ->add('edit', ActionType::class, ['data_provider' => '[id]', 'url_schema' => '/users/{id}/edit'])
- *   ->add('delete', ActionType::class, ['data_provider' => '[id]', 'url_schema' => '/users/{id}/edit'])
+ * createCompound('actions', ['label' => 'Actions', 'data_provider' => function ($data) {return ['id' => $data->id();}])
+ *   ->add('edit', ActionType::class, ['url_schema' => '/users/{id}/edit'])
+ *   ->add('delete', ActionType::class, ['url_schema' => '/users/{id}/edit'])
  * ->end() // This registers the CompoundColumn at the DatagridBuilder, and return the DatagridBuilder.
  * </code>
  */
@@ -47,6 +50,10 @@ public function __construct(
         array $options = [],
         string $type = null
     ) {
+        if (!isset($options['data_provider'])) {
+            $options['data_provider'] = null;
+        }
+
         $this->factory = $factory;
         $this->builder = $builder;
         $this->name = $name;
@@ -102,6 +109,10 @@ public function end(): DatagridBuilderInterface
         $columns = [];
 
         foreach ($this->unresolvedColumns as $n => $column) {
+            if (!isset($column['options']['data_provider'])) {
+                $column['options']['data_provider'] = $this->options['data_provider'];
+            }
+
             $columns[$n] = $this->factory->createColumn(
                 $n,
                 $column['type'],

diff --git a/tests/DatagridBuilderTest.php b/tests/DatagridBuilderTest.php
@@ -94,7 +94,12 @@ public function it_generates_a_compoundColumn()
 
         $datagrid = $builder->getDatagrid('my_grid');
 
-        self::assertDatagridHasColumn($datagrid, 'actions', CompoundColumnType::class, ['abel' => 'act']);
+        self::assertDatagridHasColumn(
+            $datagrid,
+            'actions',
+            CompoundColumnType::class,
+            ['abel' => 'act', 'data_provider' => null]
+        );
     }
 
     /** @test */

diff --git a/tests/DatagridPerformanceTest.php b/tests/DatagridPerformanceTest.php
@@ -69,15 +69,20 @@ public function testGenerateViewWith100RowsAnd10Columns()
         $datagrid->add('group', TextType::class);
 
         $datagrid
-            ->createCompound('actions', ['label' => 'Actions'])
+            ->createCompound(
+                    'actions',
+                    [
+                        'label' => 'Actions',
+                        'data_provider' => function ($data) {
+                            return ['id' => $data['id']];
+                        },
+                    ]
+                )
                 ->add(
                     'modify',
                     ActionType::class,
                     [
                         'label' => 'Modify',
-                        'data_provider' => function ($data) {
-                            return ['id' => $data['id']];
-                        },
                         'uri_scheme' => 'entity/{id}/modify',
                     ]
                 )
@@ -150,15 +155,20 @@ public function testGenerateViewWith100RowsAnd10ColumnsAutoDataProvider()
         $datagrid->add('group', TextType::class);
 
         $datagrid
-            ->createCompound('actions', ['label' => 'Actions'])
+            ->createCompound(
+                    'actions',
+                    [
+                        'label' => 'Actions',
+                        'data_provider' => function ($data) {
+                            return ['id' => $data['id']];
+                        },
+                    ]
+                )
                 ->add(
                     'modify',
                     ActionType::class,
                     [
                         'label' => 'Modify',
-                        'data_provider' => function ($data) {
-                            return ['id' => $data['id']];
-                        },
                         'uri_scheme' => 'entity/{id}/modify',
                     ]
                 )