OrdersDetailForm_ItemRequest::doChangeStatus() - Code Metrics - Inspection of "Move bulk actions into unique handlers" - silvercommerce/orders-admin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.0 ( dbac97...74fb09 )

by Morven

created 2018-03-07 14:38 UTC

OrdersDetailForm_ItemRequest::doChangeStatus() B

↳ Parent: OrdersDetailForm_ItemRequest

Complexity

Conditions	4
Paths	6

Size

Total Lines	53
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	32
nc	6
nop	2
dl	0
loc	53
rs	8.9849
c	0
b	0
f	0

How to fix Long Method

<?php

namespace SilverCommerce\OrdersAdmin\Forms\GridField;

use SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\Security\Security;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\View\Requirements;
use SilverStripe\Versioned\Versioned;
use SilverStripe\Versioned\DataDifferencer;
use SilverStripe\Core\Convert;
use SilverStripe\Admin\LeftAndMain;
use SilverStripe\Control\PjaxResponseNegotiator;
use SilverStripe\ORM\ValidationException;
use SilverStripe\ORM\ValidationResult;
use SilverCommerce\OrdersAdmin\Model\Invoice;
use SilverCommerce\OrdersAdmin\Model\Estimate;

class OrdersDetailForm_ItemRequest extends GridFieldDetailForm_ItemRequest
{

    private static $allowed_actions = [
        'edit',
        'view',
        'ItemEditForm'
    ];
    
    public function edit($request)
    {
        $controller = $this->getToplevelController();
        $form = $this->ItemEditForm();

        // If this is a new record, we need to save it first
        if ($this->record->ID == 0) {
            // ensure we populate any foreign keys first
            $list = $this->gridField->getList();
            if ($list instanceof HasManyList && !$this->record->isInDB()) {
                $key = $list->getForeignKey();
                $id = $list->getForeignID();
                $this->record->$key = $id;
            }

            $this->record->write();
            
            $controller
                ->getRequest()
                ->addHeader('X-Pjax', 'Content');
            
            return $controller->redirect($this->Link("edit"));
        }

        $return = $this->customise(array(
            'Backlink' => $controller->hasMethod('Backlink') ? $controller->Backlink() : $controller->Link(),
            'ItemEditForm' => $form,
        ))->renderWith($this->getTemplates());
        
        if ($request->isAjax()) {
            return $return;
        } else {
            // If not requested by ajax, we need to render it within the controller context+template
            return $controller->customise(array(
                // TODO CMS coupling
                'Content' => $return,
            ));
        }
    }

