PageRow - Code Metrics - sunnysideup/silverstripe-pagerows - Measure and Improve Code Quality continuously with Scrutinizer

PageRow F
last analyzed 2018-05-02 23:01 UTC

↳ Parent: Project

Complexity

Total Complexity

145

Size/Duplication

Total Lines	922
Duplicated Lines	6.18 %

Coupling/Cohesion

Components	1
Dependencies	18

Importance

Changes

Metric	Value
wmc	145
lcom	1
cbo	18
dl	57
loc	922
c	0
b	0
f	0
rs	1.263

55 Methods

Rating	Name	Duplication	Size	Complexity
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
A	scaffoldSearchFields()	0	17	2
A	getType()	0	4	1
A	getCodeNice()	0	6	1
A	getUsedOn()	0	10	2
A	getTitleStrong()	0	6	1
A	getReadyForPublicationStrong()	0	10	2
A	canDelete()	0	4	2
B	requireDefaultRecords()	22	53	8
C	validate()	0	43	11
A	onBeforeWrite()	0	8	2
A	onAfterWrite()	0	10	3
D	getCMSFields()	0	158	23
A	myCMSFieldGroups()	0	9	1
A	HTMLClassNamesAsString()	0	7	1
A	ChildInheritedClassNamesAsString()	0	4	1
A	baseClassesForHTMLAsArray()	0	17	4
A	makeIntoHTMLClasses()	0	9	1
A	UserCanEditMe()	0	4	1
A	set_current_page_object()	0	4	1
A	CurrentOwnerPageObject()	0	10	3
A	CurrentOwnerController()	0	7	2
A	AdditionalHTMLClassNamesAsArray()	0	4	1
A	HTMLOutputAlwaysOutput()	0	4	1
B	HTMLOutput()	0	16	5
A	customScripts()	0	4	1
A	templateForHTMLOutput()	0	7	2
A	MyPreviewLink()	9	9	2
A	MyPublicViewLink()	8	8	2
A	MoreDetailsRowChildLinkingID()	0	4	1
A	UserCanEditBlock()	0	4	1
A	ContextRelevantCMSEditLink()	0	9	3
A	ChildClassMethodName()	0	4	1
A	HasChild()	0	4	1
A	AsChildOpenByDefault()	0	4	1
A	MoreDetailsRowParentLinkingID()	0	8	2
B	CalculatedHasMoreDetailsRow()	0	14	6
A	HasChildPageRowHTML()	0	4	1
A	ChildPageRowHTML()	0	4	1
B	getChildPageRowHTML()	0	14	5
A	getImageCMSFields()	0	4	1
A	getLayoutCMSFields()	0	4	1
A	getBackgroundFields()	0	19	3
A	getPublishCMSFields()	0	7	1
A	IsPageRowWithBackgroundImage()	0	11	4
A	HasBackgroundImage()	0	4	2
C	CalculatedBackgroundImage()	0	27	7
A	HasSameBackgroundImageForAllOfThisType()	0	4	1
A	BackgroundImageOptions()	0	4	1
A	BackgroundImageOptionsWithBasics()	9	9	2
A	IsPageRowWithBackgroundStyle()	0	7	2
B	CalculatedBackgroundStyle()	0	17	5
A	BackgroundStyleOptionsWithBasics()	9	9	2
A	BackgroundStyleOptions()	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 PageRow 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 PageRow, and based on these observations, apply Extract Interface, too.

<?php



class PageRow extends DataObject
namespace YourVendor;

class YourClass { }
{

    /**
     *
     * @var string
     */
    private static $bg_image_prefix = '';



    /**
     *
     * @var string
     */
    private static $bg_image_postfix = '';


    /**
     *
     * @var array
     */
    private static $background_image_options = [];


    /**
     *
     * @var array
     */
    private static $background_style_options = [];


    /**
     *
     * @var int
     */
    private static $max_number_of_pages_for_tree_selector = 500;


    #######################
    ### Names Section
    #######################

