CWP\CWP\PageTypes\BasePage

Complexity

Total Complexity

9

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getFooter()	0	3	1
A	RelatedPagesTitle()	0	3	1
A	getSelectedLanguage()	0	10	3
A	getCMSFields()	0	47	3
A	RelatedPages()	0	3	1

<?php

namespace CWP\CWP\PageTypes;

use CWP\CWP\Model\RelatedPageLink;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\Forms\GridField\GridFieldEditButton;
use SilverStripe\Forms\GridField\GridFieldFilterHeader;
use SilverStripe\Forms\TreeMultiselectField;
use SilverStripe\Taxonomy\TaxonomyTerm;
use SilverStripe\View\ArrayData;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
use TractorCow\Fluent\Model\Locale;

The type TractorCow\Fluent\Model\Locale was not found. Maybe you did not declare it correctly or list all dependencies?

use TractorCow\Fluent\State\FluentState;

The type TractorCow\Fluent\State\FluentState was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * `BasePage` is a foundation page class which can be used for constructing your own page types. By default it is
 * hidden from the CMS - we rely on developers creating their own `Page` class in `mysite/code` which will extend
 * from `BasePage`.
 *
 * Please note: you should generally always extend `Page` with your custom page types. Refrain from subclassing
 * `BasePage` directly. Doing so will omit `Page` from your custom class's hierarchy, and this can have unintended
 * side effects where modules rely on modifying things on the `Page` class, as well as with templates and themes.
 */

class BasePage extends SiteTree
{
    /**
     * Hide this page type from the CMS. hide_ancestor is slightly misnamed, should really be just "hide"
     *
     * {@inheritDoc}
     */
    private static $hide_ancestor = BasePage::class;

The private property $hide_ancestor is not used, and could be removed.

    private static $api_access = [

The private property $api_access is not used, and could be removed.

        'view' => [
            'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription',
            'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID'
        ],
        'edit' => [
            'Locale', 'URLSegment', 'Title', 'MenuTitle', 'Content', 'MetaDescription',
            'ExtraMenu', 'Sort', 'Version', 'ParentID', 'ID'
        ],
    ];

    private static $table_name = 'BasePage';

The private property $table_name is not used, and could be removed.

    /**
     * @config
     * @var string
     */
    private static $related_pages_title = 'Related pages';

The private property $related_pages_title is not used, and could be removed.

    private static $many_many = [

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

        'Terms' => TaxonomyTerm::class,
        'RelatedPagesThrough' => [
            'through' => RelatedPageLink::class,
            'from' => 'BasePage',
            'to' => 'Child',
        ]
    ];

    private static $owns = [

The private property $owns is not used, and could be removed.

        'RelatedPagesThrough',
    ];

    private static $belongs_many_many = [

The private property $belongs_many_many is not used, and could be removed.

        'SimilarPages' => BasePage::class
    ];

    /**
     * @var array
     * @config
     */
    private static $many_many_extraFields = [

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

        'RelatedPages' => [
            'SortOrder' => 'Int',
        ],
    ];

    private static $plural_name = 'Base Pages';

The private property $plural_name is not used, and could be removed.

    /**
     * Get the footer holder.
     */
    public function getFooter()
    {
        return FooterHolder::get_one(FooterHolder::class);
    }

    /**
     * @deprecated 2.2.0:3.0.0 Please use RelatedPagesThrough() instead
     */
    public function RelatedPages()
    {
        return $this->getManyManyComponents('RelatedPagesThrough');
    }

    public function RelatedPagesTitle()
    {
        return $this->config()->get('related_pages_title');
    }

    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {
            // Related Pages
            $components = GridFieldConfig_RelationEditor::create();
            $components->removeComponentsByType(GridFieldAddNewButton::class);
            $components->removeComponentsByType(GridFieldEditButton::class);
            $components->removeComponentsByType(GridFieldFilterHeader::class);
            $components->addComponent(new GridFieldOrderableRows('SortOrder'));

            /** @var GridFieldDataColumns $dataColumns */
            $dataColumns = $components->getComponentByType(GridFieldDataColumns::class);
            $dataColumns->setDisplayFields([
                'Title' => _t(__CLASS__ . '.ColumnTitle', 'Title'),
                'ClassName' => _t(__CLASS__ . '.ColumnPageType', 'Page Type')
            ]);

            $fields->findOrMakeTab(
                'Root.RelatedPages',
                _t(__CLASS__ . '.RelatedPages', 'Related pages')
            );
            $fields->addFieldToTab(
                'Root.RelatedPages',
                GridField::create(
                    'RelatedPages',
                    _t(__CLASS__ . '.RelatedPages', 'Related pages'),
                    $this->RelatedPagesThrough(),

The method RelatedPagesThrough() does not exist on CWP\CWP\PageTypes\BasePage. Since you implemented __call, consider adding a @method annotation.

                    $components
                )
            );

            // Taxonomies - Unless they have their own 'Tags' field (such as in Blog, etc)
            $hasMany = $this->hasMany();
            $manyMany = $this->manyMany();
            if (!isset($hasMany['Tags']) && !isset($manyMany['Tags'])) {
                $fields->findOrMakeTab('Root.Tags', _t(__CLASS__ . '.TagsTabTitle', 'Tags'));
                $fields->addFieldToTab(
                    'Root.Tags',
                    TreeMultiselectField::create(
                        'Terms',
                        _t(__CLASS__ . '.Terms', 'Terms'),
                        TaxonomyTerm::class
                    )->setDescription(_t(__CLASS__ . '.TermsDescription', 'Click to search for additional terms'))
                );
            }
        });
        return parent::getCMSFields();
    }

    /**
     * Returns the native language name for the selected locale/language, empty string if Fluent is not available
     *
     * @return string
     */
    public function getSelectedLanguage()
    {
        if (!class_exists(Locale::class) || !$this->hasMethod('Locales')) {
            return '';
        }

        /** @var ArrayData $information */
        $information = $this->LocaleInformation(FluentState::singleton()->getLocale());

The method LocaleInformation() does not exist on CWP\CWP\PageTypes\BasePage. Since you implemented __call, consider adding a @method annotation.

        return $information->LanguageNative;
    }
}