GridFieldSaveAllButton::handle() - Code Metrics - lekoala/silverstripe-cms-actions - Measure and Improve Code Quality continuously with Scrutinizer

GridFieldSaveAllButton::handle() C
last analyzed 2025-07-17 14:15 UTC

↳ Parent: GridFieldSaveAllButton

Complexity

Conditions	12
Paths	76

Size

Total Lines	59
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	12
eloc	38
c	1
b	0
f	1
nc	76
nop	4
dl	0
loc	59
rs	6.9666

How to fix Long Method Complexity

<?php

namespace LeKoala\CmsActions;

use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
filter:
    dependency_paths: ["lib/*"]
use Symbiote\GridFieldExtensions\GridFieldAddNewInlineButton;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\ORM\DataList;
use Exception;
use SilverStripe\Control\HTTPResponse;

/**
 * When using inline editing on a ModelAdmin, there is no save button
 * This allows saving the records
 * It needs a custom endpoint because somehow, new records are not sent along
 */
class GridFieldSaveAllButton extends GridFieldTableButton
{
    protected $fontIcon = 'save';
    public bool $submitData = true;
    /**
     * @var boolean
     */
    protected $noAjax = false;
    protected ?string $completeMessage = null;
    protected ?bool $useHandleSave = true;
    protected $allowEmptyResponse = true;
    protected bool $shouldReload = false;

    /**
     * @param string $targetFragment
     * @param mixed $buttonLabel
     */
    public function __construct($targetFragment = 'buttons-before-left', $buttonLabel = null)
    {
        parent::__construct($targetFragment, $buttonLabel);
        $this->buttonLabel = $buttonLabel ?? _t('GridFieldSaveAllButton.SaveAll', 'Save all');
    }

    /**
     * @param GridField $gridField
     * @param Controller $controller
     * @param array $arguments
     * @param array $data
     * @return ?HTTPResponse
     */
    public function handle(GridField $gridField, Controller $controller, $arguments = [], $data = [])
    {
        $fieldName = $gridField->getName();
        $list = $gridField->getList();
        $model = $gridField->getModelClass();

        // Without this, handleSave does not work
        $gridField->setSubmittedValue($data[$fieldName]);

        if (!($list instanceof DataList)) {
            throw new Exception("Requires a DataList");
        }

        $updatedData = $data[$fieldName]['GridFieldEditableColumns'] ?? [];
        foreach ($updatedData as $id => $values) {
            $record = $list->byID($id);
            if (!$record) {
                continue;
            }
            // You can use the grid field component or a simple loop with write
            if ($this->useHandleSave) {
                /** @var GridFieldEditableColumns $component */
                $component = $gridField->getConfig()->getComponentByType(GridFieldEditableColumns::class);
                $component->handleSave($gridField, $record);
            } else {
                foreach ($values as $k => $v) {
                    $record->$k = $v;
                }
                $record->write();
            }
        }
        $newData = $data[$fieldName]['GridFieldAddNewInlineButton'] ?? [];
        foreach ($newData as $idx => $values) {
            $record = new $model;
            if ($this->useHandleSave) {
                /** @var GridFieldAddNewInlineButton $component */
                $component = $gridField->getConfig()->getComponentByType(GridFieldAddNewInlineButton::class);
                $component->handleSave($gridField, $record);
            } else {
                foreach ($values as $k => $v) {
                    $record->$k = $v;
                }
            }
            $record->write();
        }

        $response = $controller->getResponse();

        if (Director::is_ajax()) {
            if (!$this->completeMessage) {
                $this->completeMessage = _t('GridFieldSaveAllButton.DONE', 'All saved');
            }
            if ($this->shouldReload) {
                ActionsGridFieldItemRequest::addXReload($controller);
            }
            $response->addHeader('X-Status', rawurlencode($this->completeMessage));
            return null;
        } else {
            return $controller->redirectBack();
        }
    }

    /**
     * Get the value of completeMessage
     */
    public function getCompleteMessage(): string
    {
        return $this->completeMessage;

    }

    /**
     * Set the value of completeMessage
     *
     * @param string $completeMessage
     */
    public function setCompleteMessage($completeMessage): self
    {
        $this->completeMessage = $completeMessage;
        return $this;
    }

    /**
     * Get the value of useHandleSave
     */
    public function getUseHandleSave(): bool
    {
        return $this->useHandleSave;

    }

    /**
     * Set the value of useHandleSave
     *
     * @param bool $useHandleSave
     */
    public function setUseHandleSave($useHandleSave): self
    {
        $this->useHandleSave = $useHandleSave;
        return $this;
    }

    /**
     * Get the value of shouldReload
     */
    public function getShouldReload(): bool
    {
        return $this->shouldReload;
    }

    /**
     * Set the value of shouldReload
     *
     * @param bool $shouldReload
     */
    public function setShouldReload($shouldReload): self
    {
        $this->shouldReload = $shouldReload;
        return $this;
    }
}


1			<?php
2
3			namespace LeKoala\CmsActions;
4
5			use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
			0 ignored issues – show Bug introduced 2024-05-16 09:12 UTC by Report Bug Copy Issue Report The type `Symbiote\GridFieldExtens...ridFieldEditableColumns` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use Symbiote\GridFieldExtensions\GridFieldAddNewInlineButton;
			0 ignored issues – show Bug introduced 2024-05-16 10:15 UTC by Report Bug Copy Issue Report The type `Symbiote\GridFieldExtens...FieldAddNewInlineButton` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
