SiteConfig::getCMSFields() - Code Metrics - Inspection of "PATCH: fixing namespacing" - sunnysideup/silverstripe-cms-dark-theme - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( d6316c...aeb638 )

by Nicolaas

created 2023-10-24 23:26 UTC

SiteConfig::getCMSFields() B

↳ Parent: SiteConfig

Complexity

Conditions	6
Paths	16

Size

Total Lines	143
Code Lines	102

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	102
nc	16
nop	0
dl	0
loc	143
rs	7.3777
c	0
b	0
f	0

How to fix Long Method

<?php

namespace Sunnysideup\CMSDarkTheme\Model\Extentions;

use SilverStripe\CMS\Model\SiteTree;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\HiddenField;
use SilverStripe\Forms\ListboxField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\OptionsetField;
use SilverStripe\Forms\Tab;
use SilverStripe\Forms\TabSet;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ManyManyList;
use SilverStripe\Security\Group;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Security\Security;
use SilverStripe\View\TemplateGlobalProvider;
use SilverStripe\CMS\Controllers\CMSMain;
filter:
    dependency_paths: ["lib/*"]

/**
 * SiteConfig
 *
 * @property string Title Title of the website.
 * @property string Tagline Tagline of the website.
 * @property string CanViewType Type of restriction used for view permissions.
 * @property string CanEditType Type of restriction used for edit permissions.
 * @property string CanCreateTopLevelType Type of restriction used for creation of root-level pages.
 * @method ManyManyList ViewerGroups() List of groups that can view SiteConfig.
 * @method ManyManyList EditorGroups() List of groups that can edit SiteConfig.
 * @method ManyManyList CreateTopLevelGroups() List of groups that can create root-level pages.
 */
class SiteConfig extends DataObject implements PermissionProvider, TemplateGlobalProvider
{
    private static $db = [
        "Title" => "Varchar(255)",
        "Tagline" => "Varchar(255)",
        "CanViewType" => "Enum('Anyone, LoggedInUsers, OnlyTheseUsers', 'Anyone')",
        "CanEditType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
        "CanCreateTopLevelType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
    ];

    private static $many_many = [
        "ViewerGroups" => Group::class,
        "EditorGroups" => Group::class,
        "CreateTopLevelGroups" => Group::class,
    ];

    private static $defaults = [
        "CanViewType" => "Anyone",
        "CanEditType" => "LoggedInUsers",
        "CanCreateTopLevelType" => "LoggedInUsers",
    ];

    private static $table_name = 'SiteConfig';

    /**
     * Default permission to check for 'LoggedInUsers' to create or edit pages
     *
     * @var array
     * @config
     */
    private static $required_permission = [
        'CMS_ACCESS_CMSMain',
        'CMS_ACCESS_LeftAndMain'
    ];

    public function populateDefaults()
    {
        $this->Title = _t(self::class . '.SITENAMEDEFAULT', "Your Site Name");
        $this->Tagline = _t(self::class . '.TAGLINEDEFAULT', "your tagline here");

        // Allow these defaults to be overridden
        parent::populateDefaults();
    }

