BrowseAbstractPage   A
last analyzed

Complexity

Total Complexity 14

Size/Duplication

Total Lines 110
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 5

Importance

Changes 0
Metric Value
wmc 14
lcom 0
cbo 5
dl 0
loc 110
rs 10
c 0
b 0
f 0

7 Methods

Rating   Name   Duplication   Size   Complexity  
A canCreate() 0 9 3
A GeoLevelName() 0 4 1
A GeoLevelNumber() 0 4 1
A allowBrowseChildren() 0 8 2
A getDataFromTable() 0 14 3
A getCMSFields() 0 16 2
A onBeforeWrite() 0 7 2
1
<?php
2
3
class BrowseAbstractPage extends Page
0 ignored issues
show
Coding Style Compatibility introduced by
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...
4
{
5
6
    /**
7
     * Standard SS static
8
     **/
9
    public static $db = array(
10
        "CreateChildren" => "Boolean",
11
        "CreateAllChildren" => "Boolean",
12
        "HiddenDataID" => "Int",
13
        "AlternativeURL" => "Varchar",
14
        "ExtraNote" => "Varchar(255)"
15
    );
16
17
    /**
18
     * Standard SS static
19
     **/
20
    public static $breadcrumbs_delimiter = " &raquo; ";
21
22
    /**
23
     * Standard SS method: can only create if the parent exists...
24
     **/
25
    public function canCreate($member = null)
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
26
    {
27
        $bt = defined('DB::USE_ANSI_SQL') ? "\"" : "`";
0 ignored issues
show
Unused Code introduced by
$bt is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
28
        if ("BrowseAbstractPage" == $this->ClassName) {
29
            return false;
30
        } else {
31
            return parent::canCreate();
32
        }
33
    }
34
35
    /**
36
     * Name of the level
37
     **/
38
    public function GeoLevelName()
39
    {
40
        return "No level";
41
    }
42
43
    /**
44
     * Number of the level
45
     **/
46
    public function GeoLevelNumber()
47
    {
48
        return -1;
49
    }
50
51
52
    /**
53
     * works out if the child page needs to be created
54
     **/
55
    public function allowBrowseChildren()
56
    {
57
        if (DataObject::get_one("BrowseWorldPage")->LevelOfDetail > $this->GeoLevelNumber()) {
0 ignored issues
show
Coding Style introduced by
The if-else statement can be simplified to return \DataObject::get_...this->GeoLevelNumber();.
Loading history...
58
            return true;
59
        } else {
60
            return false;
61
        }
62
    }
63
64
    /**
65
     * retrieves data from a DB table that is not part of the DataObject Model.
66
     **/
67
    protected function getDataFromTable($tableName, $where  = null, $orderby = null)
68
    {
69
        $sqlQuery = new SQLQuery();
0 ignored issues
show
Deprecated Code introduced by
The class SQLQuery has been deprecated with message: since version 4.0

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
70
        $sqlQuery->select = array('*');
71
        $sqlQuery->from = array($tableName);
72
        if ($where) {
73
            $sqlQuery->where = array($where);
74
        }
75
        if ($orderby) {
76
            $sqlQuery->orderby = $orderby;
77
        }
78
        $result = $sqlQuery->execute();
79
        return $result;
80
    }
81
82
    /**
83
     * standard SS method
84
     **/
85
    public function getCMSFields()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
86
    {
87
        $fields = parent::getCMSFields();
88
        $fields->addFieldToTab("Root.Content.AddSubRegion", new CheckboxField("CreateChildren", "Create Child Pages (e.g. countries below continents)"));
89
        $fields->addFieldToTab("Root.Content.AddSubRegion", new CheckboxField("CreateAllChildren", "Create All Child Pages (e.g. countries, regions, and cities below continents)"));
90
        //$fields->addFieldToTab("Root.Content.AddSubRegion", new ReadonlyField("HiddenDataID", "Data ID number (should have number)"));
0 ignored issues
show
Unused Code Comprehensibility introduced by
73% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
91
        $fields->addFieldToTab("Root.Content.AddSubRegion", new LiteralField("build", "Create now... ", '<a href="db/build/?flush=1&geobuild=1">create pages now</a>'));
0 ignored issues
show
Unused Code introduced by
The call to LiteralField::__construct() has too many arguments starting with '<a href="db/build/?flus...">create pages now</a>'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
92
        if (!$this->allowBrowseChildren()) {
93
            $fields->removeFieldFromTab("Root.Content.AddSubRegion", "CreateChildren");
94
            $fields->removeFieldFromTab("Root.Content.AddSubRegion", "CreateAllChildren");
95
        }
96
97
        $fields->addFieldsToTab('Root.Content.Main', new TextField('AlternativeURL', 'Alternative URL'));
98
99
        return $fields;
100
    }
101
102
    /**
103
     * standard SS method
104
     **/
105
    public function onBeforeWrite()
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
106
    {
107
        if ($this->CreateAllChildren) {
108
            $this->CreateChildren = 1;
109
        }
110
        return parent::onBeforeWrite();
111
    }
112
}
113
114
class BrowseAbstractPage_Controller extends Page_Controller
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class should be in its own file to aid autoloaders.

Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule.

Loading history...
Coding Style Compatibility introduced by
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...
115
{
116
}
117