    public function ItemEditForm()
    {        
        $form = parent::ItemEditForm();
        $fields = $form->Fields();
        $actions = $form->Actions();
        $record = $this->record;
        $member = Member::currentUser();
        
        $can_view = $this->record->canView();
        $can_edit = $this->record->canEdit();
        $can_delete = $this->record->canDelete();
        $can_create = $this->record->canCreate();
        
        // First cache and remove the delete button
        $delete_action = $actions->dataFieldByName("action_doDelete");
        $actions->removeByName("action_doDelete");
        
        // Deal with Estimate objects
        if ($record->ClassName == Estimate::class) {            
            if ($record->ID && $can_edit) {
                $actions->insertAfter(
                    FormAction::create(
                        'doConvert',
                        _t('OrdersAdmin.ConvertToInvoice', 'Convert To Invoice')
                    )->setUseButtonTag(true)
                    ->addExtraClass('btn-outline-primary btn-hide-outline font-icon-sync'),
                    "action_doSave"
                );
            }
        }

        // Deal with Order objects
        if ($record->ClassName == Invoice::class) {
            $can_change_status = $this->record->canChangeStatus();
            
            // Set our status field as a dropdown (has to be here to
            // ignore canedit)
            // Allow users to change status (as long as they have permission)
            if ($can_edit || $can_change_status) {
                $status_field = DropdownField::create(
                    'Status',
                    null,
                    $record->config()->statuses
                );
                
                // Set default status if we can
                if (!$record->Status && !$record->config()->default_status) {
                    $status_field
                        ->setValue($record->config()->default_status);
                } else {
                    $status_field
                        ->setValue($record->Status);
                }
                
                $fields->replaceField("Status", $status_field);
            }
            
            // Setup order history
            if (Permission::check(array('ORDERS_EDIT_INVOICES', 'ADMIN'), 'any', $member)) {
                $versions = $record->AllVersions();
                $first_version = $versions->First();
                $curr_version = ($first_version) ? $versions->First() : null;
                $message = "";

                foreach ($versions as $version) {
                    $i = $version->Version;
                    $name = "History_{$i}";

                    if ($i > 1) {
                        $frm = Versioned::get_version($record->ClassName, $record->ID, $i - 1);
                        $to = Versioned::get_version($record->ClassName, $record->ID, $i);
                        $diff = new DataDifferencer($frm, $to);

                        if ($version->Author()) {
                            $message = "<p>{$version->Author()->FirstName} ({$version->LastEdited})</p>";
                        } else {
                            $message = "<p>Unknown ({$version->LastEdited})</p>";
                        }

                        if ($diff->ChangedFields()->exists()) {
                            $message .= "<ul>";

                            // Now loop through all changed fields and track as message
                            foreach ($diff->ChangedFields() as $change) {
                                if ($change->Name != "LastEdited") {
                                    $message .= "<li>{$change->Title}: {$change->Diff}</li>";
                                }
                            }

                            $message .= "</ul>";
                        }
                        
                        $fields->addFieldToTab("Root.History", LiteralField::create(
                            $name,
                            "<div class=\"field\">{$message}</div>"
                        ));
                    }
                }
            }
            
            // Is user cannot edit, but can change status, add change
            // status button
            if ($record->ID && !$can_edit && $can_change_status) {
                $actions->push(
                    FormAction::create('doChangeStatus', _t('OrdersAdmin.Save', 'Save'))
                        ->setUseButtonTag(true)
                        ->addExtraClass('btn-primary font-icon-save')
                );
            }
        }
        
        // Add a duplicate button, either after the save button or
        // the change status "save" button.
        if ($record->ID) {
            $duplicate_button = FormAction::create(
                'doDuplicate',
                _t('OrdersAdmin.Duplicate', 'Duplicate')
            )->setUseButtonTag(true)
            ->addExtraClass('btn-outline-primary  btn-hide-outline font-icon-switch');
            
            if ($actions->find("Name", "action_doSave")) {
                $actions->insertAfter($duplicate_button, "action_doSave");
            }
            
            if ($actions->find("Name", "action_doChangeStatus")) {
                $actions->insertAfter($duplicate_button, "action_doChangeStatus");
            }
        }

        if ($record->ID) {
            $html = '<a href="' . $record->DisplayLink() . '" ';
            $html .= 'target="_blank" class="btn btn-outline-primary  btn-hide-outline font-icon-eye"';
            $html .= '>' . _t('OrdersAdmin.View', 'View') . '</a>';
            
            $view_field = LiteralField::create('ViewButton', $html);

            $html = '<a href="' . $record->PDFLink() . '" ';
            $html .= 'target="_blank" class="btn btn-outline-primary  btn-hide-outline font-icon-down-circled"';
            $html .= '>' . _t('OrdersAdmin.Download', 'Download') . '</a>';
            
            $download_field = LiteralField::create('DownloadButton', $html);
            
            $actions->push($view_field, "action_doSave");
            $actions->push($download_field, "action_doSave");
        }
        
        // Finally, if allowed, re-add the delete button (so it is last)
        if ($record->ID && $can_delete) {
            $actions->push($delete_action);
        }

        $this->extend("updateItemEditForm", $form);
        
        return $form;
    }
    
