\Dewdrop\Fields\Listing\BulkActionsResult

Communicate the result of processing your action. You can include a message and also specify whether it was successful or failed (e.g. an input validation error of some kind).

Summary

Methods
Properties
Constants
__construct()
getMessage()
isSuccess()
isFailure()
No public properties found
SUCCESS
FAILURE
No protected methods found
No protected properties found
N/A
No private methods found
$message
N/A

Constants

SUCCESS

SUCCESS

The process() method completed successfully.

FAILURE

FAILURE

The process() method failed to complete.

Properties

$message

$message : string

A message to display to the user letting them know who things went.

Plain-text only. Will be escaped.

Type

string

Methods

__construct()

__construct(boolean  $result, string  $message) 

Provide the message and success/failure result.

Parameters

boolean $result
string $message

Throws

\Dewdrop\Fields\Listing\BulkActions\Exception

getMessage()

getMessage() : string

Get the message that should be displayed with this result.

Returns

string

isSuccess()

isSuccess() : boolean

Check to see if the process() succeeded.

Returns

boolean

isFailure()

isFailure() : boolean

Check to see if the process() failed.

Returns

boolean