AutomatedLinkReportTask::getPageDOM() - Code Metrics - Inspection of "#25 Updated according to scrutinizer recommendatio..." - dylangrech92/seotoolbox - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 2749c8...d768fa )

by Dylan

created 2016-09-25 15:12 UTC

AutomatedLinkReportTask::getPageDOM() B

↳ Parent: AutomatedLinkReportTask

Complexity

Conditions	5
Paths	10

Size

Total Lines	24
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.5125
c	0
b	0
f	0
cc	5
eloc	15
nc	10
nop	1

<?php

class AutomatedLinkReportTask extends Controller {
namespace YourVendor;

class YourClass { }

    private   $GlobalSettings;
    private   $Links;

    private static $exclude_classes = array('RedirectorPage', 'VirtualPage');


    public function index() {
        if (!Director::is_cli()) return 'Please run this controller in CLI';

        libxml_use_internal_errors(true);
        set_time_limit(600);

        $this->checkLinks();

        return array();
    }

    /**
     * Check each page on the site and add the data of the links
     * found in AutomatedLinkPageResult Objects
     *
     * @see AutomatedLinkPageResult
     * @return ArrayList
     */
    public function checkLinks() {
        $data = ArrayList::create();

        $run_in_realtime = Config::inst()->get('AutomatedLinkReport', 'run_in_realtime');

        // Enable this since we will need to render the pages for the report
        Config::inst()->update('SSViewer', 'theme_enabled', true);

        $this->GlobalSettings = GlobalAutoLinkSettings::get_current();
        $this->Links          = AutomatedLink::get()->sort('Priority');
        $includeInFields      = $this->GlobalSettings->IncludeInFields();
        if (!$this->GlobalSettings) {
            user_error('Run dev/build before starting to use SEOToolbox');
            return $data;
        }

        $exclude = Config::inst()->get($this->class, 'exclude_classes');
        $exclude = ($exclude) ? "'".implode("','", $exclude)."'" : '';
        foreach (SiteTree::get()->where("ClassName NOT IN($exclude)") as $page) {
            if (!$this->checkForPossibleLinks($page, $includeInFields)) continue;
            $page = $this->getLinkData($page, $includeInFields);
            if (!$page) continue;

            if (!$run_in_realtime) AutomatedLinkPageResult::add_or_update($page);
            $data->push($page);
        }

        if (!$run_in_realtime) AutomatedLinkPageResult::remove_old_data();

        return $data;
    }

    /**
     * Returns all the data on how the provided $page was
     * affected by automated links
     *
     * @param  SiteTree $page
     * @param  array $includeIn
     *
     * @return SiteTree|false $page
     */
    private function getLinkData(SiteTree $page, array $includeIn) {
        // Set a list of all fields that can have autolinks created in them
        $page->AutomateableFields = ArrayList::create();

        foreach ($this->getAllDatabaseFields($page->class) as $field => $type)
            if (in_array($field, $includeIn) &&
                !$page->AutomateableFields->find('DataField', $field) &&
                AutomatedLink::isFieldParsable($page, $field)
            ) $page->AutomateableFields->push(DataObject::create(array('DataField' => $field)));

        // Get data Pre-Automated Links creation
        $withLinks = $this->getPageDOM($page, true);

        if (!$withLinks) return false;

        $links = $withLinks->getElementsByTagName('a');

        $page->TotalLinks           = $links->length;
        $page->OriginalLinkCount    = $page->TotalLinks;

        $page->LinkCount            = 0;

        // List all automated links that were created in this $page
        $linksUsed = array();
        foreach ($this->Links as $autolink)
            foreach ($links as $link) {
                if ($link->getAttribute('data-id') == $autolink->ID) {
                    $linksUsed[$autolink->ID] = $autolink->Phrase;
                    $page->OriginalLinkCount--;

                    $page->LinkCount++;
                }
            }

        $page->Links = implode(', ', $linksUsed);

        if ($page->LinkCount < 1) return false;

        return $page;
    }

    /**
     * Return all possible database fields for the
     * $class provided
     *
     * @param String $class
     * @return array
     */
    private function getAllDatabaseFields($class) {
        $fields = array();
        foreach (ClassInfo::ancestry($class, true) as $cls)

            $fields = array_merge($fields, (array) DataObject::database_fields($cls));

        return $fields;
    }