    public function doDuplicate($data, $form)
    {
        $record = $this->record;

        if ($record && !$record->canEdit()) {
            return Security::permissionFailure($this);
        }

        $form->saveInto($record);
        
        $record->write();
        
        $new_record = $record->duplicate();
        
        $this->gridField->getList()->add($new_record);

        $message = sprintf(
            _t('OrdersAdmin.Duplicated', 'Duplicated %s %s'),
            $this->record->singular_name(),
            '"'.Convert::raw2xml($this->record->Title).'"'
        );
        
        $toplevelController = $this->getToplevelController();
        if ($toplevelController && $toplevelController instanceof LeftAndMain) {
            $backForm = $toplevelController->getEditForm();
            $backForm->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
        } else {
            $form->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
        }
        
        $toplevelController = $this->getToplevelController();
        $toplevelController->getRequest()->addHeader('X-Pjax', 'Content');

        return $toplevelController->redirect($this->getBacklink(), 302);
    }
    
    public function doConvert($data, $form)
    {
        $record = $this->record;

        if ($record && !$record->canEdit()) {
            return Security::permissionFailure($this);
        }

        $form->saveInto($record);
        
        $record = $record->convertToInvoice();
        $this->record = $record;
        
        $this->gridField->getList()->add($record);

        $message = sprintf(
            _t('OrdersAdmin.ConvertedToOrder', 'Converted %s %s'),
            $this->record->singular_name(),
            '"'.Convert::raw2xml($this->record->Title).'"'
        );
        
        $toplevelController = $this->getToplevelController();
        if ($toplevelController && $toplevelController instanceof LeftAndMain) {
            $backForm = $toplevelController->getEditForm();
            $backForm->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
        } else {
            $form->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
        }
        
        $toplevelController = $this->getToplevelController();
        $toplevelController->getRequest()->addHeader('X-Pjax', 'Content');

        return $toplevelController->redirect($this->getBacklink(), 302);
    }
    
    public function doChangeStatus($data, $form)
    {
        $new_record = $this->record->ID == 0;
        $controller = $this->getToplevelController();
        $list = $this->gridField->getList();

        try {
            $this->record->Status = $data["Status"];
            $this->record->write();
        } catch (ValidationException $e) {
            $form->sessionMessage($e->getResult()->message(), 'bad', ValidationResult::CAST_HTML);
            
            $responseNegotiator = new PjaxResponseNegotiator(array(
                'CurrentForm' => function () use (&$form) {
                    return $form->forTemplate();
                },
                'default' => function () use (&$controller) {
                    return $controller->redirectBack();
                }
            ));
            
            if ($controller->getRequest()->isAjax()) {
                $controller->getRequest()->addHeader('X-Pjax', 'CurrentForm');
            }
            
            return $responseNegotiator->respond($controller->getRequest());
        }

        $link = '<a href="' . $this->Link('edit') . '">"'
            . htmlspecialchars($this->record->Title, ENT_QUOTES)
            . '"</a>';

        $message = _t(
            'OrdersAdmin.StatusChanged',
            'Status Changed {name} {link}',
            array(
                'name' => $this->record->i18n_singular_name(),
                'link' => $link
            )
        );
        
        $form->sessionMessage($message, 'good', ValidationResult::CAST_HTML);

        if ($this->gridField->getList()->byId($this->record->ID)) {
            // Return new view, as we can't do a "virtual redirect" via the CMS Ajax
            // to the same URL (it assumes that its content is already current, and doesn't reload)
            return $this->edit($controller->getRequest());
        } else {
            // Changes to the record properties might've excluded the record from
            // a filtered list, so return back to the main view if it can't be found
            $noActionURL = $controller->removeAction($data['url']);
            $controller->getRequest()->addHeader('X-Pjax', 'Content');
            return $controller->redirect($noActionURL, 302);
        }
    }
}


