PageRowPageExtension

Complexity

Total Complexity

36

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	PageRows()	0	4	1
A	getPageRows()	0	4	1
F	onAfterWrite()	0	82	17
A	removePageRowFromThisPage()	0	14	2
A	DefaultPageRows()	0	7	2
A	updateCMSFields()	0	10	4
B	ContentBlocksFields()	0	40	4
B	HasPageRows()	0	13	5

<?php

class PageRowPageExtension extends SiteTreeExtension

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{


    private static $many_many = [

The property $many_many is not used and could be removed.

        'PageRows' => 'PageRow'
    ];

    private static $many_many_extraFields = [

The property $many_many_extraFields is not used and could be removed.

        'PageRows' => [
            'SortOrder' => 'Int'
        ]
    ];

    public function PageRows()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->getPageRows();
    }

    public function getPageRows()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->owner->getManyManyComponents('PageRows')->sort(['SortOrder' => 'ASC']);
    }

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

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

    private static $field_labels = [

The property $field_labels is not used and could be removed.

        'PageRows' => 'Content Blocks'
    ];

    private static $field_labels_right = [

The property $field_labels_right is not used and could be removed.

        'PageRows' => 'Please edit with care! You can add content blocks that are not ready for publication, but they will not be visible until they are ticked as available.',
    ];


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


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



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



    public function onAfterWrite()
    {
        if (Security::database_is_ready()  && $this->owner->HasPageRows()) {
            // debug::Log('-------------------------');

63% of this comment could be valid code. Did you maybe forget this after debugging?

            $currentPageRows = [];
            if ($this->owner->PageRows()->count() > 0) {
                $sortOrder = 1;
                foreach ($this->owner->PageRows() as $pageRow) {
                    $currentPageRows[$sortOrder] = $pageRow;
                    $sortOrder++;
                }
            }
            $rowClassNames = $this->owner->DefaultPageRows();
            $sortOrder = 1;
            foreach ($rowClassNames as $className) {
                $childClassName = null;
                if (is_array($className)) {
                    $childClassName = $className['Child'];
                    // debug::log($childClassName);

63% of this comment could be valid code. Did you maybe forget this after debugging?

                    $className = $className['Parent'];
                }
                if (isset($currentPageRows[$sortOrder])) {
                    $row = $currentPageRows[$sortOrder];
                    if ($row->ClassName === $className) {

This if statement is empty and can be removed.

                        //all OK!
                    } else {

This else statement is empty and can be removed.

                        // $this->owner->removePageRowFromThisPage($row);

70% of this comment could be valid code. Did you maybe forget this after debugging?

                        //we do not delete the row as it may be used somewhere else ...
                        // $this->owner->deletePageRowFromMe($row);

70% of this comment could be valid code. Did you maybe forget this after debugging?

                    }
                } else {
                    $row = $className::create();
                    $row->Title = 'Title '.$row->singular_name().' #'.$className::get()->count().' for '.$this->owner->MenuTitle;
                    $row->write();
                    $this->owner->PageRows()->add($row, ['SortOrder' => $sortOrder]);
                    $currentPageRows[$sortOrder] = $row;
                }
                DB::query('
                    UPDATE "Page_PageRows"
                    SET "SortOrder" = '.$sortOrder.'
                    WHERE
                        "PageID" ='.$this->owner->ID.' AND
                        "PageRowID" = '.$row->ID.'
                    LIMIT 1;
                ');
                if ($childClassName) {
                    $childClassMethod = $row->ChildClassMethodName();
                    if ($childClassMethod) {
                        $child = $row->$childClassMethod();
                        if ($child && $child->exists()) {

This if statement is empty and can be removed.

                        } else {
                            $childClassMethodFieldName = $childClassMethod.'ID';
                            $child = $childClassName::create();
                            $child->Title = 'New '.$child->singular_name().' for '.$row->getTitle();
                            $child->write();
                            // debug::log($childClassMethodFieldName);

63% of this comment could be valid code. Did you maybe forget this after debugging?

                            // debug::log($child->ID);

60% of this comment could be valid code. Did you maybe forget this after debugging?

                            // debug::log($child->Title);

60% of this comment could be valid code. Did you maybe forget this after debugging?

                            $row->$childClassMethodFieldName = $child->ID;
                            $row->write();
                        }
                    } else {
                        user_error('no childclass method set in '.$row->ClassName);
                    }
                }
                $sortOrder++;
            }
            $sortOrder = 1;
            foreach ($this->owner->PageRows() as $pageRow) {
                $sortOrder++;
                $delete = false;
                if (!isset($rowClassNames[$sortOrder])) {
                    $delete = true;
                } elseif ($rowClassNames[$sortOrder] !== $pageRow->ClassName) {
                    $delete = true;
                }
                if ($delete) {

This if statement is empty and can be removed.

                    // $this->owner->removePageRowFromThisPage($pageRow);

70% of this comment could be valid code. Did you maybe forget this after debugging?

                }
            }
        }
    }

    protected function removePageRowFromThisPage($rowOrRowID)
    {
        if ($rowOrRowID instanceof PageRow) {
            $rowOrRowID = $rowOrRowID->ID;
        }
        DB::query('
            DELETE
            FROM "Page_PageRows"
            WHERE
                "PageID" ='.$this->owner->ID.' AND
                "PageRowID" = '.$rowOrRowID.'
            LIMIT 1;
        ');
    }


    public function DefaultPageRows()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if($this->owner->hasMethod('MyDefaultPageRows')) {
            return $this->owner->MyDefaultPageRows();
        }
        return [];
    }

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



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

    /**
     * Update Fields
     * @return FieldList

Should the return type not be FieldList|null?

     */
    public function updateCMSFields(FieldList $fields)
    {
        $list = $this->owner->PageRows();

$list is not used, you could remove the assignment.

        if($this->owner->canEdit() && $this->owner->exists() && $this->HasPageRows()) {
            $fields->addFieldsToTab(
                'Root.ContentBlocks',
                $this->owner->ContentBlocksFields()
            );
        }
    }

    public function ContentBlocksFields()
    {
        $conf = GridFieldConfig_RelationEditor::create(100);
        $conf->addComponent(new GridFieldSortableRows('SortOrder'));
        // switch ($this->owner->ClassName) {

59% of this comment could be valid code. Did you maybe forget this after debugging?

        //     case 'HomePage':
        //         // leave as is ...
        //         $conf->removeComponentsByType('GridFieldAddExistingAutocompleter');

75% of this comment could be valid code. Did you maybe forget this after debugging?

        //         $conf->removeComponentsByType('GridFieldDeleteAction');

75% of this comment could be valid code. Did you maybe forget this after debugging?

        //         $conf->removeComponentsByType('GridFieldAddNewButton');

75% of this comment could be valid code. Did you maybe forget this after debugging?

        //         break;
        //     default:
        // }
        //
        $conf->getComponentByType('GridFieldAddExistingAutocompleter')->setSearchFields(['Code', 'Title']);

It seems like you code against a concrete implementation and not the interface GridFieldComponent as the method setSearchFields() does only exist in the following implementations of said interface: GridFieldAddExistingAutocompleter.

        $pageRowField = GridField::create(
            'PageRows',
            'Content Blocks',
            $this->owner->PageRows(),
            $conf
        );
        $array = [$pageRowField];
        $arrayRowList = [];
        foreach ($this->owner->DefaultPageRows() as $count => $className) {
            if (is_array($className)) {
                $className = $className['Parent'];
            }
            $humanCount = $count + 1;
            $arrayRowList[$className.'_'.$count] = $humanCount . ' - '.Injector::inst()->get($className)->singular_name().' ('.$className.')';
        }
        if(count($arrayRowList)) {
            $array[] = LiteralField::create(
                'ListOfContentBlocks',
                '<h2>By default, this page type ('.$this->owner->singular_name().') has the following content blocks:</h2><p>'.implode('</p><p>', $arrayRowList).'</p>'
            );
        }

        return $array;
    }

    public function HasPageRows()

The return type could not be reliably inferred; please add a @return annotation.

    {
        switch($this->owner->ClassName) {
            case 'ErrorPage':
            case 'RedirectorPage':
            case 'VirtualPage':
                return false;
        }
        if($this->owner->hasMethod('MyHasPageRows')) {
            return $this->owner->MyHasPageRows();
        }
        return true;
    }

}