Setting::get_template_global_variables() - Code Metrics - Inspection of "Created basic settings object (#12)" - dynamic/silverstripe-foxy - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 10ae60...7eadc4 )

by Matthew

created 2019-05-14 01:48 UTC

Setting::get_template_global_variables() A

↳ Parent: Setting

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Dynamic\Foxy\Model;

use Dynamic\Foxy\Admin\FoxyAdmin;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\ValidationException;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Security\Security;
use SilverStripe\View\TemplateGlobalProvider;

/**
 * Class Setting
 * @package Dynamic\Foxy\Model
 *
 * @property string $StoreKey
 * @property string $StoreTitle
 * @property string $StoreDomain
 */
class Setting extends DataObject implements PermissionProvider, TemplateGlobalProvider
{
    /**
     * @var string
     */
    private static $singular_name = 'Foxy Setting';


    /**
     * @var string
     */
    private static $plural_name = 'Foxy Settings';


    /**
     * @var string
     */
    private static $description = 'Update the settings for your store';


    /**
     * @var string
     */
    private static $table_name = 'FoxySetting';


    /**
     * @var string
     */
    private static $keyPrefix = "dYnm1c";


    /**
     * @var array
     */
    private static $db = [

        'StoreKey' => 'Varchar(60)',
        'StoreTitle' => 'Varchar(255)',
        'StoreDomain' => 'Varchar(255)',
        // TODO
    ];

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


    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {
            // TODO
            $fields->addFieldsToTab('Root.Main', [
                TextField::create('StoreTitle', 'Store Title')
                    ->setDescription('The name of your store as you\'d like it displayed to your customers'),
                TextField::create('StoreDomain', 'Store Domain')
                    ->setDescription('This is a unique FoxyCart subdomain for your cart, checkout, and receipt'),
            ]);

            $fields->addFieldsToTab('Root.Advanced', [
                ReadonlyField::create('StoreKey', 'Store Key', $this->StoreKey),
            ]);
        });

        return parent::getCMSFields();
    }

    /**
     * @return FieldList
     */
    public function getCMSActions()
    {
        if (Permission::check('ADMIN') || Permission::check('EDIT_FOXY_SETTING')) {
            $actions = new FieldList(
                FormAction::create('save_foxy_setting', _t(static::class . '.SAVE', 'Save'))
                    ->addExtraClass('btn-primary font-icon-save')
            );
        } else {
            $actions = FieldList::create();
        }
        $this->extend('updateCMSActions', $actions);
        return $actions;
    }

    /**
     *
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        if (!self::current_foxy_setting()) {
            self::make_foxy_setting();
            DB::alteration_message('Added default FoxyStripe Setting', 'created');
        }
    }

    /**
     *
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if (!$this->StoreKey) {
            $key = $this->generateStoreKey();
            while (!ctype_alnum($key)) {
                $key = $this->generateStoreKey();
            }
            $this->StoreKey = $key;
            DB::alteration_message('Created FoxyCart Store Key ' . $key, 'created');
        }
    }

    /**
     * @param int $count
     * @return string
     */
    public function generateStoreKey($count = 0)
    {
        $length = $this->obj('StoreKey')->getSize() - strlen($this->config()->get('keyPrefix'));
        $charset = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789' . strtotime('now');
        $strLength = strlen($charset);
        $str = '';

        while ($count < $length) {
            $str .= $charset[mt_rand(0, $strLength - 1)];
            $count++;
        }
        return $this->config()->get('keyPrefix') . substr(base64_encode($str), 0, $length);
    }

    /**
     * @return string
     */
    public function CMSEditLink()
    {
        return FoxyAdmin::singleton()->Link();
    }

    /**
     * @param \SilverStripe\Security\Member|null $member
     *
     * @return bool|int|null
     */
    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_FOXY_SETTING');
    }

    /**
     * @return array
     */
    public function providePermissions()
    {
        return [
            'EDIT_FOXY_SETTING' => [
                'name' => _t(
                    static::class . '.EDIT_FOXY_SETTING',
                    'Manage FoxyStripe settings'
                ),
                'category' => _t(
                    static::class . '.PERMISSIONS_FOXY_SETTING',
                    'FoxyStripe'
                ),
                'help' => _t(
                    static::class . '.EDIT_PERMISSION_FOXY_SETTING',
                    'Ability to edit the settings of a FoxyStripe Store.'
                ),
                'sort' => 400,
            ],
        ];
    }

    /**
     * Get the current sites {@link GlobalSiteSetting}, and creates a new one
     * through {@link make_global_config()} if none is found.
     *
     * @return self|DataObject
     */
    public static function current_foxy_setting()
    {
        if ($config = self::get()->first()) {
            return $config;
        }
        return self::make_foxy_setting();
    }

    /**
     * Create {@link GlobalSiteSetting} with defaults from language file.
     *
     * @return self
     */
    public static function make_foxy_setting()
    {
        $config = self::create();
        try {
            $config->write();
        } catch (ValidationException $e) {

        }
        return $config;
    }

    /**
     * Add $GlobalConfig to all SSViewers.
     *
     * @return array
     */
    public static function get_template_global_variables()
    {
        return [
            'FoxyStripe' => 'current_foxy_setting',
        ];
    }
}


