BringYourOwnIdeas\Maintenance\Forms\GridFieldRefreshButton
Adds a "Refresh" button to the bottom or top of a GridField.
Synopsis
class GridFieldRefreshButton
implements
GridField_HTMLProvider,GridField_ActionProvider,GridField_URLHandler
{
- // members
- private static array $dependencies = ;
- private static array $allowed_actions = ;
- protected $targetFragment;
- protected QueuedJobService $queuedJobService;
- // methods
- public void __construct()
- public array getHTMLFragments()
- public array getActions()
- public null handleAction()
- public array getURLHandlers()
- public string handleCheck()
- public boolean hasPendingJob()
- public void handleRefresh()
- public QueuedJobService getQueuedJobService()
- public $this setQueuedJobService()
Hierarchy
Implements
- SilverStripe\Forms\GridField\GridField_HTMLProvider
- SilverStripe\Forms\GridField\GridField_ActionProvider
- SilverStripe\Forms\GridField\GridField_URLHandler
Members
private
- $allowed_actions — array
- $dependencies
protected
- $queuedJobService — Symbiote\QueuedJobs\Services\QueuedJobService
- $targetFragment
—
string
Fragment to write the button to.
Methods
public
- __construct()
- getActions() — Refresh is an action button.
- getHTMLFragments()
- getQueuedJobService()
- getURLHandlers() — Refresh is accessible via the url
- handleAction() — Handle the refresh action.
- handleCheck()
- handleRefresh() — Handle the refresh, for both the action button and the URL
- hasPendingJob() — Check the queue for refresh jobs that are not 'done' in one manner or another (e.g. stalled or cancelled)
- setQueuedJobService()