SearchPlusPage

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	canCreate()	0	4	2
A	canDelete()	0	4	1
A	getCMSFields()	0	20	1

<?php

File has mixed line endings; this may cause incorrect results

/*
 *@author: nicolaas [at] sunnysideup.co.nz
 *
 *
 **/

class SearchPlusPage extends Page

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    private static $add_action = 'Search Plus Page';

The property $add_action is not used and could be removed.

    private static $can_be_root = true;

The property $can_be_root is not used and could be removed.

    private static $icon = 'searchplus/images/treeicons/SearchPlusPage';

The property $icon is not used and could be removed.

    private static $db = array();

The property $db is not used and could be removed.

    private static $has_many = array(

The property $has_many is not used and could be removed.

        "RecommendedSearchPlusSections" => "RecommendedSearchPlusSection"
    );

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

    public function canDelete($member = null)
    {
        return false;
    }

    private static $result_length = 10;

The property $result_length is not used and could be removed.

    public function getCMSFields($params = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $fields = parent::getCMSFields($params);
        $fields->addFieldToTab(
            "Root.RecommendedSections",
            new GridField(
                $name = "RecommendedSearchPlusSections",
                $sourceClass = "Recommended Extras",
                RecommendedSearchPlusSection::get()
            )
        );
        $fields->addFieldToTab(
            "Root.PopularSearchPhrases",
            new LiteralField(
                "PopularSearchPhrasesLink",
                '<p>Please make sure to regular <a href="'.$this->Link().'popularsearchwords/100/10">review the most popular search phrases</a> and to add recommendations for each</a>.</p>'
            )
        );
        return $fields;
    }
}

class SearchPlusPage_Controller extends Page_Controller

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    public function init()
    {
        parent::init();
        Requirements::javascript("searchplus/javascript/searchpluspage.js");
    }

    private static $search_history_object = null;

    public function Form()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->SearchPlusForm("MainSearchForm", "MainSearch", "");
    }

    public function results($data)

The return type could not be reliably inferred; please add a @return annotation.

results uses the super-global variable $_GET which is generally not recommended.

results uses the super-global variable $_REQUEST which is generally not recommended.

    {
        if (isset($data["Search"]) || isset($data["MainSearch"])) {
            // there is a search
            Requirements::themedCSS("searchpluspage_searchresults", "searchplus");
            if (isset($data["MainSearch"]) || !isset($data["Search"])) {
                $data["Search"] = $data["MainSearch"];
            }
            //redirect if needed
            $data["Search"] = urldecode($data["Search"]);
            $form = $this->SearchPlusForm();
            if (!isset($_GET["redirect"])) {
                self::$search_history_object = SearchHistory::add_entry($data["Search"]);
                if (self::$search_history_object) {
                    if (self::$search_history_object->RedirectTo && self::$search_history_object->RedirectTo != self::$search_history_object->Title) {
                        $this->redirect(
                            str_replace(
                                "Search=".urlencode(self::$search_history_object->Title),
                                "Search=".urlencode(self::$search_history_object->RedirectTo),
                                HTTP::RAW_setGetVar('redirect', 1, null)
                            )
                        );
                    }
                }
            } else {
                self::$search_history_object = SearchHistory::find_entry($data["Search"]);
            }
            //load data for recommended pages
            $recommendationsSet = $this->Recommendations();
            $matchArrayRecommended = array();
            $matchArrayResults = array();
            if ($recommendationsSet) {
                foreach ($recommendationsSet as $rec) {
                    $matchArrayRecommended[$rec->ClassName.$rec->ID] = $rec->ClassName.$rec->ID;
                }
            }
            //work out positions
            $results = $form->getResults();
            $query = $form->getSearchQuery();
            $startingPosition = isset($_REQUEST["start"]) ? $_REQUEST["start"] : 0;
            $endingPosition = $startingPosition + Config::inst()->get("SearchPlusPage", "result_length");
            $startingPosition++;
            if ($results) {
                $total = $results->TotalItems();
            } else {
                $total = 0;
            }
            if ($endingPosition > $total) {
                $endingPosition = $total;
            }
            //highlight search text and check which ones are recommended
            if ($total) {
                foreach ($results as $result) {
                    $title = $result->getTitle();
                    $dbField = DBField::create_field($className = "Text", $title);
                    $result->HighlightedTitle = $dbField->ContextSummary();
                    $result->IsRecommended = false;
                    $matchArrayResults[$result->ClassName.$result->ID] = $result->ClassName.$result->ID;
                    if (isset($matchArrayRecommended[$result->ClassName.$result->ID])) {
                        $result->IsRecommended = true;
                    }
                }
            }
            $data = array(
                'Results' => $results,
                'Query' => $query,
                'From' => $startingPosition,
                'To' => $endingPosition,
                'Total' => $total,
                'HasResults' => $total ? true : false,
                'Recommendations' => $this->Recommendations(),
                'RecommendedSearchPlusSection' => $this->dataRecord->RecommendedSearchPlusSections(),
            );
            $this->Title = 'Search Results';
            $this->MenuTitle = 'Search Results';
            return $this->customise($data)->renderWith(array('SearchPlusPage_results', 'Page'));
        }
        return array();
    }

    public function Recommendations()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if (self::$search_history_object) {
            return self::$search_history_object->Recommendations();
        }
    }

    public function HasPopularSearchWords()
    {
        return Permission::check("ADMIN");
    }

    public function PopularSearchWordsForAllUsers($days = 100, $limit = 7)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $do = $this->getPopularSearchWords($days, $limit, $mergeRedirects = true);
        return $do->DataByCount;
    }

    public function popularsearchwords(HTTPRequest $HTTPRequest)