    /**
     * Get the fields that are sent to the CMS.
     *
     * In your extensions: updateCMSFields($fields).
     *
     * @return FieldList
     */
    public function getCMSFields()
    {
        $mapFn = function ($groups = []) {
            $map = [];
            foreach ($groups as $group) {
                // Listboxfield values are escaped, use ASCII char instead of &raquo;
                $map[$group->ID] = $group->getBreadcrumbs(' > ');
            }
            asort($map);
            return $map;
        };
        $groupsMap = $mapFn(Group::get());
        $viewAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_VIEW_ALL', 'ADMIN']));
        $editAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_EDIT_ALL', 'ADMIN']));

        $fields = FieldList::create(
            TabSet::create(
                "Root",
                $tabMain = Tab::create(
                    'Main',
                    $titleField = TextField::create("Title", _t(self::class . '.SITETITLE', "Site title")),
                    $taglineField = TextField::create(
                        "Tagline",
                        _t(self::class . '.SITETAGLINE', "Site Tagline/Slogan")
                    )
                ),
                $tabAccess = Tab::create(
                    'Access',
                    $viewersOptionsField = OptionsetField::create(
                        "CanViewType",
                        _t(self::class . '.VIEWHEADER', "Who can view pages on this site?")
                    ),
                    $viewerGroupsField = ListboxField::create(
                        "ViewerGroups",
                        _t('SilverStripe\\CMS\\Model\\SiteTree.VIEWERGROUPS', "Viewer Groups")
                    )
                        ->setSource($groupsMap)
                        ->setAttribute(
                            'data-placeholder',
                            _t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
                        ),
                    $editorsOptionsField = OptionsetField::create(
                        "CanEditType",
                        _t(self::class . '.EDITHEADER', "Who can edit pages on this site?")
                    ),
                    $editorGroupsField = ListboxField::create(
                        "EditorGroups",
                        _t('SilverStripe\\CMS\\Model\\SiteTree.EDITORGROUPS', "Editor Groups")
                    )
                        ->setSource($groupsMap)
                        ->setAttribute(
                            'data-placeholder',
                            _t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
                        ),
                    $topLevelCreatorsOptionsField = OptionsetField::create(
                        "CanCreateTopLevelType",
                        _t(self::class . '.TOPLEVELCREATE', "Who can create pages in the root of the site?")
                    ),
                    $topLevelCreatorsGroupsField = ListboxField::create(
                        "CreateTopLevelGroups",
                        _t(self::class . '.TOPLEVELCREATORGROUPS', "Top level creators")
                    )
                        ->setSource($groupsMap)
                        ->setAttribute(
                            'data-placeholder',
                            _t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
                        )
                )
            ),
            HiddenField::create('ID')
        );

        $viewersOptionsSource = [];
        $viewersOptionsSource["Anyone"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSANYONE', "Anyone");
        $viewersOptionsSource["LoggedInUsers"] = _t(
            'SilverStripe\\CMS\\Model\\SiteTree.ACCESSLOGGEDIN',
            "Logged-in users"
        );
        $viewersOptionsSource["OnlyTheseUsers"] = _t(
            'SilverStripe\\CMS\\Model\\SiteTree.ACCESSONLYTHESE',
            "Only these groups (choose from list)"
        );
        $viewersOptionsField->setSource($viewersOptionsSource);

        if ($viewAllGroupsMap) {
            $viewerGroupsField->setDescription(_t(
                'SilverStripe\\CMS\\Model\\SiteTree.VIEWER_GROUPS_FIELD_DESC',
                'Groups with global view permissions: {groupList}',
                ['groupList' => implode(', ', array_values($viewAllGroupsMap))]
            ));
        }

        if ($editAllGroupsMap) {
            $editorGroupsField->setDescription(_t(
                'SilverStripe\\CMS\\Model\\SiteTree.EDITOR_GROUPS_FIELD_DESC',
                'Groups with global edit permissions: {groupList}',
                ['groupList' => implode(', ', array_values($editAllGroupsMap))]
            ));
        }

        $editorsOptionsSource = [];
        $editorsOptionsSource["LoggedInUsers"] = _t(
            'SilverStripe\\CMS\\Model\\SiteTree.EDITANYONE',
            "Anyone who can log-in to the CMS"
        );
        $editorsOptionsSource["OnlyTheseUsers"] = _t(
            'SilverStripe\\CMS\\Model\\SiteTree.EDITONLYTHESE',
            "Only these groups (choose from list)"
        );
        $editorsOptionsField->setSource($editorsOptionsSource);

        $topLevelCreatorsOptionsField->setSource($editorsOptionsSource);

        if (!Permission::check('EDIT_SITECONFIG')) {
            $fields->makeFieldReadonly($viewersOptionsField);
            $fields->makeFieldReadonly($viewerGroupsField);
            $fields->makeFieldReadonly($editorsOptionsField);
            $fields->makeFieldReadonly($editorGroupsField);
            $fields->makeFieldReadonly($topLevelCreatorsOptionsField);
            $fields->makeFieldReadonly($topLevelCreatorsGroupsField);
            $fields->makeFieldReadonly($taglineField);
            $fields->makeFieldReadonly($titleField);
        }

        if (file_exists(BASE_PATH . '/install.php')) {
            $fields->addFieldToTab(
                'Root.Main',
                LiteralField::create(
                    'InstallWarningHeader',
                    '<div class="alert alert-warning">' . _t(
                        'SilverStripe\\CMS\\Model\\SiteTree.REMOVE_INSTALL_WARNING',
                        'Warning: You should remove install.php from this SilverStripe install for security reasons.'
                    ) . '</div>'
                ),
                'Title'
            );
        }

        $tabMain->setTitle(_t(self::class . '.TABMAIN', "Main"));
        $tabAccess->setTitle(_t(self::class . '.TABACCESS', "Access"));
        $this->extend('updateCMSFields', $fields);

        return $fields;
    }

    /**
     * Get the actions that are sent to the CMS.
     *
     * In your extensions: updateEditFormActions($actions)
     *
     * @return FieldList
     */
    public function getCMSActions()
    {
        if (Permission::check('ADMIN') || Permission::check('EDIT_SITECONFIG')) {
            $actions = FieldList::create(
                FormAction::create(
                    'save_siteconfig',
                    _t('SilverStripe\\CMS\\Controllers\\CMSMain.SAVE', 'Save')
                )->addExtraClass('btn-primary font-icon-save')
            );
        } else {
            $actions = FieldList::create();
        }

        $this->extend('updateCMSActions', $actions);

        return $actions;
    }

    /**
     * @return string
     */
    public function CMSEditLink()
    {
        return SiteConfigLeftAndMain::singleton()->Link();
filter:
    dependency_paths: ["lib/*"]
    }

    /**
     * Get the current sites SiteConfig, and creates a new one through
     * {@link make_site_config()} if none is found.
     *
     * @return SiteConfig
     */
    public static function current_site_config()
    {
        /** @var SiteConfig $siteConfig */
        $siteConfig = DataObject::get_one(SiteConfig::class);
        if (!$siteConfig) {

            $siteConfig = self::make_site_config();
        }

        static::singleton()->extend('updateCurrentSiteConfig', $siteConfig);

        return $siteConfig;
    }

    /**
     * Setup a default SiteConfig record if none exists.
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();

        $config = DataObject::get_one(SiteConfig::class);

        if (!$config) {
            self::make_site_config();

            DB::alteration_message("Added default site config", "created");
        }
    }

    /**
     * Create SiteConfig with defaults from language file.
     *
     * @return SiteConfig
     */
    public static function make_site_config()
    {
        $config = SiteConfig::create();
        $config->write();

        return $config;
    }

    /**
     * Can a user view this SiteConfig instance?
     *
     * @param Member $member
     * @return boolean
     */
    public function canView($member = null)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        $extended = $this->extendedCan('canView', $member);
        if ($extended !== null) {
            return $extended;
        }

        // Assuming all that can edit this object can also view it
        return $this->canEdit($member);
    }

