AutomatedLink - 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

AutomatedLink B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	259
Duplicated Lines	0.77 %

Coupling/Cohesion

Components	2
Dependencies	14

Importance

Changes

Metric	Value
wmc	44
lcom	2
cbo	14
dl	2
loc	259
rs	8.3396
c	0
b	0
f	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	PointsTo()	0	3	1
A	Title()	0	3	1
A	forTemplate()	0	3	1
A	canView()	0	3	1
A	canEdit()	0	3	1
A	canDelete()	0	3	1
A	canCreate()	0	3	1
A	providePermissions()	0	8	1
A	requireDefaultRecords()	0	8	2
B	getHTML()	0	9	7
B	getCMSFields()	0	44	2
A	getCMSValidator()	0	3	1
B	onBeforeWrite()	0	18	5
B	CheckAndUpdateDestination()	0	13	7
B	isFieldParsable()	2	13	6
A	canBeAdded()	0	3	2
A	constructDOMDocument()	0	18	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like AutomatedLink often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use AutomatedLink, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Plugin: SEOToolbox
 * Author: Dylan Grech
 * Copyright: 2016
 *
 * Automated Link is a dataobject that contains all the data
 * about a link that should be created automatically to a page
 *
 * @method SiteTree|null Page()
 */
class AutomatedLink extends DataObject implements PermissionProvider {
namespace YourVendor;

class YourClass { }

    private static $db = array(

        'Phrase'     	  => 'VARCHAR(255)',
        'TitleTag'   	  => 'VARCHAR(255)',
        'AnchorTag' 	  => 'VARCHAR(255)',
        'NewWindow'  	  => 'Boolean',
        'NoFollow'   	  => 'Boolean',
        'SelfLinking'     => 'Boolean',
        'CaseSensitive'   => 'Boolean',
        'MaxLinksPerPage' => 'INT',
        'Priority'		  => 'Int'
    );

    private static $defaults = array(

        'MaxLinksPerPage' => 10
    );

    private static $default_sort = 'Priority';


    private static $has_one = array(

        'Page' => 'SiteTree'
    );

    private static $summary_fields    = array( 'Phrase', 'PointsTo' );

    private static $searchable_fields = array( 'Phrase' );

    private static $singular_name	  = 'Automated Link';

    private static $plural_name	      = 'Automated Links';

    private static $parsableFields    = array();

    /**
     * Get the url of the page linked to this object
     *
     * @return string
     */
    public function PointsTo(){
        return $this->Page()->Link();
    }

    /**
     * Return the phrase set for this object
     *
     * @return string
     */
    public function Title(){
        return $this->Phrase;
<?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.");
        }
    }

}
    }

    /**
     * Return the rendered version of this object
     *
     * @return String
     */
    public function forTemplate(){
        return $this->getHTML();
    }

    function canView( $member = false ){

        return Permission::check('AUTOMATEDLINK_VIEW');
    }

    function canEdit( $member = false ){

        return Permission::check('AUTOMATEDLINK_EDIT');
    }

    function canDelete( $member = false ){

        return Permission::check('AUTOMATEDLINK_DELETE');
    }

    function canCreate( $member = false ){

        return Permission::check('AUTOMATEDLINK_CREATE');
    }

    function providePermissions() {

       return array(
         'AUTOMATEDLINK_VIEW'   => 'View Automated Links',
         'AUTOMATEDLINK_EDIT'   => 'Edit Automated Links',
         'AUTOMATEDLINK_DELETE' => 'Delete Automated Links',
         'AUTOMATEDLINK_CREATE' => 'Create Automated Links',
       );
     }

	public function requireDefaultRecords(){
		parent::requireDefaultRecords();

		// Update all links to redirector pages during dev/build
		foreach( self::get() as $link ) {
		    $link->CheckAndUpdateDestination( true );
		}
	}

	/**
	 * Returns the HTML Representation of this object
	 *
     * @param  String $originalPhrase
	 * @return String
	 */
	public function getHTML($originalPhrase = NULL) {
		$link     = ($this->PageID) ? $this->Page()->Link() : '#';
<?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.");
        }
    }

}
		$title    = ($this->TitleTag) ? "title='{$this->TitleTag}'" : '';
<?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.");
        }
    }

}
		$nofollow = ($this->NoFollow) ? 'rel="nofollow"' : '';
<?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.");
        }
    }

}
		$newtab   = ($this->NewWindow) ? 'target="_blank"' : '';
<?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.");
        }
    }

}
        $anchor = ($originalPhrase) ? $originalPhrase : $this->Phrase;
<?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.");
        }
    }

}
		$link     = ($this->AnchorTag) ? rtrim($link, '#').'#'.$this->AnchorTag : $link;
