Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($dialogText, $event='confirmationModalConfirmed', $extraArguments=null, $title=null, $titleIcon=null, $okButton=null, $cancelButton=null, $canClose=true) | |
getEvent () | |
getExtraArguments () | |
getLocalizedOptions () | |
Public Member Functions inherited from ConfirmationModal | |
__construct ($dialogText, $title=null, $titleIcon='modal_confirm', $okButton=null, $cancelButton=null, $canClose=true) | |
getCancelButton () | |
getDialogText () | |
getOkButton () | |
Public Member Functions inherited from Modal | |
__construct ($title=null, $titleIcon=null, $canClose=true, $closeOnFormSuccessId=null, $closeCleanVueInstances=[]) | |
getCanClose () | |
getCloseButtonText () | |
getJSLinkActionRequest () | |
getTitle () | |
getTitleIcon () | |
Public Member Functions inherited from LinkActionRequest | |
__construct () | |
Data Fields | |
$_event | |
$_extraArguments | |
Data Fields inherited from ConfirmationModal | |
$_cancelButton | |
$_dialogText | |
$_okButton | |
Data Fields inherited from Modal | |
$_canClose | |
$_closeCleanVueInstances | |
$_closeOnFormSuccessId | |
$_title | |
$_titleIcon | |
Class defining a simple confirmation modal which generates a JS event and ok/cancel buttons.
Definition at line 18 of file JsEventConfirmationModal.inc.php.
JsEventConfirmationModal::__construct | ( | $dialogText, | |
$event = 'confirmationModalConfirmed' , |
|||
$extraArguments = null , |
|||
$title = null , |
|||
$titleIcon = null , |
|||
$okButton = null , |
|||
$cancelButton = null , |
|||
$canClose = true |
|||
) |
Constructor
$dialogText | string The localized text to appear in the dialog modal. |
$event | string the name of the JS event. |
$extraArguments | array (optional) extra information to be passed as JSON data with the event. |
$title | string (optional) The localized modal title. |
$remoteUrl | string (optional) A URL to be redirected to when the confirmation button is clicked. |
$titleIcon | string (optional) The icon to be used in the modal title bar. |
$okButton | string (optional) The localized text to appear on the confirmation button. |
$cancelButton | string (optional) The localized text to appear on the cancel button. |
$canClose | boolean (optional) Whether the modal will have a close button. |
Definition at line 49 of file JsEventConfirmationModal.inc.php.
JsEventConfirmationModal::getEvent | ( | ) |
Get the event.
Definition at line 64 of file JsEventConfirmationModal.inc.php.
References $_event.
Referenced by getLocalizedOptions().
JsEventConfirmationModal::getExtraArguments | ( | ) |
Get the extra arguments.
Definition at line 72 of file JsEventConfirmationModal.inc.php.
References $_extraArguments.
Referenced by getLocalizedOptions().
JsEventConfirmationModal::getLocalizedOptions | ( | ) |
Reimplemented from ConfirmationModal.
Definition at line 83 of file JsEventConfirmationModal.inc.php.
References getEvent(), and getExtraArguments().
string JsEventConfirmationModal::$_event |
The name of the event to be generated when this modal is confirmed
Definition at line 23 of file JsEventConfirmationModal.inc.php.
Referenced by getEvent().
array JsEventConfirmationModal::$_extraArguments |
extra arguments to be passed to the JS controller
Definition at line 29 of file JsEventConfirmationModal.inc.php.
Referenced by getExtraArguments().