Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($dialogText, $title=null, $titleIcon='modal_confirm', $okButton=null, $cancelButton=null, $canClose=true) | |
getCancelButton () | |
getDialogText () | |
getLocalizedOptions () | |
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 | |
$_cancelButton | |
$_dialogText | |
$_okButton | |
Data Fields inherited from Modal | |
$_canClose | |
$_closeCleanVueInstances | |
$_closeOnFormSuccessId | |
$_title | |
$_titleIcon | |
Class defining a simple confirmation modal either with remote action or not.
Definition at line 18 of file ConfirmationModal.inc.php.
ConfirmationModal::__construct | ( | $dialogText, | |
$title = null , |
|||
$titleIcon = 'modal_confirm' , |
|||
$okButton = null , |
|||
$cancelButton = null , |
|||
$canClose = true |
|||
) |
Constructor
$dialogText | string The localized text to appear in the dialog modal. |
$title | string (optional) The localized modal title. |
$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. |
$width | int (optional) Override the default width of 'auto' for confirmation modals. Useful for modals that display large blocks of text. |
Definition at line 63 of file ConfirmationModal.inc.php.
ConfirmationModal::getCancelButton | ( | ) |
Get the translation key for the cancel button text.
Definition at line 91 of file ConfirmationModal.inc.php.
References $_cancelButton.
Referenced by getLocalizedOptions().
ConfirmationModal::getDialogText | ( | ) |
Get the translation key for the dialog text.
Definition at line 100 of file ConfirmationModal.inc.php.
References $_dialogText.
Referenced by getLocalizedOptions().
ConfirmationModal::getLocalizedOptions | ( | ) |
Reimplemented from Modal.
Reimplemented in JsEventConfirmationModal, RemoteActionConfirmationModal, and RedirectConfirmationModal.
Definition at line 111 of file ConfirmationModal.inc.php.
References getCancelButton(), getDialogText(), and getOkButton().
ConfirmationModal::getOkButton | ( | ) |
Get the translation key for the confirmation button text.
Definition at line 82 of file ConfirmationModal.inc.php.
References $_okButton.
Referenced by getLocalizedOptions().
string ConfirmationModal::$_cancelButton |
a translation key defining the text for the cancel button of the modal.
Definition at line 35 of file ConfirmationModal.inc.php.
Referenced by getCancelButton().
string ConfirmationModal::$_dialogText |
a translation key defining the text for the dialog text.
Definition at line 44 of file ConfirmationModal.inc.php.
Referenced by getDialogText().
string ConfirmationModal::$_okButton |
A translation key defining the text for the confirmation button of the modal.
Definition at line 26 of file ConfirmationModal.inc.php.
Referenced by getOkButton().