RecommendedSearchPlusSection::getCMSFields() - Code Metrics - sunnysideup/silverstripe-searchplus - Measure and Improve Code Quality continuously with Scrutinizer

RecommendedSearchPlusSection::getCMSFields() A
last analyzed 2018-03-20 01:29 UTC

↳ Parent: RecommendedSearchPlusSection

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
c	0
b	0
f	0
rs	9.4285
cc	1
eloc	6
nc	1
nop	0

<?php
/**
 *@author: nicolaas[at]sunnysideup.co.nz
 *@description:
 * a log history and counted history of searches done (e.g. 100 people searched for "sunshine")
 * it allows gives the opportunity to link zero or more pages to a particular search phrase
 *
 *
 *
 **/

class RecommendedSearchPlusSection extends DataObject
namespace YourVendor;

class YourClass { }
{
    private static $db = array(

        "Title" => "Varchar(255)",
        "Intro" => "Text",
        "Sort" => "Int"
    );

    private static $has_one = array(

        "ParentPage" => "Page",
        "Parent" => "SearchPlusPage"
    );

    private static $defaults = array(

        "Sort" => 100
    );

    private static $singular_name = 'Recommended SearchPlus Section';


    private static $plural_name = 'Recommended SearchPlus Sections';


    private static $default_sort = 'Sort, Title';


    private static $searchable_fields = array(

        "Title"
    );

    private static $summary_fields = array(

        "Title", "Sort"
    );

    private static $field_labels = array(

        "Sort" => "Sort Index"
    );

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName("ParentPageID");
        $fields->removeByName("ParentID");
        $fields->addFieldToTab("Root.Main", new TreeDropdownField($name = "ParentPageID", $title = "Parent Page (show all child pages as links for this recommended section)", $sourceObject = "SiteTree"));
        return $fields;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if (!$this->ParentID) {
<?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 ($page = SearchPlusPage::get()->first()) {
                $this->ParentID = $page->ID;
<?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.");
        }
    }

}
            } else {
                user_error("Make sure to create a SearchPlusPage", E_USER_NOTICE);
            }
        }
    }
}


1			<?php
2			/**
3			*@author: nicolaas[at]sunnysideup.co.nz
4			*@description:
5			* a log history and counted history of searches done (e.g. 100 people searched for "sunshine")
6			* it allows gives the opportunity to link zero or more pages to a particular search phrase
7			*
8			*
9			*
10			**/
11
12			class RecommendedSearchPlusSection extends DataObject
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
13			{
14			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$db` 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...
15			"Title" => "Varchar(255)",
16			"Intro" => "Text",
17			"Sort" => "Int"
18			);
19
20			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$has_one` 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...
21			"ParentPage" => "Page",
22			"Parent" => "SearchPlusPage"
23			);
24
25			private static $defaults = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$defaults` 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...
26			"Sort" => 100
27			);
28
29			private static $singular_name = 'Recommended SearchPlus Section';
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$singular_name` 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...
30
31			private static $plural_name = 'Recommended SearchPlus Sections';
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$plural_name` 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...
32
33			private static $default_sort = 'Sort, Title';
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 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...
34
35			private static $searchable_fields = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$searchable_fields` 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...
36			"Title"
37			);
38
39			private static $summary_fields = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$summary_fields` 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...
40			"Title", "Sort"
41			);
42
43			private static $field_labels = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `$field_labels` 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...
44			"Sort" => "Sort Index"
45			);
46
47			public function getCMSFields()
48			{
49			$fields = parent::getCMSFields();
50			$fields->removeByName("ParentPageID");
51			$fields->removeByName("ParentID");
52			$fields->addFieldToTab("Root.Main", new TreeDropdownField($name = "ParentPageID", $title = "Parent Page (show all child pages as links for this recommended section)", $sourceObject = "SiteTree"));
53			return $fields;
54			}
55
56			public function onBeforeWrite()
57			{
58			parent::onBeforeWrite();
59			if (!$this->ParentID) {
			0 ignored issues – show Documentation introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `ParentID` does not exist on `object<RecommendedSearchPlusSection>`. 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...
60			if ($page = SearchPlusPage::get()->first()) {
61			$this->ParentID = $page->ID;
			0 ignored issues – show Documentation introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report The property `ParentID` does not exist on `object<RecommendedSearchPlusSection>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
62			} else {
63			user_error("Make sure to create a SearchPlusPage", E_USER_NOTICE);
64			}
65			}
66			}
67			}
68

sunnysideup / silverstripe-searchplus

RecommendedSearchPlusSection::getCMSFields() A last analyzed 2018-03-20 01:29 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RecommendedSearchPlusSection::getCMSFields() A
last analyzed 2018-03-20 01:29 UTC