1			<?php
2
3			namespace Dynamic\Foxy\Model;
4
5			use Dynamic\Foxy\Admin\FoxyAdmin;
6			use SilverStripe\Forms\FieldList;
7			use SilverStripe\Forms\FormAction;
8			use SilverStripe\Forms\ReadonlyField;
9			use SilverStripe\Forms\TextField;
10			use SilverStripe\ORM\DataObject;
11			use SilverStripe\ORM\DB;
12			use SilverStripe\ORM\ValidationException;
13			use SilverStripe\Security\Permission;
14			use SilverStripe\Security\PermissionProvider;
15			use SilverStripe\Security\Security;
16			use SilverStripe\View\TemplateGlobalProvider;
17
18			/**
19			* Class Setting
20			* @package Dynamic\Foxy\Model
21			*
22			* @property string $StoreKey
23			* @property string $StoreTitle
24			* @property string $StoreDomain
25			*/
26			class Setting extends DataObject implements PermissionProvider, TemplateGlobalProvider
27			{
28			/**
29			* @var string
30			*/
31			private static $singular_name = 'Foxy Setting';
			0 ignored issues – show introduced 2019-05-09 21:09 UTC by Report Bug Copy Issue Report The private property `$singular_name` is not used, and could be removed. Loading history...
32
33			/**
34			* @var string
35			*/
36			private static $plural_name = 'Foxy Settings';
			0 ignored issues – show introduced 2019-05-09 21:09 UTC by Report Bug Copy Issue Report The private property `$plural_name` is not used, and could be removed. Loading history...
37
38			/**
39			* @var string
40			*/
41			private static $description = 'Update the settings for your store';
			0 ignored issues – show introduced 2019-05-09 21:09 UTC by Report Bug Copy Issue Report The private property `$description` is not used, and could be removed. Loading history...
42
43			/**
44			* @var string
45			*/
46			private static $table_name = 'FoxySetting';
			0 ignored issues – show introduced 2019-05-13 14:28 UTC by Report Bug Copy Issue Report The private property `$table_name` is not used, and could be removed. Loading history...
47
48			/**
49			* @var string
50			*/
51			private static $keyPrefix = "dYnm1c";
			0 ignored issues – show introduced 2019-05-09 21:09 UTC by Report Bug Copy Issue Report The private property `$keyPrefix` is not used, and could be removed. Loading history...
52
53			/**
54			* @var array
55			*/
56			private static $db = [
			0 ignored issues – show introduced 2019-05-14 01:50 UTC by Report Bug Copy Issue Report The private property `$db` is not used, and could be removed. Loading history...
57			'StoreKey' => 'Varchar(60)',
58			'StoreTitle' => 'Varchar(255)',
59			'StoreDomain' => 'Varchar(255)',
60			// TODO
61			];
62
63			/**
64			* Default permission to check for 'LoggedInUsers' to create or edit pages.
65			*
66			* @var array
67			* @config
68			*/
69			private static $required_permission = ['CMS_ACCESS_CMSMain', 'CMS_ACCESS_LeftAndMain'];
			0 ignored issues – show introduced 2019-05-09 21:09 UTC by Report Bug Copy Issue Report The private property `$required_permission` is not used, and could be removed. Loading history...
70
71			/**
72			* @return FieldList
73			*/
74			public function getCMSFields()
75			{
76			$this->beforeUpdateCMSFields(function (FieldList $fields) {
77			// TODO
78			$fields->addFieldsToTab('Root.Main', [
79			TextField::create('StoreTitle', 'Store Title')
80			->setDescription('The name of your store as you\'d like it displayed to your customers'),
81			TextField::create('StoreDomain', 'Store Domain')
82			->setDescription('This is a unique FoxyCart subdomain for your cart, checkout, and receipt'),
83			]);
84
85			$fields->addFieldsToTab('Root.Advanced', [
86			ReadonlyField::create('StoreKey', 'Store Key', $this->StoreKey),
87			]);
88			});
89
90			return parent::getCMSFields();
91			}
92
93			/**
94			* @return FieldList
95			*/
96			public function getCMSActions()
97			{
98			if (Permission::check('ADMIN') \|\| Permission::check('EDIT_FOXY_SETTING')) {
99			$actions = new FieldList(
100			FormAction::create('save_foxy_setting', _t(static::class . '.SAVE', 'Save'))
101			->addExtraClass('btn-primary font-icon-save')
102			);
103			} else {
104			$actions = FieldList::create();
105			}
106			$this->extend('updateCMSActions', $actions);
107			return $actions;
108			}
109
110			/**
111			*
112			*/
113			public function requireDefaultRecords()
114			{
115			parent::requireDefaultRecords();
116			if (!self::current_foxy_setting()) {
117			self::make_foxy_setting();
118			DB::alteration_message('Added default FoxyStripe Setting', 'created');
119			}
120			}
121
122			/**
123			*
124			*/
125			public function onBeforeWrite()
126			{
127			parent::onBeforeWrite();
128			if (!$this->StoreKey) {
129			$key = $this->generateStoreKey();
130			while (!ctype_alnum($key)) {
131			$key = $this->generateStoreKey();
132			}
133			$this->StoreKey = $key;
134			DB::alteration_message('Created FoxyCart Store Key ' . $key, 'created');
135			}
136			}
137
138			/**
139			* @param int $count
140			* @return string
141			*/
142			public function generateStoreKey($count = 0)
143			{
144			$length = $this->obj('StoreKey')->getSize() - strlen($this->config()->get('keyPrefix'));
145			$charset = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789' . strtotime('now');
146			$strLength = strlen($charset);
147			$str = '';
148
149			while ($count < $length) {
150			$str .= $charset[mt_rand(0, $strLength - 1)];
151			$count++;
152			}
153			return $this->config()->get('keyPrefix') . substr(base64_encode($str), 0, $length);
154			}
155
156			/**
157			* @return string
158			*/
159			public function CMSEditLink()
160			{
161			return FoxyAdmin::singleton()->Link();
162			}
163
164			/**
165			* @param \SilverStripe\Security\Member\|null $member
166			*
167			* @return bool\|int\|null
168			*/
169			public function canEdit($member = null)
170			{
171			if (!$member) {
172			$member = Security::getCurrentUser();
173			}
174			$extended = $this->extendedCan('canEdit', $member);
175			if ($extended !== null) {
176			return $extended;
177			}
178			return Permission::checkMember($member, 'EDIT_FOXY_SETTING');
179			}
180
181			/**
182			* @return array
183			*/
184			public function providePermissions()
185			{
186			return [
187			'EDIT_FOXY_SETTING' => [
188			'name' => _t(
189			static::class . '.EDIT_FOXY_SETTING',
190			'Manage FoxyStripe settings'
191			),
192			'category' => _t(
193			static::class . '.PERMISSIONS_FOXY_SETTING',
194			'FoxyStripe'
195			),
196			'help' => _t(
197			static::class . '.EDIT_PERMISSION_FOXY_SETTING',
198			'Ability to edit the settings of a FoxyStripe Store.'
199			),
200			'sort' => 400,
201			],
202			];
203			}
204
205			/**
206			* Get the current sites {@link GlobalSiteSetting}, and creates a new one
207			* through {@link make_global_config()} if none is found.
208			*
209			* @return self\|DataObject
210			*/
211			public static function current_foxy_setting()
212			{
213			if ($config = self::get()->first()) {
214			return $config;
215			}
216			return self::make_foxy_setting();
217			}
218
219			/**
220			* Create {@link GlobalSiteSetting} with defaults from language file.
221			*
222			* @return self
223			*/
224			public static function make_foxy_setting()
225			{
226			$config = self::create();
227			try {
228			$config->write();
229			} catch (ValidationException $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2019-05-09 21:09 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
230			}
231			return $config;
232			}
233
234			/**
235			* Add $GlobalConfig to all SSViewers.
236			*
237			* @return array
238			*/
239			public static function get_template_global_variables()
240			{
241			return [
242			'FoxyStripe' => 'current_foxy_setting',
243			];
244			}
245			}
246

dynamic / silverstripe-foxy

Push — master ( 10ae60...7eadc4 )

Setting::get_template_global_variables() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like