silverstripe / silverstripe-comments

src/Admin/CommentAdmin.php

<?php

namespace SilverStripe\Comments\Admin;

use SilverStripe\Admin\LeftAndMain;
use SilverStripe\Comments\Model\Comment;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\Tab;
use SilverStripe\Forms\TabSet;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Security\Security;

/**
 * Comment administration system within the CMS
 *
 * @package comments
 */
class CommentAdmin extends LeftAndMain implements PermissionProvider
{
    private static $url_segment = 'comments';

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

    private static $url_rule = '/$Action';

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

    private static $menu_title = 'Comments';

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

    private static $menu_icon_class = 'font-icon-comment';

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

    private static $allowed_actions = [

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

        'approvedmarked',
        'deleteall',
        'deletemarked',
        'hammarked',
        'showtable',
        'spammarked',
        'EditForm',
        'unmoderated'
    ];

    private static $required_permission_codes = 'CMS_ACCESS_CommentAdmin';

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

    public function providePermissions()
    {
        return [
            'CMS_ACCESS_CommentAdmin' => [
                'name' => _t(__CLASS__ . '.ADMIN_PERMISSION', "Access to 'Comments' section"),
                'category' => _t('SilverStripe\\Security\\Permission.CMS_ACCESS_CATEGORY', 'CMS Access')
            ],
        ];
    }

    /**
     * @return Form
     */
    public function getEditForm($id = null, $fields = null)
    {
        if (!$id) {
            $id = $this->currentPageID();
        }

        $form = parent::getEditForm($id);

The assignment to $form is dead and can be removed.

        $record = $this->getRecord($id);

        if ($record && !$record->canView()) {
            return Security::permissionFailure($this);

The expression return SilverStripe\Security\Security::permissionFailure($this) returns the type SilverStripe\Control\HTTPResponse which is incompatible with the documented return type SilverStripe\Forms\Form.

        }

        $newComments = Comment::get()->filter('Moderated', 0);

        $newGrid = CommentsGridField::create(
            'NewComments',
            '',
            $newComments,
            CommentsGridFieldConfig::create()
        );

        $approvedComments = Comment::get()->filter('Moderated', 1)->filter('IsSpam', 0);

        $approvedGrid = CommentsGridField::create(
            'ApprovedComments',
            '',
            $approvedComments,
            CommentsGridFieldConfig::create()
        );

        $spamComments = Comment::get()->filter('Moderated', 1)->filter('IsSpam', 1);

        $spamGrid = CommentsGridField::create(
            'SpamComments',
            '',
            $spamComments,
            CommentsGridFieldConfig::create()
        );

        $fields = FieldList::create(
            $root = TabSet::create(
                'Root',
                Tab::create(
                    'NewComments',
                    _t(
                        __CLASS__.'.NewComments',
                        'New ({count})',
                        ['count' => count($newComments)]
                    ),
                    $newGrid
                ),
                Tab::create(
                    'ApprovedComments',
                    _t(
                        __CLASS__.'.ApprovedComments',
                        'Approved ({count})',
                        ['count' => count($approvedComments)]
                    ),
                    $approvedGrid
                ),
                Tab::create(
                    'SpamComments',
                    _t(
                        __CLASS__.'.SpamComments',
                        'Spam ({count})',
                        ['count' => count($spamComments)]
                    ),
                    $spamGrid
                )
            )
        );

        $actions = FieldList::create();

        $form = Form::create(
            $this,
            'EditForm',
            $fields,
            $actions
        );

        $form->addExtraClass('cms-edit-form fill-height');
        $form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));

        if ($form->Fields()->hasTabset()) {
            $form->Fields()->findOrMakeTab('Root')->setTemplate('SilverStripe\\Forms\\CMSTabSet');
            $form->addExtraClass('center ss-tabset cms-tabset ' . $this->BaseCSSClasses());
        }

        $this->extend('updateEditForm', $form);

        return $form;
    }
}