Issues in GoogleCustomSearchPage.php - New Issues - Inspection of "PATCH: module clean-up" - sunnysideup/silverstripe-googlecustomsearch - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 29d5ff...6f0ca5 )

by Nicolaas

created 2017-07-31 11:05 UTC

code/GoogleCustomSearchPage.php (3 issues)

Labels

Coding Style 3

Severity

Minor 3

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * @package googlesitesearch
 */
class GoogleCustomSearchPage extends Page
{
    private static $icon = "googlecustomsearch/images/treeicons/GoogleCustomSearchPage";

    private static $allowed_children = "none";

    private static $can_be_root = true;

    private static $description = "Page to search via Google and display search results.";

    /**
     * Standard SS variable.
     */
    private static $singular_name = "Google Search Results Page";
    public function i18n_singular_name()
    {
        return _t("GoogleCustomSearchPage.SINGULAR_NAME", "Google Search Results Page");
    }

    /**
     * Standard SS variable.
     */
    private static $plural_name = "Google Search Results Pages";
    public function i18n_plural_name()
    {
        return _t("GoogleCustomSearchPage.PLURAL_NAME", "Google Search Results Pages");
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->addFieldToTab("Root.Searches",
            new GoogleCustomSearchPage_RecordField("stats", "Search History Last 100 Days")
        );
        return $fields;
    }

    public function requireDefaultRecords()
    {
        if ($this->canCreate()) {
            DB::alteration_message("Creating a GoogleCustomSearchPage", "created");
            $page = new GoogleCustomSearchPage();
            $page->writeToStage('Stage');
            $page->publish('Stage', 'Live');
        }
    }

    public function populateDefaults()
    {
        parent::populateDefaults();
        $this->Title = "Search";
        $this->MenuTitle = "Search";
        $this->ShowInMenus = 0;
        $this->ShowInSearch = 0;
        $this->URLSegment = "search";
    }

    public function canCreate($member = null)
    {
        return GoogleCustomSearchPage::get()->count() ?  false : true;
    }
}

class GoogleCustomSearchPage_Controller extends Page_Controller
{
    private static $allowed_actions = array(
        "recordsearch"
    );

    public function init()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        parent::init();
        //register any search
        if (isset($_GET["search"])) {
            $searchString = Convert::raw2sql($_GET["search"]);
            $forwardto = "";
            if (isset($_GET["forwardto"])) {
                $forwardto = Convert::raw2sql($_GET["forwardto"]);
            }
            GoogleCustomSearchPage_Record::add_entry($searchString, $forwardto);
        }
        if ($this->request->param("Action") != "recordsearch") {
            Requirements::themedCSS('GoogleCustomSearchPage');
            Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
            Requirements::javascript('googlecustomsearch/javascript/GoogleCustomSearchPage.js');
            $cxKey = Config::inst()->get("GoogleCustomSearchExt", "cx_key");
            Requirements::customScript("
					GoogleCustomSearchPage.cxKey = '".$cxKey."';
				",
                "GoogleCustomSearchPage"
            );
        } else {
            echo "registered ...";
        }
    }

    /**
     * template function,
     *
     * @ return String
     */
    public function SearchPhrase()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $string = "";
        if (isset($_GET['search'])) {
            $string = $_GET['search'];
        }
        return DBField::create_field('HTMLText', $string);
    }

    /**
     *
     * @return String
     */
    public function getTitle()
    {
        if ($searchPhrase = $this->SearchPhrase()->forTemplate()) {
            return $this->dataRecord->Title._t("GoogleCustomSearchPage.FOR", " for ").$searchPhrase;
        } else {
            return $this->dataRecord->Title;
        }
    }

    public function recordsearch($request)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_GET["forwardto"]) && $_GET["forwardto"]) {
            return $this->redirect($_GET["forwardto"]);
        }
    }
}


