Location::fieldLabels() - Code Metrics - Inspection of "Update composer.json" - dynamic/silverstripe-locator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#167)

by Jason

created 2017-06-21 03:02 UTC

Location::fieldLabels() A

↳ Parent: Location

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	14
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	14
nc	1
nop	1
crap	2

<?php

/**
 * Class Location
 *
 * @property string $Title
 * @property bool $Featured
 * @property string $Website
 * @property string $Phone
 * @property string $Email
 * @property string $EmailAddress
 * @property bool $ShowInLocator
 * @property int $Import_ID
 * @property int $CategoryID
 * @method LocationCategory $Category
 */
class Location extends DataObject implements PermissionProvider
{

    /**
     * @var array
     */
    private static $db = array(
        'Title' => 'Varchar(255)',
        'Featured' => 'Boolean',
        'Website' => 'Varchar(255)',
        'Phone' => 'Varchar(40)',
        'Email' => 'Varchar(255)',
        'EmailAddress' => 'Varchar(255)',
        'ShowInLocator' => 'Boolean',
        'Import_ID' => 'Int',
    );

    /**
     * @var array
     */
    private static $has_one = array(
        'Category' => 'LocationCategory',
    );

    /**
     * @var array
     */
    private static $casting = array(
        'distance' => 'Decimal(9,3)',
    );

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


    /**
     * @var array
     */
    private static $defaults = array(
        'ShowInLocator' => true,
    );

    /**
     * @var string
     */
    private static $singular_name = 'Location';
    /**
     * @var string
     */
    private static $plural_name = 'Locations';

    /**
     * api access via Restful Server module
     *
     * @var bool
     */
    private static $api_access = true;


    /**
     * search fields for Model Admin
     *
     * @var array
     */
    private static $searchable_fields = array(
        'Title',
        'Address',
        'Suburb',
        'State',
        'Postcode',
        'Country',
        'Website',
        'Phone',
        'Email',
        'Category.ID',
        'Featured',
    );

    /**
     * columns for grid field
     *
     * @var array
     */
    private static $summary_fields = array(
        'Title',
        'Address',
        'Suburb',
        'State',
        'Postcode',
        'Country',
        'Category.Name',
        'Featured.NiceAsBoolean',
        'Coords',
    );

    /**
     * @var array
     */
    private static $extensions = [
        'VersionedDataObject',
    ];

    /**
     * Coords status for $summary_fields
     *
     * @return string
     */
    public function getCoords()
    {
        return ($this->Lat != 0 && $this->Lng != 0) ? 'true' : 'false';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

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

        $labels['Title'] = 'Name';
        $labels['Suburb'] = 'City';
        $labels['Postcode'] = 'Postal Code';
        $labels['ShowInLocator'] = 'Show';
        $labels['ShowInLocator.NiceAsBoolean'] = 'Show';
        $labels['Category.Name'] = 'Category';
        $labels['Category.ID'] = 'Category';
        $labels['Email'] = 'Email';
        $labels['Featured.NiceAsBoolean'] = 'Featured';
        $labels['Coords'] = 'Coords';
        $labels['Import_ID'] = 'Import_ID';

        return $labels;
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = FieldList::create(
            new TabSet(
                $name = 'Root',
                new Tab(
                    $title = 'Main',
                    HeaderField::create('ContactHD', 'Contact Information'),
                    TextField::create('Title', 'Name'),
                    TextField::create('Phone'),
                    EmailField::create('Email', 'Email'),
                    TextField::create('Website')
                        ->setAttribute('placeholder', 'http://'),
                    DropdownField::create('CategoryID', 'Category', LocationCategory::get()->map('ID', 'Title'))
                        ->setEmptyString('-- select --'),
                    CheckboxField::create('Featured')
                        ->setDescription('Location will show at/near the top of the results list')
                )
            )
        );

        // allow to be extended via DataExtension
        $this->extend('updateCMSFields', $fields);

        $fields->removeByName([
            'ShowInLocator',
            'Import_ID',
        ]);

        // override Suburb field name
        $fields->dataFieldByName('Suburb')->setTitle('City');

        return $fields;
    }

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