    /**
     * Returns a rendered version of the page supplied
     * creating automated links according inside a DOMDocument
     * object or false if anything fails.
     *
     * @param SiteTree $page
     * @return DOMDocument
     */
    private function getPageDOM(SiteTree $page) {
        $controllerClass = $page->class.'_Controller';
        if (!class_exists($controllerClass))  $controller = $page->class.'Controller';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if (!class_exists($controllerClass)) return false;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

        $controller = $controllerClass::create($page);
        $controller->invokeWithExtensions('addAutomatedLinks');

        // Set the fields with possible links into a single variable that
        // will be dumped in the link checker template
        $page->AutomateableText = '';
        foreach ($page->AutomateableFields as $field) {
            $field = $field->DataField;
            $page->AutomateableText .= $page->$field;
        }

        $content = mb_convert_encoding(
            $controller->renderWith('LinkCheckerTemplate'),
            'html-entities',
            GlobalAutoLinkSettings::$encoding
        );

        return (!$content) ? false : AutomatedLink::constructDOMDocument($content);
    }

    /**
     * Checks if the page could have the possibility of automated links
     *
     * @param SiteTree $page
     * @param array $includeIn
     *
     * @return Boolean
     */
    private function checkForPossibleLinks(SiteTree $page, array $includeIn) {
        foreach ($this->Links as $link)
            foreach ($includeIn as $possibleField)
                if (isset($page->$possibleField) && preg_match("/\b{$link->Phrase}\b/i", $page->$possibleField)) return true;

        return false;
    }

}


