TemplateoverviewDescription - Code Metrics - sunnysideup/silverstripe-templateoverview_advanced - Measure and Improve Code Quality continuously with Scrutinizer

TemplateoverviewDescription B
last analyzed 2018-03-20 01:33 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	251
Duplicated Lines	8.37 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes

Metric	Value
wmc	41
lcom	1
cbo	15
dl	21
loc	251
rs	7.6361
c	0
b	0
f	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	canCreate()	0	4	1
A	canDelete()	0	4	1
A	ClassNameLinkFancy()	0	5	1
A	Title()	0	4	1
A	getTitle()	0	4	1
A	ModelAdminLink()	0	4	1
A	getCMSFields()	0	20	1
D	requireDefaultRecords()	0	93	23
A	createManifestExcludeFile()	9	9	3
A	createHTACCESSDenyAll()	12	12	3
A	validate()	0	13	3
A	onBeforeWrite()	0	4	1
A	forTemplate()	0	4	1

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 TemplateoverviewDescription 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 TemplateoverviewDescription, and based on these observations, apply Extract Interface, too.

<?php

/**
 *@author nicolaas[at]sunnysideup.co.nz
 *@description: more details per template. Records are auto-added
 *@link: http://localhost/www.mysite.co.nz/admin/templates/TemplateoverviewDescription/13/edit
 **/


