JobSection::fieldLabels() - Code Metrics - Inspection of "PermissionProvider - consolidate to MANAGE_JOBS pe..." - dynamic/silverstripe-jobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Jason

created 2019-05-02 21:10 UTC

JobSection::fieldLabels() A

↳ Parent: JobSection

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	1
dl	0
loc	8
ccs	0
cts	0
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

namespace Dynamic\Jobs\Model;

use Dynamic\Jobs\Page\Job;
use SilverStripe\Forms\FieldList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Permission;

/**
 * Class JobSection
 * @package Dynamic\Jobs\Model
 */
class JobSection extends DataObject
{
    /**
     * @var string
     */
    private static $table_name = 'Dynamic_JobSection';


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

        'Name' => 'Varchar(255)',
        'Title' => 'Varchar(255)',
        'Content' => 'HTMLText',
        'Sort' => 'Int',
    ];

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

        'Job' => Job::class,
    ];

    /**
     * @var string
     */
    private static $default_sort = 'Sort';


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

        'Name' => 'Name',
        'Title' => 'Title',
    ];

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

        'Name',
        'Title',
        'Content',
    ];

    /**
     * @param bool $includerelations
     * @return array
     */
    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels($includerelations);

        $labels['Name'] = _t(__CLASS__ . '.NameLabel', 'Name');
        $labels['Title'] = _t(__CLASS__ . '.TitleLabel', 'Title');

        return $labels;
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->removeByName([
            'Sort',
            'JobID',
        ]);

        $fields->dataFieldByName('Name')->setDescription('For internal reference only');

        return $fields;
    }

    /**
     * @return ValidationResult
     */
    public function validate()
    {
        $result = parent::validate();

        if (!$this->Name) {

            $result->addError('Name is required before you can save');
        }

        return $result;
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canEdit($member = null)
    {
        return Permission::check('JOB_MANAGE', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canDelete($member = null)
    {
        return Permission::check('JOB_MANAGE', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canCreate($member = null, $context = [])
    {
        return Permission::check('JOB_MANAGE', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool
     */
    public function canView($member = null)
    {
        return Permission::check('JOB_MANAGE', 'any', $member);
    }
}


1		<?php
2
3		namespace Dynamic\Jobs\Model;
4
5		use Dynamic\Jobs\Page\Job;
6		use SilverStripe\Forms\FieldList;
7		use SilverStripe\ORM\DataObject;
8		use SilverStripe\ORM\ValidationResult;
9		use SilverStripe\Security\Permission;
10
11		/**
12		* Class JobSection
13		* @package Dynamic\Jobs\Model
14		*/
15		class JobSection extends DataObject
16		{
17		/**
18		* @var string
19		*/
20		private static $table_name = 'Dynamic_JobSection';
		0 ignored issues – show introduced 2017-12-08 21:51 UTC by Report Bug Copy Issue Report The private property `$table_name` is not used, and could be removed. Loading history...
21
22		/**
23		* @var array
24		*/
25		private static $db = [
		0 ignored issues – show introduced 2017-11-14 20:45 UTC by Report Bug Copy Issue Report The private property `$db` is not used, and could be removed. Loading history...
26		'Name' => 'Varchar(255)',
27		'Title' => 'Varchar(255)',
28		'Content' => 'HTMLText',
29		'Sort' => 'Int',
30		];
31
32		/**
33		* @var array
34		*/
35		private static $has_one = [
		0 ignored issues – show introduced 2018-02-08 21:24 UTC by Report Bug Copy Issue Report The private property `$has_one` is not used, and could be removed. Loading history...
36		'Job' => Job::class,
37		];
38
39		/**
40		* @var string
41		*/
42		private static $default_sort = 'Sort';
		0 ignored issues – show introduced 2017-11-14 20:45 UTC by Report Bug Copy Issue Report The private property `$default_sort` is not used, and could be removed. Loading history...
43
44		/**
45		* @var array
46		*/
47		private static $summary_fields = [
		0 ignored issues – show introduced 2018-02-08 21:24 UTC by Report Bug Copy Issue Report The private property `$summary_fields` is not used, and could be removed. Loading history...
48		'Name' => 'Name',
49		'Title' => 'Title',
50		];
51
52		/**
53		* @var array
54		*/
55		private static $searchable_fields = [
		0 ignored issues – show introduced 2018-02-08 21:24 UTC by Report Bug Copy Issue Report The private property `$searchable_fields` is not used, and could be removed. Loading history...
56		'Name',
57		'Title',
58		'Content',
59		];
60
61		/**
62		* @param bool $includerelations
63		* @return array
64		*/
65		public function fieldLabels($includerelations = true)
66		{
67		$labels = parent::fieldLabels($includerelations);
68
69		$labels['Name'] = _t(__CLASS__ . '.NameLabel', 'Name');
70		$labels['Title'] = _t(__CLASS__ . '.TitleLabel', 'Title');
71
72		return $labels;
73		}
74	1
75		/**
76	1	* @return FieldList
77		*/
78	1	public function getCMSFields()
79	1	{
80		$fields = parent::getCMSFields();
81
82		$fields->removeByName([
83	1	'Sort',
84		'JobID',
85	1	]);
86
87		$fields->dataFieldByName('Name')->setDescription('For internal reference only');
88
89		return $fields;
90		}
91	1
92		/**
93	1	* @return ValidationResult
94		*/
95	1	public function validate()
96	1	{
97		$result = parent::validate();
98
99	1	if (!$this->Name) {
		0 ignored issues – show Bug Best Practice introduced 2017-11-14 20:45 UTC by Report Bug Copy Issue Report The property `Name` does not exist on `Dynamic\Jobs\Model\JobSection`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
100		$result->addError('Name is required before you can save');
101		}
102
103		return $result;
104		}
105
106		/**
107	1	* @param null $member
		0 ignored issues – show Documentation Bug introduced 2017-11-14 20:45 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$member` is correct as it would always require `null` to be passed? Loading history...
108		*
109	1	* @return bool\|int
110		*/
111		public function canEdit($member = null)
112		{
113		return Permission::check('JOB_MANAGE', 'any', $member);
114		}
115
116		/**
117	1	* @param null $member
		0 ignored issues – show Documentation Bug introduced 2017-11-14 20:45 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$member` is correct as it would always require `null` to be passed? Loading history...
118		*
119	1	* @return bool\|int
120		*/
121		public function canDelete($member = null)
122		{
123		return Permission::check('JOB_MANAGE', 'any', $member);
124		}
125
126		/**
127	1	* @param null $member
		0 ignored issues – show Documentation Bug introduced 2017-11-14 20:45 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$member` is correct as it would always require `null` to be passed? Loading history...
128		*
129	1	* @return bool\|int
130		*/
131		public function canCreate($member = null, $context = [])
132		{
133		return Permission::check('JOB_MANAGE', 'any', $member);
134		}
135
136		/**
137	2	* @param null $member
		0 ignored issues – show Documentation Bug introduced 2017-11-14 20:45 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$member` is correct as it would always require `null` to be passed? Loading history...
138		*
139	2	* @return bool
140		*/
141		public function canView($member = null)
142		{
143		return Permission::check('JOB_MANAGE', 'any', $member);
144		}
145		}
146

dynamic / silverstripe-jobs

Pull Request — master (#15)

JobSection::fieldLabels() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like