GridFieldRefreshButton
class GridFieldRefreshButton implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler (View source)
Adds a "Refresh" button to the bottom or top of a GridField.
Properties
| protected | string | $targetFragment | Fragment to write the button to. |
|
| protected | QueuedJobService | $queuedJobService |
Methods
public
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
Handle the refresh action.
public
bool
hasPendingJob()
Check the queue for refresh jobs that are not 'done' in one manner or another (e.g. stalled or cancelled)
Details
__construct(string $targetFragment)
No description
array
getHTMLFragments(GridField $gridField)
No description
array
getActions(GridField $gridField)
Refresh is an action button.
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
Handle the refresh action.
array
getURLHandlers(GridField $gridField)
Refresh is accessible via the url
string
handleCheck()
No description
bool
hasPendingJob()
Check the queue for refresh jobs that are not 'done' in one manner or another (e.g. stalled or cancelled)
handleRefresh()
Handle the refresh, for both the action button and the URL
QueuedJobService
getQueuedJobService()
No description
$this
setQueuedJobService(QueuedJobService $queuedJobService)
No description