1			<?php
2
3			namespace SilverCommerce\OrdersAdmin\Forms\GridField;
4
5			use SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest;
6			use SilverStripe\Security\Member;
7			use SilverStripe\Security\Permission;
8			use SilverStripe\Security\Security;
9			use SilverStripe\Forms\Form;
10			use SilverStripe\Forms\FormAction;
11			use SilverStripe\Forms\LiteralField;
12			use SilverStripe\Forms\DropdownField;
13			use SilverStripe\View\Requirements;
14			use SilverStripe\Versioned\Versioned;
15			use SilverStripe\Versioned\DataDifferencer;
16			use SilverStripe\Core\Convert;
17			use SilverStripe\Admin\LeftAndMain;
18			use SilverStripe\Control\PjaxResponseNegotiator;
19			use SilverStripe\ORM\ValidationException;
20			use SilverStripe\ORM\ValidationResult;
21			use SilverCommerce\OrdersAdmin\Model\Invoice;
22			use SilverCommerce\OrdersAdmin\Model\Estimate;
23
24			class OrdersDetailForm_ItemRequest extends GridFieldDetailForm_ItemRequest
25			{
26
27			private static $allowed_actions = [
28			'edit',
29			'view',
30			'ItemEditForm'
31			];
32
33			public function edit($request)
34			{
35			$controller = $this->getToplevelController();
36			$form = $this->ItemEditForm();
37
38			// If this is a new record, we need to save it first
39			if ($this->record->ID == 0) {
40			// ensure we populate any foreign keys first
41			$list = $this->gridField->getList();
42			if ($list instanceof HasManyList && !$this->record->isInDB()) {
43			$key = $list->getForeignKey();
44			$id = $list->getForeignID();
45			$this->record->$key = $id;
46			}
47
48			$this->record->write();
49
50			$controller
51			->getRequest()
52			->addHeader('X-Pjax', 'Content');
53
54			return $controller->redirect($this->Link("edit"));
55			}
56
57			$return = $this->customise(array(
58			'Backlink' => $controller->hasMethod('Backlink') ? $controller->Backlink() : $controller->Link(),
59			'ItemEditForm' => $form,
60			))->renderWith($this->getTemplates());
61
62			if ($request->isAjax()) {
63			return $return;
64			} else {
65			// If not requested by ajax, we need to render it within the controller context+template
66			return $controller->customise(array(
67			// TODO CMS coupling
68			'Content' => $return,
69			));
70			}
71			}
72
73			public function ItemEditForm()
74			{
75			$form = parent::ItemEditForm();
76			$fields = $form->Fields();
77			$actions = $form->Actions();
78			$record = $this->record;
79			$member = Member::currentUser();
80
81			$can_view = $this->record->canView();
82			$can_edit = $this->record->canEdit();
83			$can_delete = $this->record->canDelete();
84			$can_create = $this->record->canCreate();
85
86			// First cache and remove the delete button
87			$delete_action = $actions->dataFieldByName("action_doDelete");
88			$actions->removeByName("action_doDelete");
89
90			// Deal with Estimate objects
91			if ($record->ClassName == Estimate::class) {
92			if ($record->ID && $can_edit) {
93			$actions->insertAfter(
94			FormAction::create(
95			'doConvert',
96			_t('OrdersAdmin.ConvertToInvoice', 'Convert To Invoice')
97			)->setUseButtonTag(true)
98			->addExtraClass('btn-outline-primary btn-hide-outline font-icon-sync'),
99			"action_doSave"
100			);
101			}
102			}
103
104			// Deal with Order objects
105			if ($record->ClassName == Invoice::class) {
106			$can_change_status = $this->record->canChangeStatus();
107
108			// Set our status field as a dropdown (has to be here to
109			// ignore canedit)
110			// Allow users to change status (as long as they have permission)
111			if ($can_edit \|\| $can_change_status) {
112			$status_field = DropdownField::create(
113			'Status',
114			null,
115			$record->config()->statuses
116			);
117
118			// Set default status if we can
119			if (!$record->Status && !$record->config()->default_status) {
120			$status_field
121			->setValue($record->config()->default_status);
122			} else {
123			$status_field
124			->setValue($record->Status);
125			}
126
127			$fields->replaceField("Status", $status_field);
128			}
129
130			// Setup order history
131			if (Permission::check(array('ORDERS_EDIT_INVOICES', 'ADMIN'), 'any', $member)) {
132			$versions = $record->AllVersions();
133			$first_version = $versions->First();
134			$curr_version = ($first_version) ? $versions->First() : null;
135			$message = "";
136
137			foreach ($versions as $version) {
138			$i = $version->Version;
139			$name = "History_{$i}";
140
141			if ($i > 1) {
142			$frm = Versioned::get_version($record->ClassName, $record->ID, $i - 1);
143			$to = Versioned::get_version($record->ClassName, $record->ID, $i);
144			$diff = new DataDifferencer($frm, $to);
145
146			if ($version->Author()) {
147			$message = "<p>{$version->Author()->FirstName} ({$version->LastEdited})</p>";
148			} else {
149			$message = "<p>Unknown ({$version->LastEdited})</p>";
150			}
151
152			if ($diff->ChangedFields()->exists()) {
153			$message .= "<ul>";
154
155			// Now loop through all changed fields and track as message
156			foreach ($diff->ChangedFields() as $change) {
157			if ($change->Name != "LastEdited") {
158			$message .= "<li>{$change->Title}: {$change->Diff}</li>";
159			}
160			}
161
162			$message .= "</ul>";
163			}
164
165			$fields->addFieldToTab("Root.History", LiteralField::create(
166			$name,
167			"<div class=\"field\">{$message}</div>"
168			));
169			}
170			}
171			}
172
173			// Is user cannot edit, but can change status, add change
174			// status button
175			if ($record->ID && !$can_edit && $can_change_status) {
176			$actions->push(
177			FormAction::create('doChangeStatus', _t('OrdersAdmin.Save', 'Save'))
178			->setUseButtonTag(true)
179			->addExtraClass('btn-primary font-icon-save')
180			);
181			}
182			}
183
184			// Add a duplicate button, either after the save button or
185			// the change status "save" button.
186			if ($record->ID) {
187			$duplicate_button = FormAction::create(
188			'doDuplicate',
189			_t('OrdersAdmin.Duplicate', 'Duplicate')
190			)->setUseButtonTag(true)
191			->addExtraClass('btn-outline-primary btn-hide-outline font-icon-switch');
192
193			if ($actions->find("Name", "action_doSave")) {
194			$actions->insertAfter($duplicate_button, "action_doSave");
195			}
196
197			if ($actions->find("Name", "action_doChangeStatus")) {
198			$actions->insertAfter($duplicate_button, "action_doChangeStatus");
199			}
200			}
201
202			if ($record->ID) {
203			$html = '<a href="' . $record->DisplayLink() . '" ';
204			$html .= 'target="_blank" class="btn btn-outline-primary btn-hide-outline font-icon-eye"';
205			$html .= '>' . _t('OrdersAdmin.View', 'View') . '</a>';
206
207			$view_field = LiteralField::create('ViewButton', $html);
208
209			$html = '<a href="' . $record->PDFLink() . '" ';
210			$html .= 'target="_blank" class="btn btn-outline-primary btn-hide-outline font-icon-down-circled"';
211			$html .= '>' . _t('OrdersAdmin.Download', 'Download') . '</a>';
212
213			$download_field = LiteralField::create('DownloadButton', $html);
214
215			$actions->push($view_field, "action_doSave");
216			$actions->push($download_field, "action_doSave");
217			}
218
219			// Finally, if allowed, re-add the delete button (so it is last)
220			if ($record->ID && $can_delete) {
221			$actions->push($delete_action);
222			}
223
224			$this->extend("updateItemEditForm", $form);
225
226			return $form;
227			}
228
229			public function doDuplicate($data, $form)
230			{
231			$record = $this->record;
232
233			if ($record && !$record->canEdit()) {
234			return Security::permissionFailure($this);
235			}
236
237			$form->saveInto($record);
238
239			$record->write();
240
241			$new_record = $record->duplicate();
242
243			$this->gridField->getList()->add($new_record);
244
245			$message = sprintf(
246			_t('OrdersAdmin.Duplicated', 'Duplicated %s %s'),
247			$this->record->singular_name(),
248			'"'.Convert::raw2xml($this->record->Title).'"'
249			);
250
251			$toplevelController = $this->getToplevelController();
252			if ($toplevelController && $toplevelController instanceof LeftAndMain) {
253			$backForm = $toplevelController->getEditForm();
254			$backForm->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
255			} else {
256			$form->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
257			}
258
259			$toplevelController = $this->getToplevelController();
260			$toplevelController->getRequest()->addHeader('X-Pjax', 'Content');
261
262			return $toplevelController->redirect($this->getBacklink(), 302);
263			}
264
265			public function doConvert($data, $form)
266			{
267			$record = $this->record;
268
269			if ($record && !$record->canEdit()) {
270			return Security::permissionFailure($this);
271			}
272
273			$form->saveInto($record);
274
275			$record = $record->convertToInvoice();
276			$this->record = $record;
277
278			$this->gridField->getList()->add($record);
279
280			$message = sprintf(
281			_t('OrdersAdmin.ConvertedToOrder', 'Converted %s %s'),
282			$this->record->singular_name(),
283			'"'.Convert::raw2xml($this->record->Title).'"'
284			);
285
286			$toplevelController = $this->getToplevelController();
287			if ($toplevelController && $toplevelController instanceof LeftAndMain) {
288			$backForm = $toplevelController->getEditForm();
289			$backForm->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
290			} else {
291			$form->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
292			}
293
294			$toplevelController = $this->getToplevelController();
295			$toplevelController->getRequest()->addHeader('X-Pjax', 'Content');
296
297			return $toplevelController->redirect($this->getBacklink(), 302);
298			}
299
300			public function doChangeStatus($data, $form)
301			{
302			$new_record = $this->record->ID == 0;
303			$controller = $this->getToplevelController();
304			$list = $this->gridField->getList();
305
306			try {
307			$this->record->Status = $data["Status"];
308			$this->record->write();
309			} catch (ValidationException $e) {
310			$form->sessionMessage($e->getResult()->message(), 'bad', ValidationResult::CAST_HTML);
311
312			$responseNegotiator = new PjaxResponseNegotiator(array(
313			'CurrentForm' => function () use (&$form) {
314			return $form->forTemplate();
315			},
316			'default' => function () use (&$controller) {
317			return $controller->redirectBack();
318			}
319			));
320
321			if ($controller->getRequest()->isAjax()) {
322			$controller->getRequest()->addHeader('X-Pjax', 'CurrentForm');
323			}
324
325			return $responseNegotiator->respond($controller->getRequest());
326			}
327
328			$link = '<a href="' . $this->Link('edit') . '">"'
329			. htmlspecialchars($this->record->Title, ENT_QUOTES)
330			. '"</a>';
331
332			$message = _t(
333			'OrdersAdmin.StatusChanged',
334			'Status Changed {name} {link}',
335			array(
336			'name' => $this->record->i18n_singular_name(),
337			'link' => $link
338			)
339			);
340
341			$form->sessionMessage($message, 'good', ValidationResult::CAST_HTML);
342
343			if ($this->gridField->getList()->byId($this->record->ID)) {
344			// Return new view, as we can't do a "virtual redirect" via the CMS Ajax
345			// to the same URL (it assumes that its content is already current, and doesn't reload)
346			return $this->edit($controller->getRequest());
347			} else {
348			// Changes to the record properties might've excluded the record from
349			// a filtered list, so return back to the main view if it can't be found
350			$noActionURL = $controller->removeAction($data['url']);
351			$controller->getRequest()->addHeader('X-Pjax', 'Content');
352			return $controller->redirect($noActionURL, 302);
353			}
354			}
355			}
356

silvercommerce / orders-admin

Push — 1.0 ( dbac97...74fb09 )

OrdersDetailForm_ItemRequest::doChangeStatus() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like