ModelAdminExtension::updateEditForm() - Code Metrics - Inspection of "FIX: better canView for modeladmin" - sunnysideup/silverstripe-cms-niceties - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( bad84e...64ddef )

by Nicolaas

created 2025-02-21 02:28 UTC

ModelAdminExtension::updateEditForm() B

↳ Parent: ModelAdminExtension

Complexity

Conditions	11
Paths	13

Size

Total Lines	37
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	0

Metric	Value
cc	11
eloc	23
c	7
b	0
f	0
nc	13
nop	1
dl	0
loc	37
rs	7.3166

How to fix Complexity

<?php

namespace Sunnysideup\CMSNiceties\Extensions;

use SilverStripe\Admin\ModelAdmin;
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Extension;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Lumberjack\Forms\GridFieldSiteTreeState;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Security\Permission;
use SilverStripe\Versioned\Versioned;
use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows;
filter:
    dependency_paths: ["lib/*"]

/**
 * Class \Sunnysideup\CMSNiceties\Extensions\ModelAdminExtension.
 *
 * @property ModelAdmin|ModelAdminExtension $owner
 */
class ModelAdminExtension extends Extension
{
    private static $excluded_models_from_ssu_extension = [];

    private static $excluded_modeladmins_from_ssu_extension = [];

    private static $sort_fields_from_ssu_extension = ['SortNumber', 'Sort', 'SortOrder'];

    private static array $assume_to_allow_all = [
        'ADMIN',
    ];

    private static int $max_records_to_check_for_can_view = 10000;

    public function updateEditForm($form)
    {
        $owner = $this->getOwner();
        if ($this->IsIncludedInExtension()) {
            $obj = Injector::inst()->get($owner->modelClass);
            if ($obj) {
                $sortFields = $owner->config()->get('sort_fields_from_ssu_extension');
                $gridField = $form->Fields()->dataFieldByName($this->sanitiseClassNameHelper($owner->modelClass));
                if ($gridField instanceof GridField) {
                    $config = $gridField->getConfig();
                    $dbFields = $obj->config()->get('db');
                    foreach ($sortFields as $sortField) {
                        if (isset($dbFields[$sortField])) {
                            // This is just a precaution to ensure we got a GridField from dataFieldByName() which you should have
                            if (! $config->getComponentByType(GridFieldSortableRows::class)) {
                                $obj = $owner->modelClass::singleton();
                                if ($obj->hasExtension(Versioned::class)) {
                                    $sorter = (new GridFieldSortableRows($sortField))
                                        ->setUpdateVersionedStage(Versioned::LIVE);
                                } else {
                                    $sorter = new GridFieldSortableRows($sortField);
                                }
                                $config->addComponent($sorter);
                            }
                            break;
                        }
                    }

                    if ($obj->hasExtension(Versioned::class) && $obj->hasStages() && class_exists(GridFieldSiteTreeState::class)) {
                        $config->addComponent(new GridFieldSiteTreeState());
                    }
                }
            }
        }


        return $form;
    }

    //
    // /**
    //  * Sanitise a model class' name for inclusion in a link
    //  *
    //  * @param string $class
    //  * @return string
    //  */
    protected function sanitiseClassNameHelper(string $class): string
    {
        return str_replace('\\', '-', $class);
    }

    protected function updateList(&$list)
    {
        $owner = $this->getOwner();
        if ($this->IsIncludedInExtension()) {
            if (!Permission::check($owner->config()->get('assume_to_allow_all'))) {
                $count = $list->count();
                $limit = $owner->config()->get('max_records_to_check_for_can_view');
                $ids = [0 => 0];
                if ($count < $limit) {
                    foreach ($list as $record) {
                        if ($record->canView()) {
                            $ids[] = $record->ID;
                        }
                    }
                }
                $list = $list->filter(['ID' => $ids]);
            }
        }
    }

    protected function IsIncludedInExtension(): bool
    {
        $owner = $this->getOwner();
        $excludedModelAdmins = $owner->config()->get('excluded_modeladmins_from_ssu_extension');
        if (! in_array(get_class($owner), $excludedModelAdmins, true)) {
            $excludedModels = $owner->config()->get('excluded_models_from_ssu_extension');
            if (! in_array($owner->modelClass, $excludedModels, true)) {
                return true;
            }
        }
        return false;
    }
}