        return $result;
    }

    /**
     * @return bool|string
     */
    public function EmailAddress()
    {
        Deprecation::notice('3.0', 'Use "$Email" instead.');
        if ($this->Email) {
            return $this->Email;
        } elseif ($this->EmailAddress) {
            return $this->EmailAddress;
        }

        return false;
    }

    /**
     * @param null|Member $member
     *
     * @return bool
     */
    public function canView($member = null)
    {
        return true;
    }

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

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

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

    /**
     * @return array
     */
    public function providePermissions()
    {
        return array(
            'Location_EDIT' => 'Edit a Location',
            'Location_DELETE' => 'Delete a Location',
            'Location_CREATE' => 'Create a Location',
        );
    }

}


1			<?php
2
3			/**
4			* Class Location
5			*
6			* @property string $Title
7			* @property bool $Featured
8			* @property string $Website
9			* @property string $Phone
10			* @property string $Email
11			* @property string $EmailAddress
12			* @property bool $ShowInLocator
13			* @property int $Import_ID
14			* @property int $CategoryID
15			* @method LocationCategory $Category
16			*/
17			class Location extends DataObject implements PermissionProvider
18			{
19
20			/**
21			* @var array
22			*/
23			private static $db = array(
24			'Title' => 'Varchar(255)',
25			'Featured' => 'Boolean',
26			'Website' => 'Varchar(255)',
27			'Phone' => 'Varchar(40)',
28			'Email' => 'Varchar(255)',
29			'EmailAddress' => 'Varchar(255)',
30			'ShowInLocator' => 'Boolean',
31			'Import_ID' => 'Int',
32			);
33
34			/**
35			* @var array
36			*/
37			private static $has_one = array(
38			'Category' => 'LocationCategory',
39			);
40
41			/**
42			* @var array
43			*/
44			private static $casting = array(
45			'distance' => 'Decimal(9,3)',
46			);
47
48			/**
49			* @var string
50			*/
51			private static $default_sort = 'Title';
			0 ignored issues – show Unused Code introduced 2016-03-15 21:20 UTC by Report Bug Copy Issue Report The property `$default_sort` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
52
53			/**
54			* @var array
55			*/
56			private static $defaults = array(
57			'ShowInLocator' => true,
58			);
59
60			/**
61			* @var string
62			*/
63			private static $singular_name = 'Location';
64			/**
65			* @var string
66			*/
67			private static $plural_name = 'Locations';
68
69			/**
70			* api access via Restful Server module
71			*
72			* @var bool
73			*/
74			private static $api_access = true;
			0 ignored issues – show Unused Code introduced 2016-03-15 21:20 UTC by Report Bug Copy Issue Report The property `$api_access` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
75
76			/**
77			* search fields for Model Admin
78			*
79			* @var array
80			*/
81			private static $searchable_fields = array(
82			'Title',
83			'Address',
84			'Suburb',
85			'State',
86			'Postcode',
87			'Country',
88			'Website',
89			'Phone',
90			'Email',
91			'Category.ID',
92			'Featured',
93			);
94
95			/**
96			* columns for grid field
97			*
98			* @var array
99			*/
100			private static $summary_fields = array(
101			'Title',
102			'Address',
103			'Suburb',
104			'State',
105			'Postcode',
106			'Country',
107			'Category.Name',
108			'Featured.NiceAsBoolean',
109			'Coords',
110			);
111
112			/**
113			* @var array
114			*/
115			private static $extensions = [
116			'VersionedDataObject',
117			];
118
119			/**
120			* Coords status for $summary_fields
121			*
122			* @return string
123			*/
124			public function getCoords()
125			{
126			return ($this->Lat != 0 && $this->Lng != 0) ? 'true' : 'false';
			0 ignored issues – show Documentation introduced 2016-03-15 20:52 UTC by Report Bug Copy Issue Report The property `Lat` does not exist on `object<Location>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-03-15 20:52 UTC by Report Bug Copy Issue Report The property `Lng` does not exist on `object<Location>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
127			}
128
129			/**
130			* custom labels for fields
131			*
132			* @param bool $includerelations
133			* @return array\|string
134			*/
135			public function fieldLabels($includerelations = true)
136			{
137			$labels = parent::fieldLabels($includerelations);
138
139			$labels['Title'] = 'Name';
140			$labels['Suburb'] = 'City';
141			$labels['Postcode'] = 'Postal Code';
142			$labels['ShowInLocator'] = 'Show';
143			$labels['ShowInLocator.NiceAsBoolean'] = 'Show';
144			$labels['Category.Name'] = 'Category';
145			$labels['Category.ID'] = 'Category';
146			$labels['Email'] = 'Email';
147			$labels['Featured.NiceAsBoolean'] = 'Featured';
148			$labels['Coords'] = 'Coords';
149			$labels['Import_ID'] = 'Import_ID';
150
151			return $labels;
152			}
153
154			/**
155			* @return FieldList
156			*/
157			public function getCMSFields()
158			{
159			$fields = FieldList::create(
160			new TabSet(
161			$name = 'Root',
162			new Tab(
163			$title = 'Main',
164			HeaderField::create('ContactHD', 'Contact Information'),
165			TextField::create('Title', 'Name'),
166			TextField::create('Phone'),
167			EmailField::create('Email', 'Email'),
168			TextField::create('Website')
169			->setAttribute('placeholder', 'http://'),
170			DropdownField::create('CategoryID', 'Category', LocationCategory::get()->map('ID', 'Title'))
171			->setEmptyString('-- select --'),
172			CheckboxField::create('Featured')
173			->setDescription('Location will show at/near the top of the results list')
174			)
175			)
176			);
177
178			// allow to be extended via DataExtension
179			$this->extend('updateCMSFields', $fields);
180
181			$fields->removeByName([
182			'ShowInLocator',
183			'Import_ID',
184			]);
185
186			// override Suburb field name
187			$fields->dataFieldByName('Suburb')->setTitle('City');
188
189			return $fields;
190			}
191
192			/**
193			* @return ValidationResult
194			*/
195			public function validate()
196			{
197			$result = parent::validate();
198
199			return $result;
200			}
201
202			/**
203			* @return bool\|string
204			*/
205			public function EmailAddress()
206			{
207			Deprecation::notice('3.0', 'Use "$Email" instead.');
208			if ($this->Email) {
209			return $this->Email;
210			} elseif ($this->EmailAddress) {
211			return $this->EmailAddress;
212			}
213
214			return false;
215			}
216
217			/**
218			* @param null\|Member $member
219			*
220			* @return bool
221			*/
222			public function canView($member = null)
223			{
224			return true;
225			}
226
227			/**
228			* @param null\|Member $member
229			* @return bool\|int
230			*/
231			public function canEdit($member = null)
232			{
233			return Permission::check('Location_EDIT', 'any', $member);
234			}
235
236			/**
237			* @param null\|Member $member
238			* @return bool\|int
239			*/
240			public function canDelete($member = null)
241			{
242			return Permission::check('Location_DELETE', 'any', $member);
243			}
244
245			/**
246			* @param null\|Member $member
247			* @return bool\|int
248			*/
249			public function canCreate($member = null)
250			{
251			return Permission::check('Location_CREATE', 'any', $member);
252			}
253
254			/**
255			* @return array
256			*/
257			public function providePermissions()
258			{
259			return array(
260			'Location_EDIT' => 'Edit a Location',
261			'Location_DELETE' => 'Delete a Location',
262			'Location_CREATE' => 'Create a Location',
263			);
264			}
265
266			}
267

dynamic / silverstripe-locator

Pull Request — 2.0 (#167)

Location::fieldLabels() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like