1		<?php
2
3		class AutomatedLinkReportTask extends Controller {
		1 ignored issue – show Coding Style Compatibility introduced 2016-09-25 13:32 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...
4
5		private $GlobalSettings;
6		private $Links;
7
8		private static $exclude_classes = array('RedirectorPage', 'VirtualPage');
		1 ignored issue – show Unused Code introduced 2016-09-25 13:32 UTC by Report Bug Copy Issue Report The property `$exclude_classes` 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...
9
10		public function index() {
11		if (!Director::is_cli()) return 'Please run this controller in CLI';
12
13		libxml_use_internal_errors(true);
14		set_time_limit(600);
15
16		$this->checkLinks();
17
18		return array();
19		}
20
21		/**
22		* Check each page on the site and add the data of the links
23		* found in AutomatedLinkPageResult Objects
24		*
25		* @see AutomatedLinkPageResult
26		* @return ArrayList
27		*/
28		public function checkLinks() {
29		$data = ArrayList::create();
30
31		$run_in_realtime = Config::inst()->get('AutomatedLinkReport', 'run_in_realtime');
32
33		// Enable this since we will need to render the pages for the report
34		Config::inst()->update('SSViewer', 'theme_enabled', true);
35
36		$this->GlobalSettings = GlobalAutoLinkSettings::get_current();
37		$this->Links = AutomatedLink::get()->sort('Priority');
38		$includeInFields = $this->GlobalSettings->IncludeInFields();
39		if (!$this->GlobalSettings) {
40		user_error('Run dev/build before starting to use SEOToolbox');
41		return $data;
42		}
43
44		$exclude = Config::inst()->get($this->class, 'exclude_classes');
45		$exclude = ($exclude) ? "'".implode("','", $exclude)."'" : '';
46		foreach (SiteTree::get()->where("ClassName NOT IN($exclude)") as $page) {
47		if (!$this->checkForPossibleLinks($page, $includeInFields)) continue;
48		$page = $this->getLinkData($page, $includeInFields);
49		if (!$page) continue;
50
51		if (!$run_in_realtime) AutomatedLinkPageResult::add_or_update($page);
52		$data->push($page);
53		}
54
55		if (!$run_in_realtime) AutomatedLinkPageResult::remove_old_data();
56
57		return $data;
58		}
59
60		/**
61		* Returns all the data on how the provided $page was
62		* affected by automated links
63		*
64		* @param SiteTree $page
65		* @param array $includeIn
66		*
67		* @return SiteTree\|false $page
68		*/
69		private function getLinkData(SiteTree $page, array $includeIn) {
70		// Set a list of all fields that can have autolinks created in them
71		$page->AutomateableFields = ArrayList::create();
72
73		foreach ($this->getAllDatabaseFields($page->class) as $field => $type)
74		if (in_array($field, $includeIn) &&
75		!$page->AutomateableFields->find('DataField', $field) &&
76		AutomatedLink::isFieldParsable($page, $field)
77		) $page->AutomateableFields->push(DataObject::create(array('DataField' => $field)));
78
79		// Get data Pre-Automated Links creation
80		$withLinks = $this->getPageDOM($page, true);
		0 ignored issues – show Unused Code introduced 2016-09-25 13:32 UTC by Report Bug Copy Issue Report The call to `AutomatedLinkReportTask::getPageDOM()` has too many arguments starting with `true`. 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...
81		if (!$withLinks) return false;
82
83		$links = $withLinks->getElementsByTagName('a');
84
85		$page->TotalLinks = $links->length;
86		$page->OriginalLinkCount = $page->TotalLinks;
		1 ignored issue – show Bug introduced 2016-09-25 13:32 UTC by Report Bug Copy Issue Report The property `OriginalLinkCount` does not seem to exist. Did you mean `original`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
87		$page->LinkCount = 0;
88
89		// List all automated links that were created in this $page
90		$linksUsed = array();
91		foreach ($this->Links as $autolink)
92		foreach ($links as $link) {
93		if ($link->getAttribute('data-id') == $autolink->ID) {
94		$linksUsed[$autolink->ID] = $autolink->Phrase;
95		$page->OriginalLinkCount--;
		1 ignored issue – show Bug introduced 2016-09-25 13:32 UTC by Report Bug Copy Issue Report The property `OriginalLinkCount` does not seem to exist. Did you mean `original`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
96		$page->LinkCount++;
97		}
98		}
99
100		$page->Links = implode(', ', $linksUsed);
101
102		if ($page->LinkCount < 1) return false;
103
104		return $page;
105		}
106
107		/**
108		* Return all possible database fields for the
109		* $class provided
110		*
111		* @param String $class
112		* @return array
113		*/
114		private function getAllDatabaseFields($class) {
115		$fields = array();
116	View Code Duplication	foreach (ClassInfo::ancestry($class, true) as $cls)
		0 ignored issues – show Duplication introduced 2016-09-25 13:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117		$fields = array_merge($fields, (array) DataObject::database_fields($cls));
118
119		return $fields;
120		}
121
122		/**
123		* Returns a rendered version of the page supplied
124		* creating automated links according inside a DOMDocument
125		* object or false if anything fails.
126		*
127		* @param SiteTree $page
128		* @return DOMDocument
129		*/
130		private function getPageDOM(SiteTree $page) {
131		$controllerClass = $page->class.'_Controller';
132		if (!class_exists($controllerClass)) $controller = $page->class.'Controller';
		0 ignored issues – show Unused Code introduced 2016-09-25 13:32 UTC by Report Bug Copy Issue Report `$controller` 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...
133		if (!class_exists($controllerClass)) return false;
		0 ignored issues – show Bug Best Practice introduced 2016-09-25 13:32 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `AutomatedLinkReportTask::getPageDOM` of type `DOMDocument`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
134
135		$controller = $controllerClass::create($page);
136		$controller->invokeWithExtensions('addAutomatedLinks');
137
138		// Set the fields with possible links into a single variable that
139		// will be dumped in the link checker template
140		$page->AutomateableText = '';
141		foreach ($page->AutomateableFields as $field) {
142		$field = $field->DataField;
143		$page->AutomateableText .= $page->$field;
144		}
145
146		$content = mb_convert_encoding(
147		$controller->renderWith('LinkCheckerTemplate'),
148		'html-entities',
149		GlobalAutoLinkSettings::$encoding
150		);
151
152		return (!$content) ? false : AutomatedLink::constructDOMDocument($content);
153		}
154
155		/**
156		* Checks if the page could have the possibility of automated links
157		*
158		* @param SiteTree $page
159		* @param array $includeIn
160		*
161		* @return Boolean
162		*/
163		private function checkForPossibleLinks(SiteTree $page, array $includeIn) {
164		foreach ($this->Links as $link)
165		foreach ($includeIn as $possibleField)
166		if (isset($page->$possibleField) && preg_match("/\b{$link->Phrase}\b/i", $page->$possibleField)) return true;
167
168		return false;
169		}
170
171		}
172

dylangrech92 / seotoolbox

Push — develop ( 2749c8...d768fa )

AutomatedLinkReportTask::getPageDOM() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like