1			<?php
2
3			/**
4			* @package googlesitesearch
5			*/
6			class GoogleCustomSearchPage extends Page
7			{
8			private static $icon = "googlecustomsearch/images/treeicons/GoogleCustomSearchPage";
9
10			private static $allowed_children = "none";
11
12			private static $can_be_root = true;
13
14			private static $description = "Page to search via Google and display search results.";
15
16			/**
17			* Standard SS variable.
18			*/
19			private static $singular_name = "Google Search Results Page";
20			public function i18n_singular_name()
21			{
22			return _t("GoogleCustomSearchPage.SINGULAR_NAME", "Google Search Results Page");
23			}
24
25			/**
26			* Standard SS variable.
27			*/
28			private static $plural_name = "Google Search Results Pages";
29			public function i18n_plural_name()
30			{
31			return _t("GoogleCustomSearchPage.PLURAL_NAME", "Google Search Results Pages");
32			}
33
34			public function getCMSFields()
35			{
36			$fields = parent::getCMSFields();
37			$fields->addFieldToTab("Root.Searches",
38			new GoogleCustomSearchPage_RecordField("stats", "Search History Last 100 Days")
39			);
40			return $fields;
41			}
42
43			public function requireDefaultRecords()
44			{
45			if ($this->canCreate()) {
46			DB::alteration_message("Creating a GoogleCustomSearchPage", "created");
47			$page = new GoogleCustomSearchPage();
48			$page->writeToStage('Stage');
49			$page->publish('Stage', 'Live');
50			}
51			}
52
53			public function populateDefaults()
54			{
55			parent::populateDefaults();
56			$this->Title = "Search";
57			$this->MenuTitle = "Search";
58			$this->ShowInMenus = 0;
59			$this->ShowInSearch = 0;
60			$this->URLSegment = "search";
61			}
62
63			public function canCreate($member = null)
64			{
65			return GoogleCustomSearchPage::get()->count() ? false : true;
66			}
67			}
68
69			class GoogleCustomSearchPage_Controller extends Page_Controller
70			{
71			private static $allowed_actions = array(
72			"recordsearch"
73			);
74
75			public function init()
			0 ignored issues – show Coding Style introduced 2017-07-31 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this `init` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
76			{
77			parent::init();
78			//register any search
79			if (isset($_GET["search"])) {
80			$searchString = Convert::raw2sql($_GET["search"]);
81			$forwardto = "";
82			if (isset($_GET["forwardto"])) {
83			$forwardto = Convert::raw2sql($_GET["forwardto"]);
84			}
85			GoogleCustomSearchPage_Record::add_entry($searchString, $forwardto);
86			}
87			if ($this->request->param("Action") != "recordsearch") {
88			Requirements::themedCSS('GoogleCustomSearchPage');
89			Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
90			Requirements::javascript('googlecustomsearch/javascript/GoogleCustomSearchPage.js');
91			$cxKey = Config::inst()->get("GoogleCustomSearchExt", "cx_key");
92			Requirements::customScript("
93			GoogleCustomSearchPage.cxKey = '".$cxKey."';
94			",
95			"GoogleCustomSearchPage"
96			);
97			} else {
98			echo "registered ...";
99			}
100			}
101
102			/**
103			* template function,
104			*
105			* @ return String
106			*/
107			public function SearchPhrase()
			0 ignored issues – show Coding Style introduced 2017-07-31 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this `SearchPhrase` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
108			{
109			$string = "";
110			if (isset($_GET['search'])) {
111			$string = $_GET['search'];
112			}
113			return DBField::create_field('HTMLText', $string);
114			}
115
116			/**
117			*
118			* @return String
119			*/
120			public function getTitle()
121			{
122			if ($searchPhrase = $this->SearchPhrase()->forTemplate()) {
123			return $this->dataRecord->Title._t("GoogleCustomSearchPage.FOR", " for ").$searchPhrase;
124			} else {
125			return $this->dataRecord->Title;
126			}
127			}
128
129			public function recordsearch($request)
			0 ignored issues – show Coding Style introduced 2017-07-31 11:06 UTC by Report Bug Copy Issue Report Show Similar Issues like this `recordsearch` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
130			{
131			if (isset($_GET["forwardto"]) && $_GET["forwardto"]) {
132			return $this->redirect($_GET["forwardto"]);
133			}
134			}
135			}
136

sunnysideup / silverstripe-googlecustomsearch

Push — master ( 29d5ff...6f0ca5 )

code/GoogleCustomSearchPage.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like