    private static $singular_name = 'Content Block';


    public function i18n_singular_name()
    {
        return _t('PageRows.SINGULAR_NAME', 'Content Block');
    }

    private static $plural_name = 'PageRows';


    public function i18n_plural_name()
    {
        return _t('PageRows.PLURAL_NAME', 'Content Blocks');
    }


    #######################
    ### Model Section
    #######################

    private static $db = [

        'ReadyForPublication' => 'Boolean',
        'Code' => 'Varchar(7)',
        'Title' => 'Varchar(255)',
        'BackgroundImage' => 'Varchar(255)',
        'BackgroundStyle' => 'Varchar(100)'
    ];

    private static $belongs_many_many = [

        'Pages' => 'Page'
    ];


    #######################
    ### Further DB Field Details
    #######################

    private static $indexes = [

        'Created' => true,
        'Code' => true,
        'ReadyForPublication' => true
    ];

    private static $default_sort = [

        'ReadyForPublication' => 'DESC',
        'Created' => 'DESC'
    ];

    private static $required_fields = [

        'Title'
    ];

    private static $searchable_fields = [

        'ClassName' => 'ExactMatchFilter',
        'ReadyForPublication' => 'ExactMatchFilter',
        'Code' => 'PartialMatchFilter',
        'Title' => 'PartialMatchFilter'
    ];

