SearchHistory - Code Metrics - sunnysideup/silverstripe-searchplus - Measure and Improve Code Quality continuously with Scrutinizer

SearchHistory A
last analyzed 2018-03-20 01:29 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	159
Duplicated Lines	5.03 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

Metric	Value
wmc	22
lcom	1
cbo	11
dl	8
loc	159
c	0
b	0
f	0
rs	10

6 Methods

Rating	Name	Duplication	Size	Complexity
A	add_entry()	0	16	3
A	find_entry()	0	5	1
A	clean_keywordstring()	0	6	1
B	getCMSFields()	0	31	3
C	onAfterWrite()	8	41	11
A	requireDefaultRecords()	0	12	3

How to fix Duplicated Code

<?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 SearchHistory extends DataObject
namespace YourVendor;

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

        "Title" => "Varchar(255)",
        "RedirectTo" => "Varchar(255)"
    );

    private static $has_many = array(

        "LogEntries" => "SearchHistoryLog"
    );

    private static $many_many = array(

        "Recommendations" => "SiteTree"
    );

    private static $singular_name = 'Search History Phrase';


    private static $plural_name = 'Search History Phrases';


    private static $default_sort = 'Title';


    private static $separator = " | ";


    private static $minimum_length = 3;


    private static $number_of_keyword_repeats = 3;


    private static $searchable_fields = array(

        "Title",
        "RedirectTo"
    );

    private static $summary_fields = array(

        "Title", "RedirectTo"
    );

    private static $field_labels = array(

        "Title" => "Phrase Searched For",
        "RedirectTo" => "Redirect To Search Phrase (if any)",
        "Recommendations" => "Recommended Pages - must already be part of the natural result set",
    );

    public static function add_entry($KeywordString)
    {
        if ($parent = self::find_entry($KeywordString)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
            //do nothing
        } else {
            $parent = new SearchHistory();
            $parent->Title = $KeywordString;
<?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.");
        }
    }

}
            $parent->write();
        }
        if ($parent) {
            $obj = new SearchHistoryLog();
            $obj->SearchedForID = $parent->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.");
        }
    }

}
            $obj->write();
            return $parent;
        }
    }

    public static function find_entry($KeywordString)
    {
        $KeywordString = self::clean_keywordstring($KeywordString);
        return SearchHistory::get()->filter(array("Title" => $KeywordString))->first();
    }

    public static function clean_keywordstring($KeywordString)
    {
        Convert::raw2sql($KeywordString);
        $KeywordString = trim(eregi_replace(" +", " ", $KeywordString));
        return $KeywordString;
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName("Title");
        $fields->addFieldToTab("Root.Main", new HeaderField($name = "TitleHeader", "search for: '".$this->Title."'", 1), "RedirectTo");
<?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.");
        }
    }

}
        $fields->removeByName("Recommendations");
        if (!$this->RedirectTo) {
<?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.");
        }
    }

}
            $source = SiteTree::get()
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                ->filter(array("ShowInSearch" => 1))
                ->exclude(array("ClassName" => "SearchPlusPage"));
            $sourceArray = $sourc->map()->toArray();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            //$fields->addFieldToTab("Root.Main", new MultiSelectField($name = "Recommendations", $title = "Recommendations", $sourceArray));

            $fields->addFieldToTab("Root.Main", new TreeMultiselectField($name = "Recommendations", $title = "Recommendations", "SiteTree"));
        } else {
            $fields->addFieldToTab("Root.Main", new LiteralField($name = "Recommendations", '<p>This search phrase cannot have recommendations, because it redirects to <i>'.$this->RedirectTo.'</i></p>'));
<?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.");
        }
    }

}
        }
        $page = SearchPlusPage::get()->first();
        if (!$page) {
            user_error("Make sure to create a SearchPlusPage to make proper use of this module", E_USER_NOTICE);
        } else {
            $fields->addFieldToTab("Root.Main", new LiteralField(
                $name = "BackLinks",
                $content =
                    '<p>
						Review a graph of all <a href="'.$page->Link().'popularsearchwords/100/10/">Popular Search Phrases</a> OR
						<a href="'.$page->Link().'results/?Search='.urlencode($this->Title).'&amp;action_results=Search&amp;redirect=1">try this search</a>.
<?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.");
        }
    }

}
					</p>'
            ));
        }
        return $fields;
    }

    public function onAfterWrite()
    {
        $bt = defined('DB::USE_ANSI_SQL') ? "\"" : "`";
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        parent::onAfterWrite();
        //add recommendations that are not actually matching
        $combos = $this->Recommendations();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        if ($combos) {
            $idArray = array();
            foreach ($combos as $combo) {
                $idArray[$combo->SiteTreeID] = $combo->SiteTreeID;
            }
            if (count($idArray)) {
                $pages = SiteTree::get()
                    ->filter(array("ID" => $idArray));
                if ($pages->count()) {
                    foreach ($pages as $page) {
                        $changed = false;
                        $title = Config::inst()->get("SearchHistory", "seperator").$this->getTitle();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                        $multipliedTitle = Config::inst()->get("SearchHistory", "seperator").str_repeat($this->getTitle(), Config::inst()->get("SearchHistory", "number_of_keyword_repeats"));
                        if (stripos($page->MetaKeywords." ", $multipliedTitle) === false) {

                            $page->MetaKeywords. $multipliedTitle;
                            $changed = true;
                        }
                        if (stripos($page->MetaKeywords." ", $multipliedTitle) === false) {

                            $page->MetaKeywords = $page->MetaKeywords. $multipliedTitle;
                            $changed = true;
                        }
                        if ($changed) {
                            $page->writeToStage('Stage');
                            $page->Publish('Stage', 'Live');
                            $page->Status = "Published";
                        }
                    }
                }
            }
        }
        //delete useless ones
        if (strlen($this->Title) < Config::inst()->get("SearchHistory", "minimum_length")) {
<?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.");
        }
    }

}
            $this->delete();
        }
    }

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        $dos = SearchHistory::get()
            ->where("\"Title\" = '' OR \"Title\" IS NULL OR LENGTH(\"Title\") < ".Config::inst()->get("SearchHistory", "minimum_length"));
        if ($dos) {
            foreach ($dos as $do) {
                DB::alteration_message("deleting #".$do->ID." from SearchHistory as it does not have a search phrase", "deleted");
                $do->delete();
            }
        }
    }
}



class SearchHistoryLog extends DataObject
namespace YourVendor;

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

        "SearchedFor" => "SearchHistory"
    );

    private static $singular_name = 'Search History Log Entry';


    private static $plural_name = 'Search History Log Entries';


    private static $default_sort = 'Created DESC';

}


1			<?php
			0 ignored issues – show Coding Style introduced 2017-01-03 01:30 UTC by Report Bug Copy Issue Report File has mixed line endings; this may cause incorrect results Loading history...
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 SearchHistory 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			"RedirectTo" => "Varchar(255)"
17			);
18
19			private static $has_many = 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_many` 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...
20			"LogEntries" => "SearchHistoryLog"
21			);
22
23			private static $many_many = 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 `$many_many` 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...
24			"Recommendations" => "SiteTree"
25			);
26
27			private static $singular_name = 'Search History Phrase';
			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...
28
29			private static $plural_name = 'Search History Phrases';
			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...
30
31			private static $default_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...
32

sunnysideup / silverstripe-searchplus

SearchHistory A last analyzed 2018-03-20 01:29 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

SearchHistory A
last analyzed 2018-03-20 01:29 UTC