    /**
     * Can a user view pages on this site? This method is only
     * called if a page is set to Inherit, but there is nothing
     * to inherit from.
     *
     * @param Member $member
     * @return boolean
     */
    public function canViewPages($member = null)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        if ($member && Permission::checkMember($member, "ADMIN")) {
            return true;
        }

        $extended = $this->extendedCan('canViewPages', $member);
        if ($extended !== null) {
            return $extended;
        }

        if (!$this->CanViewType || $this->CanViewType == 'Anyone') {
            return true;
        }

        // check for any logged-in users
        if ($this->CanViewType === 'LoggedInUsers' && $member) {
            return true;
        }

        // check for specific groups
        if ($this->CanViewType === 'OnlyTheseUsers' && $member && $member->inGroups($this->ViewerGroups())) {
            return true;
        }

        return false;
    }

    /**
     * Can a user edit pages on this site? This method is only
     * called if a page is set to Inherit, but there is nothing
     * to inherit from, or on new records without a parent.
     *
     * @param Member $member
     * @return boolean
     */
    public function canEditPages($member = null)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        if ($member && Permission::checkMember($member, "ADMIN")) {
            return true;
        }

        $extended = $this->extendedCan('canEditPages', $member);
        if ($extended !== null) {
            return $extended;
        }

        // check for any logged-in users with CMS access
        if ($this->CanEditType === 'LoggedInUsers'
            && Permission::checkMember($member, $this->config()->get('required_permission'))
        ) {
            return true;
        }

        // check for specific groups
        if ($this->CanEditType === 'OnlyTheseUsers' && $member && $member->inGroups($this->EditorGroups())) {
            return true;
        }

        return false;
    }

    public function canEdit($member = null)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        $extended = $this->extendedCan('canEdit', $member);
        if ($extended !== null) {
            return $extended;
        }

        return Permission::checkMember($member, "EDIT_SITECONFIG");
    }

    /**
     * @return array
     */
    public function providePermissions()
    {
        return [
            'EDIT_SITECONFIG' => [
                'name' => _t(self::class . '.EDIT_PERMISSION', 'Manage site configuration'),
                'category' => _t(
                    'SilverStripe\\Security\\Permission.PERMISSIONS_CATEGORY',
                    'Roles and access permissions'
                ),
                'help' => _t(
                    self::class . '.EDIT_PERMISSION_HELP',
                    'Ability to edit global access settings/top-level page permissions.'
                ),
                'sort' => 400
            ]
        ];
    }

    /**
     * Can a user create pages in the root of this site?
     *
     * @param Member $member
     * @return boolean
     */
    public function canCreateTopLevel($member = null)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        if ($member && Permission::checkMember($member, "ADMIN")) {
            return true;
        }

        $extended = $this->extendedCan('canCreateTopLevel', $member);
        if ($extended !== null) {
            return $extended;
        }

        // check for any logged-in users with CMS permission
        if ($this->CanCreateTopLevelType === 'LoggedInUsers'
            && Permission::checkMember($member, $this->config()->get('required_permission'))
        ) {
            return true;
        }

        // check for specific groups
        if ($this->CanCreateTopLevelType === 'OnlyTheseUsers'
            && $member
            && $member->inGroups($this->CreateTopLevelGroups())
        ) {
            return true;
        }

        return false;
    }

    /**
     * Add $SiteConfig to all SSViewers
     */
    public static function get_template_global_variables()
    {
        return [
            'SiteConfig' => 'current_site_config',
        ];
    }
}