    public function scaffoldSearchFields($_params = null) {
        $list = ClassInfo::subclassesFor('PageRow');
        $newList = [];
        foreach($list as $key => $entry) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $newList[$entry] = Injector::inst()->get($entry)->i18n_singular_name();
        }
        $fields = parent::scaffoldSearchFields($_params);
        $fields->replaceField(
            'ClassName',
            DropdownField::create(
                'ClassName',
                'Type',
                ['' => '--- ANY ---'] + $newList
            )
        );
        return $fields;
    }

    #######################
    ### Field Names and Presentation Section
    #######################

    private static $summary_fields = [

        'CodeNice' => 'Code',
        'Type' => 'Type',
        'TitleStrong' => 'Title',
        'UsedOn' => 'Used On',
        'ReadyForPublicationStrong' => 'Published'
    ];

    private static $field_labels = [

        'ReadyForPublication' => 'Ready'
    ];

    private static $field_labels_right = [

        'Code' => 'This is auto-generated (unique) code to keep track of content blocks',
        'ReadyForPublication' => 'Is this Content Block ready for publication?'
    ];


    #######################
    ### Casting Section
    #######################

    private static $casting = [

        'CodeNice' => 'HTMLText',
        'Type' => 'Varchar',
        'UsedOn' => 'Varchar',
        'ChildPageRowHTML' => 'HTMLText',
        'TitleStrong' => 'HTMLText',
        'ReadyForPublicationStrong' => 'HTMLText'
    ];


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

    public function getCodeNice()
    {
        $v = '<span style="font-family: monospace;">'.substr($this->Code, 0, 3).'-'.substr($this->Code, -4).'</span>';
<?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 DBField::create_field('HTMLText', $v);
    }

    public function getUsedOn()
    {
        $v = [];
        $pages = $this->Pages();
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 { }
        foreach($pages as $page) {
            $v[] = $page->MenuTitle;
        }

        return DBField::create_field('Varchar', implode(', ', $v));
    }

    public function getTitleStrong()
    {
        $v = '<strong style="color: blue">'.$this->Title.'</strong>';
<?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 DBField::create_field('HTMLText', $v);
    }

    public function getReadyForPublicationStrong()
    {
        if($this->ReadyForPublication) {
<?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.");
        }
    }

}
            $v = '<span style="color: green">Published</span>';
        } else {
            $v = '<span style="color: red">NOT published</span>';
        }

        return DBField::create_field('HTMLText', $v);
    }



    #######################
    ### can Section
    #######################

    /**
     * only children can be created
     */


    public function canDelete($member = null)
    {
        return $this->Pages()->count() ? false : true;
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 { }
    }



    #######################
    ### write Section
    #######################

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

        //make template
        $theme = SSViewer::current_theme();

        if($theme) {
            if ($this->ClassName !== 'PageRow') {
                $folder = Director::baseFolder().
                '/themes/'.
                $theme.'_mysite/templates/Includes/page-row/types/';
                if(! file_exists($folder)) {
                    DB::alteration_message('✓ Creating '.$folder, 'created');
                    mkdir($folder, 0755, true);
                }
                if(file_exists($folder)){
                    $fileName =
                        $folder . $this->templateForHTMLOutput($this->ClassName).'.ss';
                    if (! file_exists($fileName)) {

                        DB::alteration_message('✓ Creating ...' . $fileName, 'created');
                        file_put_contents(
                            $fileName,
        '<% include PageRowHeader %>

        <% include PageRowFooter %>'
                        );
                    } else {
                        DB::alteration_message('✓ Checked ...' . $fileName);
                    }
                }
            }

            //scss files ...
            $folder =
                Director::baseFolder().'/themes/'.
                $theme.'_mysite/src/sass/page-rows/';
            $fileName = $folder . $this->ClassName.'.scss';
            if(! file_exists($folder)) {
                mkdir($folder, 0755, true);
            }
            if (! file_exists($fileName)) {

                DB::alteration_message('✓ Creating ...' . $fileName, 'created');
                file_put_contents(
                    $fileName,
    '.'.strtolower($this->ClassName).'.row {

    }'
                );
            } else {
                DB::alteration_message('✓ Checked ...' . $fileName);
            }
        }
    }


    public function validate()
    {
        $result = parent::validate();
        if ($this->ReadyForPublication) {
<?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.");
        }
    }

}
            $fieldLabels = $this->FieldLabels();
            $indexes = $this->Config()->get('indexes');
            foreach ($this->Config()->get('required_fields') as $field) {
                $value = $this->$field;
                if (! $value) {
                    $fieldWithoutID = $field;
                    if (substr($fieldWithoutID, -2) === 'ID') {
                        $fieldWithoutID = substr($fieldWithoutID, 0, -2);
                    }
                    $myName = isset($fieldLabels[$fieldWithoutID]) ? $fieldLabels[$fieldWithoutID] : $fieldWithoutID;
                    $result->error(
                        _t(
                            'PageRows.'.$field.'_REQUIRED',
                            $myName.' is required'
                        ),
                        'REQUIRED_PageRows_'.$field
                    );
                }
                if (isset($indexes[$field]) && isset($indexes[$field]['type']) && $indexes[$field]['type'] === 'unique') {
                    $id = (empty($this->ID) ? 0 : $this->ID);
                    $count = PageRows::get()
                        ->filter(array($field => $value))
                        ->exclude(array('ID' => $id))
                        ->count();
                    if ($count > 0) {
                        $myName = $fieldLabels['$field'];
                        $result->error(
                            _t(
                                'PageRows.'.$field.'_UNIQUE',
                                $myName.' needs to be unique'
                            ),
                            'UNIQUE_PageRows_'.$field
                        );
                    }
                }
            }
        }
        return $result;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if (!$this->Code) {
<?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->Code = hash('md5', rand());
<?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.");
        }
    }

}
        }
        //...
    }

    public function onAfterWrite()
    {
        parent::onAfterWrite();
        if (!$this->Code) {
<?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->Code = hash('md5', rand());
<?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(class_exists('DynamicCache')) {
            DynamicCache::inst()->clear();
        }
    }


    #######################
    ### Import / Export Section
    #######################


    #######################
    ### CMS Edit Section
    #######################


    protected $runCMSFieldFixups = true;

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName('BackgroundImage');
        $fields->removeByName('BackgroundStyle');
        $fields->removeByName('Pages');
        if ($this->exists() && $this->Code) {
<?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.");
        }
    }

}
            //too late now!
        } else {
            $list = ClassInfo::subclassesFor('PageRow');
            $arrayOfTypes = [];
            foreach ($list as $className) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                if ($className === 'PageRow') {
                    continue;
                }
                $arrayOfTypes[$className] = Injector::inst()->get($className)->singular_name();
            }
            $fields->addFieldToTab(
                'Root.Main',
                DropdownField::create(
                    'ClassName',
                    'Type',
                    $arrayOfTypes
                ),
                'Title'
            );
        }
        $fieldLabels = $this->FieldLabels();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $fields->insertAfter(
            'ReadyForPublication',
            ReadonlyField::create(
                'ClassNameNice',
                'Type',
                $this->singular_name()
            )
        );
        $fields->replaceField(
            'Code',
            ReadonlyField::create(
                'Code',
                'Code'
            )
        );



        $fieldGroups = $this->myCMSFieldGroups();
        foreach ($fieldGroups as $tabTitle => $fieldGroup) {
            if(is_array($fieldGroup) && count($fieldGroup)) {
                foreach ($fieldGroup as $fieldNameOrFormField) {
                    if($fieldNameOrFormField instanceof FormField) {
                        $fields->addFieldToTab(
                            'Root.'.$tabTitle,
                            $fieldNameOrFormField
                        );
                    } else {
                        $fieldObject = $fields->dataFieldByName($fieldNameOrFormField);
                        if ($fieldObject) {
                            $fields->addFieldToTab(
                                'Root.'.$tabTitle,
                                $fieldObject
                            );
                        }
                    }
                }
            }
        }

        //...



        if ($this->exists()) {
            $fields->addFieldsToTab(
                'Root.Preview',
                [
                    LiteralField::create(
                        'PreviewClassName',
                        '<h2><a href="'.$this->MyPreviewLink(strtolower($this->ClassName)).'">View All '.$this->singular_name().' Page Blocks</a></h2>'
                    ),
                    LiteralField::create(
                        'PreviewIframe',
                        '<iframe src="'.$this->MyPreviewLink($this->ID).'" style="width: calc(100% - 2px); height: 600px; border: 1px solid #000;"></iframe>'
                    ),
                    LiteralField::create(
                        'PreviewAll',
                        '<h2><a href="'.$this->MyPreviewLink('all').'">View All Page Blocks</a></h2>'
                    ),
                    LiteralField::create(
                        'PreviewOneOfEach',
                        '<h2><a href="'.$this->MyPreviewLink('oneofeach').'">View One Of Each Page Block Type</a></h2>'
                    )
                ]
            );
            if(Page::get()->count() > $this->Config()->get('max_number_of_pages_for_tree_selector')) {
                $fields->addFieldToTab(
                    'Root.Pages',
                    GridField::create(
                        'Pages',
                        'Shown On ...',
                        $this->Pages(),
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 { }
                        GridFieldConfig_RecordViewer::create()
                    )
                );
            } else {
                $fields->addFieldToTab(
                    'Root.Pages',
                    TreeMultiselectField::create(
                        'Pages',
                        'Shown On ...',
                        'SiteTree'
                        )
                    );
            }


            $usedInArray = [];
            $pageClasses = ClassInfo::subclassesFor('SiteTree');
            foreach ($pageClasses as $pageClass) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $pageClassObject = Injector::inst()->get($pageClass);
                if ($pageClassObject instanceof Page) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                    $classesUsed = $pageClassObject->DefaultPageRows();
                    foreach ($classesUsed as $individualItems) {
                        if (
                            (
                                is_array($individualItems) &&
                                (
                                    $individualItems['Parent'] === $this->ClassName ||
                                    $individualItems['Child']=== $this->ClassName
                                )
                            )
                            ||
                            (is_string($individualItems) && $individualItems=== $this->ClassName)
                        ) {
                            $usedInArray[$pageClassObject->ClassName] = $pageClassObject->singular_name();
                        }
                    }
                }
            }
            if (count($usedInArray)) {
                $fields->addFieldToTab(
                    'Root.Pages',
                    LiteralField::create(
                        'UsedInInfo',
                        '<h2>'.$this->plural_name().' ('.$this->ClassName.') are used in the following pages ...</h2><p>
                        - '.implode('<br />- ', $usedInArray).'
                        </p>'
                    )
                );
            }
        }

        if ($this->runCMSFieldFixups) {
            $this->decorateCMSFields($fields);
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 { }
        }

        return $fields;
    }

    protected function myCMSFieldGroups()
    {
        return [
            'Image' => $this->getImageCMSFields(),
            'Layout' => $this->getLayoutCMSFields(),
            'Background' => $this->getBackgroundFields(),
            'Publish' => $this->getPublishCMSFields()
        ];
    }

    #############################################
    ### TEMPLATE STUFF
    #############################################


    public function HTMLClassNamesAsString()
    {
        $str = $this->makeIntoHTMLClasses($this->baseClassesForHTMLAsArray());
        $str .= ' '.$this->makeIntoHTMLClasses($this->AdditionalHTMLClassNamesAsArray());

        return $str;
    }

    public function ChildInheritedClassNamesAsString()
    {
        return "";
    }

    protected function baseClassesForHTMLAsArray()
    {
        /**
         * we avoid the use of Advertisement as this will be blocked by adblockers ...
         */
        $array = [
            ($this->HasChildPageRowHTML() ? 'has-child-row' : 'no-child-row'),
            $this->ClassName
        ];
        foreach($this->hasOne() as $method => $item) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $field = $method.'ID';
            if($this->$field) {
                $array [] = 'has-'.strtolower($method);
            }
        }
        return $array;
    }

    protected function makeIntoHTMLClasses($array)
    {
        $str = implode(' ', $array);
        $str = str_replace('  ', ' ', $str);
        $str = str_replace('  ', ' ', $str);
        $str = strtolower($str);

        return $str;
    }

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


    private static $_current_owner_page_object_overridden = null;

    public static function set_current_page_object($page)
    {
        self::$_current_owner_page_object_overridden = $page;
    }


    public function CurrentOwnerPageObject()

    {
        if (self::$_current_owner_page_object_overridden) {
            return self::$_current_owner_page_object_overridden;
        }
        $controller = $this->CurrentOwnerController();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        if ($controller) {
            return $controller->data();
        }
    }

    public function CurrentOwnerController()
    {
        $controller = Controller::curr();
        if ($controller instanceof Page_Controller) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $controller;
        }
    }

    public function AdditionalHTMLClassNamesAsArray()
    {
        return [];
    }

    public function HTMLOutputAlwaysOutput($includeJS = true)
    {
        return $this->HTMLOutput($includeJS, true);
    }


    public function HTMLOutput($includeJS = true, $alwaysShow = false)
    {
        if ($this->ReadyForPublication || $alwaysShow) {
<?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.");
        }
    }

}
            $scripts = $this->customScripts();
            if ($includeJS) {
                foreach ($scripts as $key => $script) {
                    Requirements::customScript(
                        $script,
                        $key
                    );
                }
            }

            return $this->renderWith($this->templateForHTMLOutput());
        }
    }

    /**
     * custom scripts required to run this show
     * @return array
     */
    protected function customScripts()
    {
        return [];
    }

    protected function templateForHTMLOutput($className = null)
    {
        if (! $className) {
            $className = $this->ClassName;
        }
        return 'PageRow-'.$className;
    }

    public function MyPreviewLink($id = 0)

    {
        if (! $id) {
            $id = $this->ID;
        }
        $controller = Injector::inst()->get('PreviewPageRow');

        return $controller->Link('preview/'.$id);
    }

    public function MyPublicViewLink()

    {
        if (! $id) {
function someFunction() {
    $x = 5;
    echo $x;
}
            $id = $this->ID;
        }
        $controller = Injector::inst()->get('PreviewPageRow');
        return $controller->Link('preview/'.$id);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
    }


    public function MoreDetailsRowChildLinkingID()
    {
        return 'PageRow-'.$this->ID;
    }



    public function UserCanEditBlock($member = null)
    {
        return $this->canEdit($member);
    }

    public function ContextRelevantCMSEditLink()

    {
        $ownerPage = $this->CurrentOwnerPageObject();
        if ($ownerPage && $ownerPage instanceof SiteTree) {
            return '/admin/pages/edit/EditForm/'.$ownerPage->ID.'/field/PageRows/item/'.$this->ID.'/edit/';
        } else {
            return $this->CMSEditLink();

        }
    }


    public function ChildClassMethodName()
    {
        return '';
    }

    private $_childPageRowHTML = null;

    /**
     * @alias for HasChildPageRowHTML
     * @return bool
     */
    public function HasChild()
    {
        return $this->CalculatedHasMoreDetailsRow();
    }

    public function AsChildOpenByDefault()
    {
        return false;
    }


    public function MoreDetailsRowParentLinkingID()
    {
        if($this->CalculatedHasMoreDetailsRow()) {
            return 'PageRow'.$this->MoreDetailsRowID;
<?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 null;
    }


    public function CalculatedHasMoreDetailsRow()
    {
        if(!empty($this->HasMoreDetailsSection)) {
<?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(!empty($this->MoreDetailsRowID)) {
<?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($object = $this->MoreDetailsRow()){

                    if($object->exists() && $object->ReadyForPublication) {
                        return true;
                    }
                }
            }
        }

        return false;
    }

    /**
     *
     * @return bool
     */
    public function HasChildPageRowHTML()
    {
        return $this->CalculatedHasMoreDetailsRow();
    }

    /**
     * @return null / string
     */
    public function ChildPageRowHTML()
    {
        return $this->getChildPageRowHTML();
    }

    /**
     * @return null / string
     */
    public function getChildPageRowHTML()
    {
        if ($this->_childPageRowHTML === null) {
            $this->_childPageRowHTML = false;
            $method = $this->ChildClassMethodName();
            if ($method) {
                $object = $this->$method();
                if ($object && $object->exists()) {
                    $this->_childPageRowHTML = $object->HTMLOutput();
                }
            }
        }
        return $this->_childPageRowHTML;
    }

    ###############################
    # COPIED AND PATCHED FROM:
    # https://github.com/jonom/silverstripe-version-history/blob/master/code/VersionHistoryExtension.php
    ###############################

    protected function getImageCMSFields()
    {
        return [];
    }

    protected function getLayoutCMSFields()
    {
        return [];
    }

    protected function getBackgroundFields()
    {
        $a = [];
        if($this->IsPageRowWithBackgroundStyle()) {
            $a[] = DropdownField::create(
                'BackgroundStyle',
                'Background Style',
                $this->BackgroundStyleOptionsWithBasics()
            );
        }
        if($this->IsPageRowWithBackgroundImage()) {
            $a[] = DropdownField::create(
                'BackgroundImage',
                'Background Image',
                $this->BackgroundImageOptionsWithBasics()
            );
        }
        return $a;
    }


    protected function getPublishCMSFields()
    {
        return [
            'ReadyForPublication',
            'Code'
        ];
    }

    private $_bgImage = null;

    protected $_theSameBackgroundImageForAllOfThisTypeToDo = true;

    public function IsPageRowWithBackgroundImage()
    {
        $prefix = $this->Config()->get('bg_image_prefix');
        $postfix = $this->Config()->get('bg_image_postfix');
        if($prefix || $postfix) {
            $options = $this->BackgroundImageOptions();
            if(count($options)) {
                return true;
            }
        }
    }

    public function HasBackgroundImage()
    {
        return $this->BackgroundImage ? true : false;

    }

    public function CalculatedBackgroundImage()

    {
        if($this->_bgImage === null) {
            $this->_bgImage = false;
            if($this->BackgroundImage) {

                $prefix = $this->Config()->get('bg_image_prefix');
                $postfix = $this->Config()->get('bg_image_postfix');
                if($this->BackgroundImage == 'random') {

                    $a = $this->BackgroundImageOptions();
                    if(count($a)) {
                        $this->_bgImage = $prefix.$a[array_rand($a)].$postfix;
                    }
                } else {
                    $this->_bgImage = $prefix.$this->BackgroundImage.$postfix;

                }
                if($this->HasSameBackgroundImageForAllOfThisType() && $this->_theSameBackgroundImageForAllOfThisTypeToDo) {
                    $this->_theSameBackgroundImageForAllOfThisTypeToDo = false;
                    Requirements::customCSS('
                        section.row.'.strtolower($this->ClassName).' {
                            background-image: url('.$this->_bgImage.');
                        }
                    ');
                }
            }
        }
        return $this->_bgImage;
    }

    protected function HasSameBackgroundImageForAllOfThisType()
    {
        return false;
    }

    protected function BackgroundImageOptions()

    {
        return $this->Config()->get('background_image_options');
    }

    protected function BackgroundImageOptionsWithBasics()

    {
        $a = ['' => '--- no background image selected ---']
            + $this->BackgroundImageOptions();
        if(count($a) > 2) {
            $a['random'] = 'Random Background Image';
        }
        return $a;
    }


    protected $_bgStyle = null;

    public function IsPageRowWithBackgroundStyle()
    {
        $options = $this->BackgroundStyleOptions();
        if(count($options)) {
            return true;
        }
    }

    public function CalculatedBackgroundStyle()

    {
        if($this->_bgStyle === null) {
            $this->_bgStyle = false;
            if($this->BackgroundStyle) {
<?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($this->BackgroundStyle == 'random') {
<?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.");
        }
    }

}
                    $a = $this->BackgroundStyleOptions();
                    if(count($a)) {
                        $this->_bgStyle = $a[array_rand($a)];
                    }
                } else {
                    $this->_bgStyle = $this->BackgroundStyle;
<?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 $this->_bgStyle;
    }


    protected function BackgroundStyleOptionsWithBasics()

    {
        $a = ['' => '--- default style ---']
            + $this->BackgroundstyleOptions();
        if(count($a) > 2) {
            $a['random'] = 'Random Background Style';
        }
        return $a;
    }


    protected function BackgroundStyleOptions()

    {
        return $this->Config()->get('background_style_options');
    }
}


PageRow F
last analyzed 2018-05-02 23:01 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

55 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Available Fixes

1			<?php
2
3
4
5			class PageRow extends DataObject
			0 ignored issues – show Coding Style Compatibility introduced 2018-05-02 23:01 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...
6			{
7
8			/**
9			*
10			* @var string
11			*/
12			private static $bg_image_prefix = '';
			0 ignored issues – show Unused Code introduced 2018-05-02 23:01 UTC by Report Bug Copy Issue Report The property `$bg_image_prefix` 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...
13
14
15			/**
16			*
17			* @var string
18			*/
19			private static $bg_image_postfix = '';
			0 ignored issues – show Unused Code introduced 2018-05-02 23:01 UTC by Report Bug Copy Issue Report The property `$bg_image_postfix` 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
21			/**
22			*
23			* @var array
24			*/
25			private static $background_image_options = [];
			0 ignored issues – show Unused Code introduced 2018-05-02 23:01 UTC by Report Bug Copy Issue Report The property `$background_image_options` 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...
26
27			/**
28			*
29			* @var array
30			*/
31			private static $background_style_options = [];
			0 ignored issues – show Unused Code introduced 2018-05-02 23:01 UTC by Report Bug Copy Issue Report The property `$background_style_options` 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
33			/**
34			*
35			* @var int

sunnysideup / silverstripe-pagerows

PageRow F last analyzed 2018-05-02 23:01 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

55 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Available Fixes

Duplication Side-by-Side

Filter issues like

PageRow F
last analyzed 2018-05-02 23:01 UTC