The return type could not be reliably inferred; please add a @return annotation.

    {
        if (!$this->HasPopularSearchWords()) {
            Security::permissionFailure($this, _t('Security.PERMFAILURE', ' This page is secured and you need administrator rights to access it. Enter your credentials below and we will send you right along.'));
            return;
        }
        Requirements::themedCSS("popularsearches", "searchplus");
        $days = intval($HTTPRequest->param("ID"));
        if (!$days) {
            $days = 100;
        }
        $limit = intval($HTTPRequest->param("OtherID")+0);
        if (!$limit) {
            $limit++;
        }
        $do = $this->getPopularSearchWords($days, $limit);
        $page->MenuTitle = $do->Title;

The variable $page does not exist. Did you forget to declare it?

        $do->Title = $do->Title;
        return $this->customise($do)->renderWith(array('SearchPlusPage_popularsearches', 'Page'));
    }

    protected function getPopularSearchWords($days, $limit, $mergeRedirects = false)
    {
        $extraWhere = '';
        if ($mergeRedirects) {
            $extraWhere = " AND {$bt}RedirectTo{$bt} = '' OR {$bt}RedirectTo{$bt} IS NULL";

The variable $bt does not exist. Did you forget to declare it?

        }
        $data = DB::query("

			SELECT COUNT(\"SearchHistoryLog\".\"ID\") count, \"SearchHistory\".\"RedirectTo\" RedirectTo, \"SearchHistory\".\"Title\" title, \"SearchHistory\".\"ID\" id

			FROM \"SearchHistoryLog\"

				INNER JOIN \"SearchHistory\" ON \"SearchHistory\".\"ID\" = \"SearchHistoryLog\".\"SearchedForID\"

			WHERE \"SearchHistoryLog\".\"Created\" > ( NOW() - INTERVAL $days DAY ) ".$extraWhere."

			GROUP BY \"SearchHistory\".\"ID\"

			ORDER BY count DESC

			LIMIT 0, $limit

		");
        $do = new DataObject();
        $do->Title = "Search phrase popularity, $days days $limit entries";
        $do->DataByCount = new ArrayList();
        $do->DataByTitle = new ArrayList();
        $do->Limit = $limit;
        $do->Days = $days;
        $list = array();
        foreach ($data as $key => $row) {
            if (!$key) {
                $max = $row["count"];
            }
            if ($mergeRedirects) {
                $data = DB::query("

					SELECT COUNT(\"SearchHistoryLog\".\"ID\") count

					FROM \"SearchHistoryLog\"

						INNER JOIN \"SearchHistory\"

							ON \"SearchHistory\".\"ID\" = \"SearchHistoryLog\".\"SearchedForID\"

					WHERE \"SearchHistoryLog\".\"Created\" > ( NOW() - INTERVAL $days DAY )

						AND \"SearchHistory\".\"RedirectTo\" = '".$row["title"]."'

					GROUP BY \"SearchHistory\".\"RedirectTo\"

					ORDER BY count

					DESC LIMIT 1

				");
                if ($data) {
                    $extraCounts = $data->value();
                }
                $row["count"] += $extraCounts;

The variable $extraCounts does not seem to be defined for all execution paths leading up to this point.

            }
            $percentage = floor(($row["count"]/$max)*100);

The variable $max does not seem to be defined for all execution paths leading up to this point.

            $subDataSet = new ArrayData(
                array(
                    "ParentID" => $row["id"],
                    "Title" => $row["title"],
                    "Width" => $percentage,
                    "Count" => $row["count"],
                    "Link" => $this->Link()."results/?Search=".urldecode($row["title"])."&action_results=Search"
                )
            );
            $list[$row["title"]] = $subDataSet;
            $do->DataByCount->push($subDataSet);
        }
        ksort($list);
        foreach ($list as $subDataSet) {
            $do->DataByTitle->push($subDataSet);
        }
        return $do;
    }
}