1			<?php
2
3			namespace Sunnysideup\CMSDarkTheme\Model\Extentions;
4
5			use SilverStripe\CMS\Model\SiteTree;
			0 ignored issues – show Bug introduced 2023-10-24 23:32 UTC by Report Bug Copy Issue Report The type `SilverStripe\CMS\Model\SiteTree` 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 SilverStripe\Forms\FieldList;
7			use SilverStripe\Forms\FormAction;
8			use SilverStripe\Forms\HiddenField;
9			use SilverStripe\Forms\ListboxField;
10			use SilverStripe\Forms\LiteralField;
11			use SilverStripe\Forms\OptionsetField;
12			use SilverStripe\Forms\Tab;
13			use SilverStripe\Forms\TabSet;
14			use SilverStripe\Forms\TextField;
15			use SilverStripe\ORM\DB;
16			use SilverStripe\ORM\DataObject;
17			use SilverStripe\ORM\ManyManyList;
18			use SilverStripe\Security\Group;
19			use SilverStripe\Security\Member;
20			use SilverStripe\Security\Permission;
21			use SilverStripe\Security\PermissionProvider;
22			use SilverStripe\Security\Security;
23			use SilverStripe\View\TemplateGlobalProvider;
24			use SilverStripe\CMS\Controllers\CMSMain;
			0 ignored issues – show Bug introduced 2023-10-24 23:32 UTC by Report Bug Copy Issue Report The type `SilverStripe\CMS\Controllers\CMSMain` 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...