<?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.");
        }
    }

}
		return "<a href=\"$link\" $title $nofollow $newtab data-id=\"{$this->ID}\">{$anchor}</a>";
	}

	public function getCMSFields() {
		$fields = FieldList::create(TabSet::create('Root'));

		$fields->addFieldsToTab('Root.LinkSettings', array(
			TextField::create('Phrase', 'Phrase to search for', $this->Phrase, 255),
<?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.");
        }
    }

}
			TextField::create('TitleTag', 'Title Tag', $this->TitleTag, 255),
<?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.");
        }
    }

}
			TextField::create('AnchorTag', 'Anchor Tag(#)', $this->AnchorTag, 255),
<?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.");
        }
    }

}
			FieldGroup::create(
				CheckboxField::create('NoFollow'),
				CheckboxField::create('NewWindow'),
				CheckboxField::create('SelfLinking', 'Allow page to link to itself'),
				CheckboxField::create('CaseSensitive', 'Match the case of the phrase')
			),
			NumericField::create('MaxLinksPerPage', 'Maximum amount of this link to be created on a single page( 0 = unlimited )'),
			TreeDropdownField::create('PageID', 'Page to link to', 'SiteTree')
		));

		$settings = GlobalAutoLinkSettings::get_current();
		if ($settings) {
			$fields->addFieldsToTab('Root.Global', array(
				NumericField::create(
					'Global_MaxLinksPerPage',
					'Maximum amount of links a single page can have ( 0 = unlimited )',
					$settings->MaxLinksPerPage
				),
				TextField::create(
					'Global_ExcludeTags',
					'Do not include links into these HTML Tags ( comma seperated )',
					$settings->ExcludeTags
				),
				TextField::create(
				    'Global_AddTo',
				    'Page types where links should be created in ( leave blank for all page types )',
				    $settings->AddTo ),
				TextField::create(
					'Global_IncludeIn',
					'Include Links into these fields ( comma seperated & field must support html injection )',
					$settings->IncludeIn
				)
			));
		}

		return $fields;
	}

    public function getCMSValidator() {
        return new RequiredFields(array('Phrase', 'PageID'));
    }

	/**
	 * Save the Global Settings into the
	 * Global Auto Link Settings Object
	 *
	 * @return void
	 */
	public function onBeforeWrite() {
		parent::onBeforeWrite();

		$settings = GlobalAutoLinkSettings::get_current();
		if ($settings) {

			foreach ($this->getChangedFields() as $field => $value) {
				if (strpos($field, 'Global_') === 0 && isset($value['after'])) {
					$field = str_replace('Global_', '', $field);
					$settings->$field = $value['after'];
				}
			}

			$settings->write();
		}

		$this->CheckAndUpdateDestination();
	}

	/**
	 * Checks if the destination is a redirector page if so
	 * it updates it to the destination of the redirector page
	 *
	 * @Boolean $write - Write the changes if any
	 * @return void
	 */
	public function CheckAndUpdateDestination( $write = false ){
		$this->extend('beforeCheckAndUpdateDestination', $write);

		if( $this->PageID && $this->Page() &&
<?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->Page()->ClassName == 'RedirectorPage' &&
			$this->Page()->LinkToID && $this->Page()->RedirectionType == 'Internal' )
		{
			$this->PageID = $this->Page()->LinkToID;
<?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.");
        }
    }

}
			if( $write ) {
			    $this->write();
			}
		}
	}

    /**
     * Checks if the field is parable
     *
     * @param SiteTree $page
     * @param String   $field
     * @return Boolean
     */
    public static function isFieldParsable(SiteTree $page, $field) {
        if (!isset(self::$parsableFields[$page->ID]) || !isset(self::$parsableFields[$page->ID][$field])) {
            $fields = array();

            foreach (ClassInfo::ancestry($page->ClassName, true) as $class)

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

            self::$parsableFields[$page->ID][$field] =
                (Boolean) array_key_exists($field, $fields) && strtolower($fields[$field]) === 'htmltext' && $page->$field;
        }

        return self::$parsableFields[$page->ID][$field];
    }

    /**
     * Checks if this link can be added to the provided
     * page and field
     *
     * @param ContentController $controller
     * @return Boolean
     */
    public function canBeAdded( ContentController $controller ){
        return ( $this->SelfLinking || $controller->ID != $this->PageID );
<?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.");
        }
    }

}
    }

    /**
     * Turn the string passed into a DOMDocument object
     *
     * @param string $html
     * @return DOMDocument
     */
    public static function constructDOMDocument($html){
        if( class_exists( 'HTML5_Parser' ) ){
            $html5 = HTML5_Parser::parse( $html );
            if($html5 instanceof DOMNodeList){
                $dom = new DOMDocument();
                while($html5->length > 0) {
                    $dom->appendChild($html5->item(0));
                }
            }else{
                $dom = $html5;
            }
        } else{
            $dom = new DOMDocument();
            $dom->loadHTML( $html );
        }

        return $dom;
    }
}


dylangrech92 / seotoolbox