GridFieldRefreshButton::getHTMLFragments() - Code Metrics - Inspection of "Merge pull request #78 from creative-commoners/pul..." - bringyourownideas/silverstripe-maintenance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3da775...1e6bd3 )

by Robbie

created 2018-05-31 05:42 UTC

GridFieldRefreshButton::getHTMLFragments() B

↳ Parent: GridFieldRefreshButton

Complexity

Conditions	2
Paths	2

Size

Total Lines	31
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	20
nc	2
nop	1
dl	0
loc	31
rs	8.8571
c	0
b	0
f	0

<?php

namespace BringYourOwnIdeas\Maintenance\Forms;

use SilverStripe\ORM\DataList;
use SilverStripe\View\Requirements;
use SilverStripe\Forms\GridField\GridField_FormAction;
use SilverStripe\View\ArrayData;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Injector\Injector;
use Symbiote\QueuedJobs\Services\QueuedJobService;
use Symbiote\QueuedJobs\Services\QueuedJob;
use BringYourOwnIdeas\Maintenance\Jobs\CheckForUpdatesJob;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use SilverStripe\Forms\GridField\GridField_URLHandler;

/**
 * Adds a "Refresh" button to the bottom or top of a GridField.
 *
 * @package forms
 * @subpackage fields-gridfield
 */

class GridFieldRefreshButton implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler
{
    /**
     * @var array
     * @config
     */
    private static $allowed_actions = ["check"];


    /**
     * Fragment to write the button to.
     * @var string
     */
    protected $targetFragment;

    /**
     * @param string $targetFragment The HTML fragment to write the button into
     */
    public function __construct($targetFragment)
    {
        $this->targetFragment = $targetFragment;
    }

    /**
     * @param GridField $gridField
     * @return array
     */
    public function getHTMLFragments($gridField)
    {
        Requirements::javascript('bringyourownideas/silverstripe-maintenance: javascript/CheckForUpdates.js');

        $button = GridField_FormAction::create(
            $gridField,
            'refresh',
            _t('GridFieldRefreshButton.REFRESH', 'Check for updates'),
            'refresh',
            null
        );

        $button->addExtraClass('btn btn-secondary font-icon-sync');

        $button->setAttribute('data-check', $gridField->Link('check'));
        $button->setAttribute(
            'data-message',
            _t(
                'GridFieldRefreshButton.MESSAGE',
                'Updating this list may take 2-3 minutes. You can continue to use the CMS while we run the update.'
            )
        );

        if ($this->hasActiveJob()) {
            $button->setTitle(_t('GridFieldRefreshButton.UPDATE', 'Updating...'));
            $button->setDisabled(true);
        }

        return [
            $this->targetFragment => ArrayData::create(['Button' => $button->Field()])
                ->renderWith(__CLASS__)
        ];
    }

    /**
     * Refresh is an action button.
     *
     * @param GridField $gridField
     *
     * @return array
     */
    public function getActions($gridField)
    {
        return ['refresh'];
    }

    /**
     * Handle the refresh action.
     *
     * @param GridField $gridField
     * @param string $actionName
     * @param array $arguments
     * @param array $data
     *
     * @return null
     */
    public function handleAction(GridField $gridField, $actionName, $arguments, $data)
    {
        if ($actionName == 'refresh') {
            return $this->handleRefresh($gridField);
            return $this->/** @scrutinizer ignore-call */ handleRefresh($gridField);
        }
    }

    /**
     * Refresh is accessible via the url
     *
     * @param GridField $gridField
     * @return array
     */
    public function getURLHandlers($gridField)
    {
        return [
            'check' => 'handleCheck'
        ];
    }

    /**
     * @see hasActiveJob
     * @return string JSON boolean
     */
    public function handleCheck()
    {
        $isRunning = $this->hasActiveJob();
        return Convert::raw2json($isRunning);
    }

    /**
     * Check the queue for refresh jobs that are not 'done'
     * in one manner or another (e.g. stalled or cancelled)
     *
     * @return boolean
     */
    public function hasActiveJob()
    {
        /** @var DataList $jobList */
        $jobList = Injector::inst()
            ->get(QueuedJobService::class)
            ->getJobList(QueuedJob::QUEUED)
            ->filter([
                'Implementation' => CheckForUpdatesJob::class
            ])
            ->exclude([
                'JobStatus' => [
                    QueuedJob::STATUS_COMPLETE,
                    QueuedJob::STATUS_CANCELLED,
                    QueuedJob::STATUS_BROKEN
                ]
            ]);

        return $jobList->exists();
    }

    /**
     * Handle the refresh, for both the action button and the URL
     */
    public function handleRefresh()
    {
        if (!$this->hasActiveJob()) {
            $injector = Injector::inst();
            $injector->get(QueuedJobService::class)->queueJob($injector->create(CheckForUpdatesJob::class));
        }
    }
}


bringyourownideas / silverstripe-maintenance

Push — master ( 3da775...1e6bd3 )

GridFieldRefreshButton::getHTMLFragments() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like