silverstripe / silverstripe-comments

src/Admin/CommentsGridFieldSpamAction.php

<?php

namespace SilverStripe\Comments\Admin;

use SilverStripe\Comments\Model\Comment;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_ActionMenuItem;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use SilverStripe\Forms\GridField\GridField_ColumnProvider;
use SilverStripe\Forms\GridField\GridField_FormAction;

class CommentsGridFieldSpamAction implements
    GridField_ColumnProvider,
    GridField_ActionProvider,
    GridField_ActionMenuItem
{
    /**
     * {@inheritdoc}
     */
    public function augmentColumns($gridField, &$columns)
    {
        if (!in_array('Actions', $columns)) {
            $columns[] = 'Actions';
        }
    }

    public function getTitle($gridField, $record, $columnName)
    {
        return _t(__CLASS__ . '.SPAM', 'Spam');
    }

    public function getExtraData($gridField, $record, $columnName)
    {

        $field = $this->getSpamAction($gridField, $record, $columnName);

        if ($field) {
            return $field->getAttributes();
        }

        return null;
    }

    public function getGroup($gridField, $record, $columnName)
    {
        $field = $this->getSpamAction($gridField, $record, $columnName);

        return $field ? GridField_ActionMenuItem::DEFAULT_GROUP: null;
    }


    /**
     * {@inheritdoc}
     */
    public function getColumnAttributes($gridField, $record, $columnName)
    {
        return ['class' => 'col-buttons grid-field__col-compact'];
    }

    /**
     * {@inheritdoc}
     */
    public function getColumnMetadata($gridField, $columnName)
    {
        if ($columnName === 'Actions') {
            return ['title' => ''];
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getColumnsHandled($gridField)
    {
        return ['Actions'];
    }

    /**
     * {@inheritdoc}
     */
    public function getColumnContent($gridField, $record, $columnName)
    {
        if (!$record->canEdit()) {
            return;
        }

        $field = $this->getSpamAction($gridField, $record, $columnName);

        return $field ? $field->Field() : null;
    }

    /**
     * Returns the FormAction object, used by other methods to get properties
     *
     * @return GridField_FormAction|null
     */
    public function getSpamAction($gridField, $record, $columnName)

The parameter $columnName is not used and could be removed.

    {
        $field = GridField_FormAction::create(
            $gridField,
            'CustomAction' . $record->ID . 'Spam',
            _t(__CLASS__ . '.SPAM', 'Spam'),
            'spam',
            ['RecordID' => $record->ID]
        )
            ->addExtraClass(implode(' ', [
                'btn',
                'btn-secondary',
                'grid-field__icon-action',
                'action-menu--handled',
                'font-icon-cross-mark',
            ]))
            ->setAttribute('classNames', 'font-icon-cross-mark');
        return (!$record->IsSpam || !$record->Moderated) ? $field : null;
    }

    /**
     * {@inheritdoc}
     */
    public function getActions($gridField)
    {
        return ['spam'];
    }

    /**
     * {@inheritdoc}
     */
    public function handleAction(GridField $gridField, $actionName, $arguments, $data)
    {
        /** @var Comment $comment */
        $comment = Comment::get()->byID($arguments['RecordID']);
        $comment->markSpam();

        // output a success message to the user
        Controller::curr()->getResponse()->setStatusCode(
            200,
            _t(__CLASS__ . '.COMMENTMARKEDSPAM', 'Comment marked as spam.')
        );
    }
}