25
26			/**
27			* SiteConfig
28			*
29			* @property string Title Title of the website.
30			* @property string Tagline Tagline of the website.
31			* @property string CanViewType Type of restriction used for view permissions.
32			* @property string CanEditType Type of restriction used for edit permissions.
33			* @property string CanCreateTopLevelType Type of restriction used for creation of root-level pages.
34			* @method ManyManyList ViewerGroups() List of groups that can view SiteConfig.
35			* @method ManyManyList EditorGroups() List of groups that can edit SiteConfig.
36			* @method ManyManyList CreateTopLevelGroups() List of groups that can create root-level pages.
37			*/
38			class SiteConfig extends DataObject implements PermissionProvider, TemplateGlobalProvider
39			{
40			private static $db = [
41			"Title" => "Varchar(255)",
42			"Tagline" => "Varchar(255)",
43			"CanViewType" => "Enum('Anyone, LoggedInUsers, OnlyTheseUsers', 'Anyone')",
44			"CanEditType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
45			"CanCreateTopLevelType" => "Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')",
46			];
47
48			private static $many_many = [
49			"ViewerGroups" => Group::class,
50			"EditorGroups" => Group::class,
51			"CreateTopLevelGroups" => Group::class,
52			];
53
54			private static $defaults = [
55			"CanViewType" => "Anyone",
56			"CanEditType" => "LoggedInUsers",
57			"CanCreateTopLevelType" => "LoggedInUsers",
58			];
59
60			private static $table_name = 'SiteConfig';
61
62			/**
63			* Default permission to check for 'LoggedInUsers' to create or edit pages
64			*
65			* @var array
66			* @config
67			*/
68			private static $required_permission = [
69			'CMS_ACCESS_CMSMain',
70			'CMS_ACCESS_LeftAndMain'
71			];
72
73			public function populateDefaults()
74			{
75			$this->Title = _t(self::class . '.SITENAMEDEFAULT', "Your Site Name");
76			$this->Tagline = _t(self::class . '.TAGLINEDEFAULT', "your tagline here");
77
78			// Allow these defaults to be overridden
79			parent::populateDefaults();
80			}
81
82			/**
83			* Get the fields that are sent to the CMS.
84			*
85			* In your extensions: updateCMSFields($fields).
86			*
87			* @return FieldList
88			*/
89			public function getCMSFields()
90			{
91			$mapFn = function ($groups = []) {
92			$map = [];
93			foreach ($groups as $group) {
94			// Listboxfield values are escaped, use ASCII char instead of »
95			$map[$group->ID] = $group->getBreadcrumbs(' > ');
96			}
97			asort($map);
98			return $map;
99			};
100			$groupsMap = $mapFn(Group::get());
101			$viewAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_VIEW_ALL', 'ADMIN']));
102			$editAllGroupsMap = $mapFn(Permission::get_groups_by_permission(['SITETREE_EDIT_ALL', 'ADMIN']));
103
104			$fields = FieldList::create(
105			TabSet::create(
106			"Root",
107			$tabMain = Tab::create(
108			'Main',
109			$titleField = TextField::create("Title", _t(self::class . '.SITETITLE', "Site title")),
110			$taglineField = TextField::create(
111			"Tagline",
112			_t(self::class . '.SITETAGLINE', "Site Tagline/Slogan")
113			)
114			),
115			$tabAccess = Tab::create(
116			'Access',
117			$viewersOptionsField = OptionsetField::create(
118			"CanViewType",
119			_t(self::class . '.VIEWHEADER', "Who can view pages on this site?")
120			),
121			$viewerGroupsField = ListboxField::create(
122			"ViewerGroups",
123			_t('SilverStripe\\CMS\\Model\\SiteTree.VIEWERGROUPS', "Viewer Groups")
124			)
125			->setSource($groupsMap)
126			->setAttribute(
127			'data-placeholder',
128			_t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
129			),
130			$editorsOptionsField = OptionsetField::create(
131			"CanEditType",
132			_t(self::class . '.EDITHEADER', "Who can edit pages on this site?")
133			),
134			$editorGroupsField = ListboxField::create(
135			"EditorGroups",
136			_t('SilverStripe\\CMS\\Model\\SiteTree.EDITORGROUPS', "Editor Groups")
137			)
138			->setSource($groupsMap)
139			->setAttribute(
140			'data-placeholder',
141			_t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
142			),
143			$topLevelCreatorsOptionsField = OptionsetField::create(
144			"CanCreateTopLevelType",
145			_t(self::class . '.TOPLEVELCREATE', "Who can create pages in the root of the site?")
146			),
147			$topLevelCreatorsGroupsField = ListboxField::create(
148			"CreateTopLevelGroups",
149			_t(self::class . '.TOPLEVELCREATORGROUPS', "Top level creators")
150			)
151			->setSource($groupsMap)
152			->setAttribute(
153			'data-placeholder',
154			_t('SilverStripe\\CMS\\Model\\SiteTree.GroupPlaceholder', 'Click to select group')
155			)
156			)
157			),
158			HiddenField::create('ID')
159			);
160
161			$viewersOptionsSource = [];
162			$viewersOptionsSource["Anyone"] = _t('SilverStripe\\CMS\\Model\\SiteTree.ACCESSANYONE', "Anyone");
163			$viewersOptionsSource["LoggedInUsers"] = _t(
164			'SilverStripe\\CMS\\Model\\SiteTree.ACCESSLOGGEDIN',
165			"Logged-in users"
166			);
167			$viewersOptionsSource["OnlyTheseUsers"] = _t(
168			'SilverStripe\\CMS\\Model\\SiteTree.ACCESSONLYTHESE',
169			"Only these groups (choose from list)"
170			);
171			$viewersOptionsField->setSource($viewersOptionsSource);
172
173			if ($viewAllGroupsMap) {
174			$viewerGroupsField->setDescription(_t(
175			'SilverStripe\\CMS\\Model\\SiteTree.VIEWER_GROUPS_FIELD_DESC',
176			'Groups with global view permissions: {groupList}',
177			['groupList' => implode(', ', array_values($viewAllGroupsMap))]
178			));
179			}
180
181			if ($editAllGroupsMap) {
182			$editorGroupsField->setDescription(_t(
183			'SilverStripe\\CMS\\Model\\SiteTree.EDITOR_GROUPS_FIELD_DESC',
184			'Groups with global edit permissions: {groupList}',
185			['groupList' => implode(', ', array_values($editAllGroupsMap))]
186			));
187			}
188
189			$editorsOptionsSource = [];
190			$editorsOptionsSource["LoggedInUsers"] = _t(
191			'SilverStripe\\CMS\\Model\\SiteTree.EDITANYONE',
192			"Anyone who can log-in to the CMS"
193			);
194			$editorsOptionsSource["OnlyTheseUsers"] = _t(
195			'SilverStripe\\CMS\\Model\\SiteTree.EDITONLYTHESE',
196			"Only these groups (choose from list)"
197			);
198			$editorsOptionsField->setSource($editorsOptionsSource);
199
200			$topLevelCreatorsOptionsField->setSource($editorsOptionsSource);
201
202			if (!Permission::check('EDIT_SITECONFIG')) {
203			$fields->makeFieldReadonly($viewersOptionsField);
204			$fields->makeFieldReadonly($viewerGroupsField);
205			$fields->makeFieldReadonly($editorsOptionsField);
206			$fields->makeFieldReadonly($editorGroupsField);
207			$fields->makeFieldReadonly($topLevelCreatorsOptionsField);
208			$fields->makeFieldReadonly($topLevelCreatorsGroupsField);
209			$fields->makeFieldReadonly($taglineField);
210			$fields->makeFieldReadonly($titleField);
211			}
212
213			if (file_exists(BASE_PATH . '/install.php')) {
214			$fields->addFieldToTab(
215			'Root.Main',
216			LiteralField::create(
217			'InstallWarningHeader',
218			'<div class="alert alert-warning">' . _t(
219			'SilverStripe\\CMS\\Model\\SiteTree.REMOVE_INSTALL_WARNING',
220			'Warning: You should remove install.php from this SilverStripe install for security reasons.'
221			) . '</div>'
222			),
223			'Title'
224			);
225			}
226
227			$tabMain->setTitle(_t(self::class . '.TABMAIN', "Main"));
228			$tabAccess->setTitle(_t(self::class . '.TABACCESS', "Access"));
229			$this->extend('updateCMSFields', $fields);
230
231			return $fields;
232			}
233
234			/**
235			* Get the actions that are sent to the CMS.
236			*
237			* In your extensions: updateEditFormActions($actions)
238			*
239			* @return FieldList
240			*/
241			public function getCMSActions()
242			{
243			if (Permission::check('ADMIN') \|\| Permission::check('EDIT_SITECONFIG')) {
244			$actions = FieldList::create(
245			FormAction::create(
246			'save_siteconfig',
247			_t('SilverStripe\\CMS\\Controllers\\CMSMain.SAVE', 'Save')
248			)->addExtraClass('btn-primary font-icon-save')
249			);
250			} else {
251			$actions = FieldList::create();
252			}
253
254			$this->extend('updateCMSActions', $actions);
255
256			return $actions;
257			}
258
259			/**
260			* @return string
261			*/
262			public function CMSEditLink()
263			{
264			return SiteConfigLeftAndMain::singleton()->Link();
			0 ignored issues – show Bug introduced 2023-10-24 23:34 UTC by Report Bug Copy Issue Report The type `Sunnysideup\CMSDarkTheme...s\SiteConfigLeftAndMain` 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...
265			}
266
267			/**
268			* Get the current sites SiteConfig, and creates a new one through
269			* {@link make_site_config()} if none is found.
270			*
271			* @return SiteConfig
272			*/
273			public static function current_site_config()
274			{
275			/** @var SiteConfig $siteConfig */
276			$siteConfig = DataObject::get_one(SiteConfig::class);
277			if (!$siteConfig) {
			0 ignored issues – show introduced 2023-10-24 23:34 UTC by Report Bug Copy Issue Report `$siteConfig` is of type `Sunnysideup\CMSDarkTheme...l\Extentions\SiteConfig`, thus it always evaluated to `true`. Loading history...
278			$siteConfig = self::make_site_config();
279			}
280
281			static::singleton()->extend('updateCurrentSiteConfig', $siteConfig);
282
283			return $siteConfig;
284			}
285
286			/**
287			* Setup a default SiteConfig record if none exists.
288			*/
289			public function requireDefaultRecords()
290			{
291			parent::requireDefaultRecords();
292
293			$config = DataObject::get_one(SiteConfig::class);
294
295			if (!$config) {
296			self::make_site_config();
297
298			DB::alteration_message("Added default site config", "created");
299			}
300			}
301
302			/**
303			* Create SiteConfig with defaults from language file.
304			*
305			* @return SiteConfig
306			*/
307			public static function make_site_config()
308			{
309			$config = SiteConfig::create();
310			$config->write();
311
312			return $config;
313			}
314
315			/**
316			* Can a user view this SiteConfig instance?
317			*
318			* @param Member $member
319			* @return boolean
320			*/
321			public function canView($member = null)
322			{
323			if (!$member) {
324			$member = Security::getCurrentUser();
325			}
326
327			$extended = $this->extendedCan('canView', $member);
328			if ($extended !== null) {
329			return $extended;
330			}
331
332			// Assuming all that can edit this object can also view it
333			return $this->canEdit($member);
334			}
335
336			/**
337			* Can a user view pages on this site? This method is only
338			* called if a page is set to Inherit, but there is nothing
339			* to inherit from.
340			*
341			* @param Member $member
342			* @return boolean
343			*/
344			public function canViewPages($member = null)
345			{
346			if (!$member) {
347			$member = Security::getCurrentUser();
348			}
349
350			if ($member && Permission::checkMember($member, "ADMIN")) {
351			return true;
352			}
353
354			$extended = $this->extendedCan('canViewPages', $member);
355			if ($extended !== null) {
356			return $extended;
357			}
358
359			if (!$this->CanViewType \|\| $this->CanViewType == 'Anyone') {
360			return true;
361			}
362
363			// check for any logged-in users
364			if ($this->CanViewType === 'LoggedInUsers' && $member) {
365			return true;
366			}
367
368			// check for specific groups
369			if ($this->CanViewType === 'OnlyTheseUsers' && $member && $member->inGroups($this->ViewerGroups())) {
370			return true;
371			}
372
373			return false;
374			}
375
376			/**
377			* Can a user edit pages on this site? This method is only
378			* called if a page is set to Inherit, but there is nothing
379			* to inherit from, or on new records without a parent.
380			*
381			* @param Member $member
382			* @return boolean
383			*/
384			public function canEditPages($member = null)
385			{
386			if (!$member) {
387			$member = Security::getCurrentUser();
388			}
389
390			if ($member && Permission::checkMember($member, "ADMIN")) {
391			return true;
392			}
393
394			$extended = $this->extendedCan('canEditPages', $member);
395			if ($extended !== null) {
396			return $extended;
397			}
398
399			// check for any logged-in users with CMS access
400			if ($this->CanEditType === 'LoggedInUsers'
401			&& Permission::checkMember($member, $this->config()->get('required_permission'))
402			) {
403			return true;
404			}
405
406			// check for specific groups
407			if ($this->CanEditType === 'OnlyTheseUsers' && $member && $member->inGroups($this->EditorGroups())) {
408			return true;
409			}
410
411			return false;
412			}
413
414			public function canEdit($member = null)
415			{
416			if (!$member) {
417			$member = Security::getCurrentUser();
418			}
419
420			$extended = $this->extendedCan('canEdit', $member);
421			if ($extended !== null) {
422			return $extended;
423			}
424
425			return Permission::checkMember($member, "EDIT_SITECONFIG");
426			}
427
428			/**
429			* @return array
430			*/
431			public function providePermissions()
432			{
433			return [
434			'EDIT_SITECONFIG' => [
435			'name' => _t(self::class . '.EDIT_PERMISSION', 'Manage site configuration'),
436			'category' => _t(
437			'SilverStripe\\Security\\Permission.PERMISSIONS_CATEGORY',
438			'Roles and access permissions'
439			),
440			'help' => _t(
441			self::class . '.EDIT_PERMISSION_HELP',
442			'Ability to edit global access settings/top-level page permissions.'
443			),
444			'sort' => 400
445			]
446			];
447			}
448
449			/**
450			* Can a user create pages in the root of this site?
451			*
452			* @param Member $member
453			* @return boolean
454			*/
455			public function canCreateTopLevel($member = null)
456			{
457			if (!$member) {
458			$member = Security::getCurrentUser();
459			}
460
461			if ($member && Permission::checkMember($member, "ADMIN")) {
462			return true;
463			}
464
465			$extended = $this->extendedCan('canCreateTopLevel', $member);
466			if ($extended !== null) {
467			return $extended;
468			}
469
470			// check for any logged-in users with CMS permission
471			if ($this->CanCreateTopLevelType === 'LoggedInUsers'
472			&& Permission::checkMember($member, $this->config()->get('required_permission'))
473			) {
474			return true;
475			}
476
477			// check for specific groups
478			if ($this->CanCreateTopLevelType === 'OnlyTheseUsers'
479			&& $member
480			&& $member->inGroups($this->CreateTopLevelGroups())
481			) {
482			return true;
483			}
484
485			return false;
486			}
487
488			/**
489			* Add $SiteConfig to all SSViewers
490			*/
491			public static function get_template_global_variables()
492			{
493			return [
494			'SiteConfig' => 'current_site_config',
495			];
496			}
497			}
498

sunnysideup / silverstripe-cms-dark-theme

Push — main ( d6316c...aeb638 )

SiteConfig::getCMSFields() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like