class TemplateoverviewDescription extends DataObject
namespace YourVendor;

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

        "Title" => "Varchar",
        "Description" => "Text",
        "ToDoListHyperLink" => "Varchar(255)",
        "ClassNameLink" => "Varchar(120)"
    );

    private static $has_one = array(

        "Image1" => "Image",
        "Image2" => "Image",
        "Image3" => "Image",
        "Image4" => "Image",
        "Image5" => "Image",
        "Image6" => "Image",
        "Image7" => "Image"
    );

    private static $searchable_fields = array(

        "ClassNameLink" => "PartialMatchFilter"
    );

    private static $summary_fields = array(

        "ClassNameLink",
        "ToDoListHyperLink"
    );

    private static $field_labels = array(

        "ClassNameLink" => "Page Type Name",
        "ToDoListHyperLink" => "Link to To Do"
    );

    private static $singular_name = 'Template Description';


    private static $plural_name = 'Template Descriptions';


    private static $default_sort = 'ClassNameLink ASC';


    private static $indexes = array(

        "ClassNameLink" => true
    );

    private static $casting = array(

        "Title" => "Varchar"
    );

    /**
     * Location where we keep the template overview designs.
     * @var String
     */
    private static $image_folder_name = "templateoverview_advanced/designz";


    /**
     * Location where we keep the template overview designs.
     * @var String
     */
    private static $image_source_folder = "";


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

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

    public function ClassNameLinkFancy()

    {
        return implode(" ", preg_split('/(?<=\\w)(?=[A-Z])/', $this->ClassNameLink));

        return preg_replace("/(?<=[^A-Z])([A-Z])/", "$1", $this->ClassNameLink);
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }

    public function Title()

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

    {
        return $this->ClassNameLinkFancy();
    }

    public function ModelAdminLink()
    {
        return TemplateoverviewDescriptionModelAdmin::get_full_url_segment().$this->ClassName."/EditForm/field/TemplateoverviewDescription/item/".$this->ID."/edit/";
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName("ClassNameLink");
        $fields->removeByName("Image1");
        $fields->removeByName("Image2");
        $fields->removeByName("Image3");
        $fields->removeByName("Image4");
        $fields->removeByName("Image5");
        $fields->addFieldToTab("Root.Design", new UploadField("Image1", "Design One"));
        $fields->addFieldToTab("Root.Design", new UploadField("Image2", "Design Two"));
        $fields->addFieldToTab("Root.Design", new UploadField("Image6", "Design Three"));
        $fields->addFieldToTab("Root.Instructions", new UploadField("Image3", "Instructions One"));
        $fields->addFieldToTab("Root.Instructions", new UploadField("Image4", "Instructions Two"));
        $fields->addFieldToTab("Root.Instructions", new UploadField("Image5", "Instructions Three"));
        $fields->addFieldToTab("Root.Instructions", new UploadField("Image7", "Instructions Four"));
        $fields->addFieldToTab("Root.Main", new HeaderField("ClassNameLinkInfo", "Details for: ".$this->ClassNameLink), "Description");

        $fields->addFieldToTab("Root.Main", new LiteralField("BackLink", '<p><a href="'.$page->Link().'#sectionFor-'.$this->ClassNameLink.'">go back to template overview page</a> - dont forget to SAVE FIRST.</p>'));

        return $fields;
    }

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        $data = ClassInfo::subclassesFor("SiteTree");
        $fileList = null;
        if ($this->Config()->get("image_source_folder")) {
            $fileList = CMSHelp::get_list_of_files($this->Config()->get("image_source_folder"));
            if (!is_array($fileList)) {
                $fileList = null;
            } elseif (!count($fileList)) {
                $fileList = null;
            }
        }
        if ($fileList) {
            $destinationDir = Director::baseFolder()."/assets/".$this->Config()->get("image_folder_name")."/";
            $destinationFolder = Folder::find_or_make($this->Config()->get("image_folder_name"));
        }
        if ($data) {
            foreach ($data as $className) {
                $object = TemplateoverviewDescription::get()
                    ->filter(array("ClassNameLink" => $className))->First();
                if (!$object) {
                    $object = new TemplateoverviewDescription();
                    $object->ClassNameLink = $className;

                    $object->write();
                    DB::alteration_message("adding template description for $className", "created");
                } else {
                    $otherObjects = TemplateoverviewDescription::get()
                    ->filter(array("ClassNameLink" => $className))->exclude(array("ID" => $object->ID));
                    foreach ($otherObjects as $otherObject) {
                        DB::alteration_message("Deleting superfluous TemplateoverviewDescription with Class Name Link: $className", "deleted");
                        $otherObject->delete();
                    }
                }
                if ($fileList) {
                    $i = 0;
                    foreach ($fileList as $fileArray) {
                        $explodeByDot = explode(".", $fileArray["FileName"]);
                        if (is_array($explodeByDot) && count($explodeByDot)) {
                            $base = $explodeByDot[0];
                            $explodeByUnderscore = explode("_", $base);
                            if (is_array($explodeByUnderscore) && count($explodeByUnderscore)) {
                                $base = $explodeByUnderscore[0];
                                $classNameOptionArray = array($className);
                                for ($j = 0; $j < 10; $j++) {
                                    $classNameOptionArray[] = $className.$j;
                                }
                                foreach ($classNameOptionArray as $potentialBase) {
                                    if ($base == $potentialBase) {
                                        $i++;
                                        $filename = "".$this->Config()->get("image_folder_name")."/".$fileArray["FileName"];
                                        if (!file_exists($destinationDir.$fileArray["FileName"])) {
                                            copy($fileArray["FullLocation"], $destinationDir.$fileArray["FileName"]);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                                        }
                                        $image = $Image::get()

                                            ->filter(array("ParentID" => $destinationFolder->ID, "Name" => $fileArray["FileName"]))->First();
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                                        if (!$image) {
                                            $image = new Image();
                                            $image->ParentID = $destinationFolder->ID;
                                            $image->Filename = $filename;
                                            $image->Name = $fileArray["FileName"];
                                            $image->Title = $fileArray["Title"];
                                            $image->write();
                                        }
                                        $fieldName = "Image$i"."ID";
                                        if ($object->$fieldName != $image->ID) {
                                            $object->$fieldName = $image->ID;
                                            $object->write();
                                            DB::alteration_message("adding image to $className: ".$image->Title." (".$image->Filename.") using $fieldName field.", "created");
                                        }
                                    }
                                }
                            }
                        }
                    }
                } else {
                    DB::alteration_message("no design images found for $className", "deleted");
                }
            }
        }
        $helpDirectory = Director::baseFolder()."/".Config::inst()->get("CMSHelp", "help_file_directory_name")."/";
        if (!file_exists($helpDirectory)) {
            mkdir($helpDirectory);
        }
        $this->createManifestExcludeFile($helpDirectory);

        $devDirectory = Director::baseFolder()."/".Config::inst()->get("CMSHelp", "dev_file_directory_name")."/";
        if (!file_exists($devDirectory)) {
            mkdir($devDirectory);
        }
        $this->createManifestExcludeFile($devDirectory);
        $this->createHTACCESSDenyAll($devDirectory);
    }

    private function createManifestExcludeFile($dir)

    {
        $myFile = $dir.'_manifest_exclude';
        if (!file_exists($myFile)) {
            $handle = fopen($myFile, 'w') or user_error('Cannot open file:  '.$myFile);
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $data = '';
            fwrite($handle, $data);
        }
    }

    private function createHTACCESSDenyAll($dir)

    {
        $myFile = $dir.'.htaccess';
        if (!file_exists($myFile)) {
            $handle = fopen($myFile, 'w') or user_error('Cannot open file:  '.$myFile);
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $data = '
Order Deny,Allow
Deny from all
        ';
            fwrite($handle, $data);
        }
    }

    public function validate()
    {
        if ($this->ID) {
            if (
                TemplateoverviewDescription::get()
                    ->filter(array("ClassNameLink" => $this->ClassNameLink))

                    ->exclude(array("ID" => $this->ID))
            ) {
                return new ValidationResult(false, _t("TemplateoverviewDescription.ALREADYEXISTS", "This template already exists"));
            }
        }
        return new ValidationResult();
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
    }

    public function forTemplate()

    {
        return $this->ClassNameLink;

    }
}


TemplateoverviewDescription B
last analyzed 2018-03-20 01:33 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

sunnysideup / silverstripe-templateoverview_advanced

TemplateoverviewDescription B last analyzed 2018-03-20 01:33 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like

TemplateoverviewDescription B
last analyzed 2018-03-20 01:33 UTC