7			use SilverStripe\Control\Controller;
8			use SilverStripe\Control\Director;
9			use SilverStripe\Forms\GridField\GridField;
10			use SilverStripe\ORM\DataList;
11			use Exception;
12			use SilverStripe\Control\HTTPResponse;
13
14			/**
15			* When using inline editing on a ModelAdmin, there is no save button
16			* This allows saving the records
17			* It needs a custom endpoint because somehow, new records are not sent along
18			*/
19			class GridFieldSaveAllButton extends GridFieldTableButton
20			{
21			protected $fontIcon = 'save';
22			public bool $submitData = true;
23			/**
24			* @var boolean
25			*/
26			protected $noAjax = false;
27			protected ?string $completeMessage = null;
28			protected ?bool $useHandleSave = true;
29			protected $allowEmptyResponse = true;
30			protected bool $shouldReload = false;
31
32			/**
33			* @param string $targetFragment
34			* @param mixed $buttonLabel
35			*/
36			public function __construct($targetFragment = 'buttons-before-left', $buttonLabel = null)
37			{
38			parent::__construct($targetFragment, $buttonLabel);
39			$this->buttonLabel = $buttonLabel ?? _t('GridFieldSaveAllButton.SaveAll', 'Save all');
40			}
41
42			/**
43			* @param GridField $gridField
44			* @param Controller $controller
45			* @param array $arguments
46			* @param array $data
47			* @return ?HTTPResponse
48			*/
49			public function handle(GridField $gridField, Controller $controller, $arguments = [], $data = [])
50			{
51			$fieldName = $gridField->getName();
52			$list = $gridField->getList();
53			$model = $gridField->getModelClass();
54
55			// Without this, handleSave does not work
56			$gridField->setSubmittedValue($data[$fieldName]);
57
58			if (!($list instanceof DataList)) {
59			throw new Exception("Requires a DataList");
60			}
61
62			$updatedData = $data[$fieldName]['GridFieldEditableColumns'] ?? [];
63			foreach ($updatedData as $id => $values) {
64			$record = $list->byID($id);
65			if (!$record) {
66			continue;
67			}
68			// You can use the grid field component or a simple loop with write
69			if ($this->useHandleSave) {
70			/** @var GridFieldEditableColumns $component */
71			$component = $gridField->getConfig()->getComponentByType(GridFieldEditableColumns::class);
72			$component->handleSave($gridField, $record);
73			} else {
74			foreach ($values as $k => $v) {
75			$record->$k = $v;
76			}
77			$record->write();
78			}
79			}
80			$newData = $data[$fieldName]['GridFieldAddNewInlineButton'] ?? [];
81			foreach ($newData as $idx => $values) {
82			$record = new $model;
83			if ($this->useHandleSave) {
84			/** @var GridFieldAddNewInlineButton $component */
85			$component = $gridField->getConfig()->getComponentByType(GridFieldAddNewInlineButton::class);
86			$component->handleSave($gridField, $record);
87			} else {
88			foreach ($values as $k => $v) {
89			$record->$k = $v;
90			}
91			}
92			$record->write();
93			}
94
95			$response = $controller->getResponse();
96
97			if (Director::is_ajax()) {
98			if (!$this->completeMessage) {
99			$this->completeMessage = _t('GridFieldSaveAllButton.DONE', 'All saved');
100			}
101			if ($this->shouldReload) {
102			ActionsGridFieldItemRequest::addXReload($controller);
103			}
104			$response->addHeader('X-Status', rawurlencode($this->completeMessage));
105			return null;
106			} else {
107			return $controller->redirectBack();
108			}
109			}
110
111			/**
112			* Get the value of completeMessage
113			*/
114			public function getCompleteMessage(): string
115			{
116			return $this->completeMessage;
			0 ignored issues – show Bug Best Practice introduced 2024-05-16 09:12 UTC by Report Bug Copy Issue Report The expression `return $this->completeMessage` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
117			}
118
119			/**
120			* Set the value of completeMessage
121			*
122			* @param string $completeMessage
123			*/
124			public function setCompleteMessage($completeMessage): self
125			{
126			$this->completeMessage = $completeMessage;
127			return $this;
128			}
129
130			/**
131			* Get the value of useHandleSave
132			*/
133			public function getUseHandleSave(): bool
134			{
135			return $this->useHandleSave;
			0 ignored issues – show Bug Best Practice introduced 2024-05-16 10:15 UTC by Report Bug Copy Issue Report The expression `return $this->useHandleSave` could return the type `null` which is incompatible with the type-hinted return `boolean`. Consider adding an additional type-check to rule them out. Loading history...
136			}
137
138			/**
139			* Set the value of useHandleSave
140			*
141			* @param bool $useHandleSave
142			*/
143			public function setUseHandleSave($useHandleSave): self
144			{
145			$this->useHandleSave = $useHandleSave;
146			return $this;
147			}
148
149			/**
150			* Get the value of shouldReload
151			*/
152			public function getShouldReload(): bool
153			{
154			return $this->shouldReload;
155			}
156
157			/**
158			* Set the value of shouldReload
159			*
160			* @param bool $shouldReload
161			*/
162			public function setShouldReload($shouldReload): self
163			{
164			$this->shouldReload = $shouldReload;
165			return $this;
166			}
167			}
168

lekoala / silverstripe-cms-actions

GridFieldSaveAllButton::handle() C last analyzed 2025-07-17 14:15 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

GridFieldSaveAllButton::handle() C
last analyzed 2025-07-17 14:15 UTC