1			<?php
2
3			namespace Sunnysideup\CMSNiceties\Extensions;
4
5			use SilverStripe\Admin\ModelAdmin;
6			use SilverStripe\Control\Director;
7			use SilverStripe\Core\Config\Config;
8			use SilverStripe\Core\Extension;
9			use SilverStripe\Core\Injector\Injector;
10			use SilverStripe\Forms\GridField\GridField;
11			use SilverStripe\Lumberjack\Forms\GridFieldSiteTreeState;
			0 ignored issues – show Bug introduced 2025-02-05 23:10 UTC by Report Bug Copy Issue Report The type `SilverStripe\Lumberjack\...\GridFieldSiteTreeState` 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...
12			use SilverStripe\Security\Permission;
13			use SilverStripe\Versioned\Versioned;
14			use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows;
			0 ignored issues – show Bug introduced 2024-05-01 02:45 UTC by Report Bug Copy Issue Report The type `UndefinedOffset\Sortable...s\GridFieldSortableRows` 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...
15
16			/**
17			* Class \Sunnysideup\CMSNiceties\Extensions\ModelAdminExtension.
18			*
19			* @property ModelAdmin\|ModelAdminExtension $owner
20			*/
21			class ModelAdminExtension extends Extension
22			{
23			private static $excluded_models_from_ssu_extension = [];
24
25			private static $excluded_modeladmins_from_ssu_extension = [];
26
27			private static $sort_fields_from_ssu_extension = ['SortNumber', 'Sort', 'SortOrder'];
28
29			private static array $assume_to_allow_all = [
30			'ADMIN',
31			];
32
33			private static int $max_records_to_check_for_can_view = 10000;
34
35			public function updateEditForm($form)
36			{
37			$owner = $this->getOwner();
38			if ($this->IsIncludedInExtension()) {
39			$obj = Injector::inst()->get($owner->modelClass);
40			if ($obj) {
41			$sortFields = $owner->config()->get('sort_fields_from_ssu_extension');
42			$gridField = $form->Fields()->dataFieldByName($this->sanitiseClassNameHelper($owner->modelClass));
43			if ($gridField instanceof GridField) {
44			$config = $gridField->getConfig();
45			$dbFields = $obj->config()->get('db');
46			foreach ($sortFields as $sortField) {
47			if (isset($dbFields[$sortField])) {
48			// This is just a precaution to ensure we got a GridField from dataFieldByName() which you should have
49			if (! $config->getComponentByType(GridFieldSortableRows::class)) {
50			$obj = $owner->modelClass::singleton();
51			if ($obj->hasExtension(Versioned::class)) {
52			$sorter = (new GridFieldSortableRows($sortField))
53			->setUpdateVersionedStage(Versioned::LIVE);
54			} else {
55			$sorter = new GridFieldSortableRows($sortField);
56			}
57			$config->addComponent($sorter);
58			}
59			break;
60			}
61			}
62
63			if ($obj->hasExtension(Versioned::class) && $obj->hasStages() && class_exists(GridFieldSiteTreeState::class)) {
64			$config->addComponent(new GridFieldSiteTreeState());
65			}
66			}
67			}
68			}
69
70
71			return $form;
72			}
73
74			//
75			// /**
76			// * Sanitise a model class' name for inclusion in a link
77			// *
78			// * @param string $class
79			// * @return string
80			// */
81			protected function sanitiseClassNameHelper(string $class): string
82			{
83			return str_replace('\\', '-', $class);
84			}
85
86			protected function updateList(&$list)
87			{
88			$owner = $this->getOwner();
89			if ($this->IsIncludedInExtension()) {
90			if (!Permission::check($owner->config()->get('assume_to_allow_all'))) {
91			$count = $list->count();
92			$limit = $owner->config()->get('max_records_to_check_for_can_view');
93			$ids = [0 => 0];
94			if ($count < $limit) {
95			foreach ($list as $record) {
96			if ($record->canView()) {
97			$ids[] = $record->ID;
98			}
99			}
100			}
101			$list = $list->filter(['ID' => $ids]);
102			}
103			}
104			}
105
106			protected function IsIncludedInExtension(): bool
107			{
108			$owner = $this->getOwner();
109			$excludedModelAdmins = $owner->config()->get('excluded_modeladmins_from_ssu_extension');
110			if (! in_array(get_class($owner), $excludedModelAdmins, true)) {
111			$excludedModels = $owner->config()->get('excluded_models_from_ssu_extension');
112			if (! in_array($owner->modelClass, $excludedModels, true)) {
113			return true;
114			}
115			}
116			return false;
117			}
118			}
119

sunnysideup / silverstripe-cms-niceties

Push — master ( bad84e...64ddef )

ModelAdminExtension::updateEditForm() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like