Merge tag '2.1.8' into master

This is a bigfix release. This release has: - Use the max results per page for limit options, if the options all is selected #361 - No use the `tl_limit` as value for reset the limit of the models in the list #505 - Fixed callbacks handle http exceptions as plain exceptions #524 - Hotix colorpicker see Issue #544 - Hotfix getFilterOptions cut the table name - Do not add saveNcreate if "nc" parameter given. - Do not add saveNclose if "nb" parameter given - Is hidden input field, by the widget instead of the property - update readme - Fix if the label of the widget is empty, so not generate the help text for the widget #531 - Add the listener if the mcw is installed #527 - Do not set background color of search input field if empty string #506 - Fix default data provider get filter options #539 - If input provider call has parameter mark keep unused #510 - Not manipulate the toggle command from the legacy callback listener #521 - Filter the model property fields provided by the data provider when they are stored in the database
contao-community-alliance · Aug 27, 2020 · 89a5ef8 · 89a5ef8
2 parents ba6b920 + 38d150e
commit 89a5ef8
Show file tree

Hide file tree

Showing 11 changed files with 105 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -3,13 +3,30 @@
 [![Latest Version on Packagist](http://img.shields.io/packagist/v/contao-community-alliance/dc-general.svg)](https://packagist.org/packages/contao-community-alliance/dc-general)
 [![Installations via composer per month](http://img.shields.io/packagist/dm/contao-community-alliance/dc-general.svg)](https://packagist.org/packages/contao-community-alliance/dc-general)
 
+
 DC_General
 ==========
 
-Universal data container for Contao.
+The DC_General is a universal data container for Contao and is an alternative
+for the DC_Table of the Contao framework.
+
+With the DC_General we facilitate programming with excellent functions and
+influence possibilities.
+
+
+Different to Contao DC_Table
+============================
+
+With the use of the DC_General there are many advantages, e.g.
+
+* Object-oriented data container definitions
+* Event driven
+* abstraction of the data source
+* modular design
+* verification of data - no invalid records
+* improved configuration of dependencies between data containers
+* more control through events
 
-We hope that ultimatively this driver will become the de facto standard
-driver for Contao extensions in the future, once proven to be stable enough.
 
 How to use
 ==========
@@ -26,3 +43,15 @@ There are some notable changes in compatibility considering DC_Table:
 3. The system is totally event driven and relevant information (like the model
    in scope) is attached to the events.
 
+
+Help for the start
+==================
+
+You can start with our new [documentation](https://dc-general.readthedocs.io/de/latest/index.html)
+(currently in german) or [older one](http://contao-community-alliance.github.io/dc-general-docs/) (in english). 
+
+We have an overview of [DCA mapping](https://dc-general.readthedocs.io/de/latest/reference/dca_mapping.html)
+and [Callbacks](https://dc-general.readthedocs.io/de/latest/reference/callbacks.html).
+
+In our [examples](https://github.com/contao-community-alliance/dc-general-example)
+you can see the difference to DC_Table.
diff --git a/src/Contao/Callback/Callbacks.php b/src/Contao/Callback/Callbacks.php
@@ -21,6 +21,7 @@
 
 namespace ContaoCommunityAlliance\DcGeneral\Contao\Callback;
 
+use Contao\CoreBundle\Exception\ResponseException;
 use Contao\System;
 use ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException;
 use Symfony\Component\DependencyInjection\Container;
@@ -63,6 +64,7 @@ public static function call($callback, $_ = null)
      *
      * @return mixed
      *
+     * @throws ResponseException         Throw the response exception.
      * @throws DcGeneralRuntimeException When the callback throws an exception.
      */
     public static function callArgs($callback, array $args = [])
@@ -71,6 +73,8 @@ public static function callArgs($callback, array $args = [])
             $callback = static::evaluateCallback($callback);
 
             return \call_user_func_array($callback, $args);
+        } catch (ResponseException $e) {
+            throw $e;
         } catch (\Exception $e) {
             $message = $e->getMessage();
         }

diff --git a/src/Contao/Callback/ModelOperationButtonCallbackListener.php b/src/Contao/Callback/ModelOperationButtonCallbackListener.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2019 Contao Community Alliance.
+ * (c) 2013-2020 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -15,7 +15,7 @@
  * @author     Tristan Lins <tristan.lins@bit3.de>
  * @author     David Molineus <mail@netzmacht.de>
  * @author     Sven Baumann <baumann.sv@gmail.com>
- * @copyright  2013-2019 Contao Community Alliance.
+ * @copyright  2013-2020 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -24,6 +24,7 @@
 
 use ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent;
 use ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface;
+use ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ToggleCommandInterface;
 
 /**
  * Class ModelOperationButtonCallbackListener.
@@ -62,6 +63,10 @@ public function setRestrictions($dataContainerName = null, $operationName = null
      */
     public function wantToExecute($event)
     {
+        if ($event->getCommand() instanceof ToggleCommandInterface) {
+            return false;
+        }
+
         return parent::wantToExecute($event)
         && (empty($this->operationName)
             || ($this->operationName === $event->getKey())
@@ -109,7 +114,6 @@ public function update($event, $value)
             return;
         }
 
-        $event->setHtml($value);
         $event->stopPropagation();
     }
 

diff --git a/src/Contao/InputProvider.php b/src/Contao/InputProvider.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2019 Contao Community Alliance.
+ * (c) 2013-2020 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -15,7 +15,7 @@
  * @author     Tristan Lins <tristan.lins@bit3.de>
  * @author     Stefan Heimes <stefan_heimes@hotmail.com>
  * @author     Sven Baumann <baumann.sv@gmail.com>
- * @copyright  2013-2019 Contao Community Alliance.
+ * @copyright  2013-2020 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -68,7 +68,7 @@ public function unsetParameter($key)
      */
     public function hasParameter($key)
     {
-        return (null !== Input::get($key));
+        return (null !== Input::get($key, false, true));
     }
 
     /**

diff --git a/src/Contao/View/Contao2BackendView/ContaoWidgetManager.php b/src/Contao/View/Contao2BackendView/ContaoWidgetManager.php
@@ -327,7 +327,7 @@ protected function generateHelpText($property)
         $label      = $propInfo->getDescription();
         $widgetType = $propInfo->getWidgetType();
 
-        if (null === $label
+        if (empty($label)
             || ('password' === $widgetType)
             || !\is_string($label)
             || !$GLOBALS['TL_CONFIG']['showHelp']
@@ -361,9 +361,8 @@ public function renderWidget($property, $ignoreErrors = false, PropertyValueBag
         $this->widgetAddError($property, $widget, $inputValues, $ignoreErrors);
 
         $propInfo = $this->getEnvironment()->getDataDefinition()->getPropertiesDefinition()->getProperty($property);
-        $extra    = (array) $propInfo->getExtra();
 
-        $isHideInput = (isset($extra['isHideInput']) ?? $extra['isHideInput']);
+        $isHideInput = (bool) $widget->hideInput;
 
         $hiddenFields = ($isHideInput) ? $this->buildHiddenFields($widget->value, $widget->name) : null;
 

diff --git a/src/Contao/View/Contao2BackendView/EditMask.php b/src/Contao/View/Contao2BackendView/EditMask.php
@@ -347,21 +347,24 @@ protected function getEditButtons()
         );
         $buttons['save'] = $buttonTemplate->parse();
 
-        $buttonTemplate->setData(
-            [
-                'label'      => $this->getButtonLabel('saveNclose'),
-                'attributes' => [
-                    'type'      => 'submit',
-                    'name'      => 'saveNclose',
-                    'id'        => 'saveNclose',
-                    'class'     => 'tl_submit',
-                    'accesskey' => 'c'
+        if (!$this->getEnvironment()->getInputProvider()->getParameter('nb')) {
+            $buttonTemplate->setData(
+                [
+                    'label'      => $this->getButtonLabel('saveNclose'),
+                    'attributes' => [
+                        'type'      => 'submit',
+                        'name'      => 'saveNclose',
+                        'id'        => 'saveNclose',
+                        'class'     => 'tl_submit',
+                        'accesskey' => 'c'
+                    ]
                 ]
-            ]
-        );
-        $buttons['saveNclose'] = $buttonTemplate->parse();
+            );
+            $buttons['saveNclose'] = $buttonTemplate->parse();
+        }
 
-        if (!$this->isPopup() && $basicDefinition->isCreatable()) {
+        if ($basicDefinition->isCreatable()
+            && !$this->getEnvironment()->getInputProvider()->getParameter('nc')) {
             $buttonTemplate->setData(
                 [
                     'label'      => $this->getButtonLabel('saveNcreate'),

diff --git a/src/Contao/View/Contao2BackendView/Subscriber/MultipleHandlerSubscriber.php b/src/Contao/View/Contao2BackendView/Subscriber/MultipleHandlerSubscriber.php
@@ -67,14 +67,19 @@ public function __construct(RequestScopeDeterminator $scopeDeterminator)
      */
     public static function getSubscribedEvents()
     {
-        return [
+        $listeners = [
             DcGeneralEvents::ACTION => [
                 ['prepareGlobalAllButton', 9999],
                 ['deactivateGlobalButton', 9999]
             ],
-            GetOptionsEvent::NAME   => ['handleOriginalOptions', 9999],
             BuildWidgetEvent::NAME  => ['handleOriginalWidget', 9999]
         ];
+
+        if (\class_exists(GetOptionsEvent::class)) {
+            $listeners[GetOptionsEvent::NAME] = ['handleOriginalOptions', 9999];
+        }
+
+        return $listeners;
     }
 
     /**

diff --git a/src/Data/DefaultDataProvider.php b/src/Data/DefaultDataProvider.php
@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2019 Contao Community Alliance.
+ * (c) 2013-2020 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -23,7 +23,7 @@
  * @author     Sven Baumann <baumann.sv@gmail.com>
  * @author     Ingolf Steinhardt <info@e-spin.de>
  * @author     Richard Henkenjohann <richardhenkenjohann@googlemail.com>
- * @copyright  2013-2019 Contao Community Alliance.
+ * @copyright  2013-2020 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -405,11 +405,10 @@ public function getFilterOptions(ConfigInterface $config)
     {
         $internalConfig = $this->prefixDataProviderProperties($config);
         $properties     = $internalConfig->getFields();
-        $property       = $properties[0];
-
         if (1 !== \count($properties)) {
             throw new DcGeneralRuntimeException('objConfig must contain exactly one property to be retrieved.');
         }
+        $property = $properties[0];
 
         $queryBuilder = $this->connection->createQueryBuilder();
         $queryBuilder->select('DISTINCT(' . $property . ')');
@@ -420,9 +419,14 @@ public function getFilterOptions(ConfigInterface $config)
 
         $values = $statement->fetchAll(\PDO::FETCH_OBJ);
 
+        $filterPropertyName = $property;
+        // Remove the data provider name from the filter property name, if exist.
+        if (0 === \strpos($filterPropertyName, $this->source . '.')) {
+            $filterPropertyName = \substr($filterPropertyName, \strlen($this->source . '.'));
+        }
         $collection = new DefaultFilterOptionCollection();
         foreach ($values as $value) {
-            $collection->add($value->$property, $value->$property);
+            $collection->add($value->$filterPropertyName, $value->$filterPropertyName);
         }
 
         return $collection;
@@ -588,11 +592,11 @@ private function fieldPrefixer(array &$fields)
      *
      * @SuppressWarnings(PHPMD.Superglobals)
      */
-    private function convertModelToDataPropertyArray(ModelInterface $model, $timestamp = 0)
+    private function convertModelToDataPropertyArray(ModelInterface $model, int $timestamp)
     {
         $data = [];
         foreach ($model as $key => $value) {
-            if ($key === $this->idProperty) {
+            if (($key === $this->idProperty) || !$this->fieldExists($key)) {
                 continue;
             }
 

diff --git a/src/Panel/DefaultLimitElement.php b/src/Panel/DefaultLimitElement.php
@@ -63,6 +63,16 @@ protected function getItemsPerPage()
         return Config::get('resultsPerPage');
     }
 
+    /**
+     * Retrieve the amount of max items to display per page.
+     *
+     * @return int
+     */
+    protected function getMaxItemsPerPage()
+    {
+        return Config::get('maxResultsPerPage');
+    }
+
     /**
      * Calculate the total amount of items.
      *
@@ -199,14 +209,22 @@ public function render(ViewTemplateInterface $viewTemplate)
     {
         $options = [
             [
-                'value'      => 'tl_limit',
+                'value'      => '0,' . $this->getItemsPerPage(),
                 'attributes' => '',
                 'content'    => $GLOBALS['TL_LANG']['MSC']['filterRecords']
             ]
         ];
 
-        $optionsPerPage = $this->getItemsPerPage();
-        $optionsTotal   = \ceil($this->intTotal / $optionsPerPage);
+        switch ($this->getInputProvider()->getValue('tl_limit')) {
+            case 'all':
+                $optionsPerPage = ($this->intTotal >= $this->getMaxItemsPerPage())
+                    ? $this->getMaxItemsPerPage() : $this->getItemsPerPage();
+                break;
+
+            default:
+                $optionsPerPage = $this->getItemsPerPage();
+        }
+        $optionsTotal = \ceil($this->intTotal / $optionsPerPage);
 
         for ($i = 0; $i < $optionsTotal; $i++) {
             $first      = ($i * $optionsPerPage);

diff --git a/src/Panel/DefaultSearchElement.php b/src/Panel/DefaultSearchElement.php
@@ -180,7 +180,7 @@ public function render(ViewTemplateInterface $viewTemplate)
                 ];
         }
 
-        $viewTemplate->set('class', 'tl_select' . ((null !== $this->getValue()) ? ' active' : ''));
+        $viewTemplate->set('class', 'tl_select' . (!empty($this->getValue()) ? ' active' : ''));
         $viewTemplate->set('options', $options);
         $viewTemplate->set('value', $this->getValue());
 

diff --git a/src/Resources/config/contao/widget_backend_listeners.yml b/src/Resources/config/contao/widget_backend_listeners.yml
@@ -20,3 +20,4 @@ services:
             -   name: kernel.event_listener
                 event: dc-general.view.contao2backend.build-widget
                 method: handleEvent
+                priority: -256