Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
ConfirmationModal Class Reference
Inheritance diagram for ConfirmationModal:
Modal LinkActionRequest RedirectConfirmationModal RemoteActionConfirmationModal

Public Member Functions

 ConfirmationModal ($dialogText, $title=null, $titleIcon= 'modal_confirm', $okButton=null, $cancelButton=null, $canClose=true, $width=MODAL_WIDTH_AUTO)
 
 getCancelButton ()
 
 getDialogText ()
 
 getLocalizedOptions ()
 
 getOkButton ()
 
- Public Member Functions inherited from Modal
 getCanClose ()
 
 getJSLinkActionRequest ()
 
 getLocalizedOptions ()
 
 getTitle ()
 
 getTitleIcon ()
 
 getWidth ()
 
 Modal ($title=null, $titleIcon=null, $canClose=true, $width=MODAL_WIDTH_DEFAULT)
 
- Public Member Functions inherited from LinkActionRequest
 getJSLinkActionRequest ()
 
 getLocalizedOptions ()
 
 LinkActionRequest ()
 

Detailed Description

Class defining a simple confirmation modal either with remote action or not.

Definition at line 18 of file ConfirmationModal.inc.php.

Member Function Documentation

ConfirmationModal::ConfirmationModal (   $dialogText,
  $title = null,
  $titleIcon = 'modal_confirm',
  $okButton = null,
  $cancelButton = null,
  $canClose = true,
  $width = MODAL_WIDTH_AUTO 
)

Constructor

Parameters
$dialogTextstring The localized text to appear in the dialog modal.
$titlestring (optional) The localized modal title.
$titleIconstring (optional) The icon to be used in the modal title bar.
$okButtonstring (optional) The localized text to appear on the confirmation button.
$cancelButtonstring (optional) The localized text to appear on the cancel button.
$canCloseboolean (optional) Whether the modal will have a close button.
$widthint (optional) Override the default width of 'auto' for confirmation modals. Useful for modals that display large blocks of text.

Definition at line 54 of file ConfirmationModal.inc.php.

ConfirmationModal::getCancelButton ( )

Get the translation key for the cancel button text.

Returns
string

Definition at line 82 of file ConfirmationModal.inc.php.

Referenced by getLocalizedOptions().

ConfirmationModal::getDialogText ( )

Get the translation key for the dialog text.

Returns
string

Definition at line 91 of file ConfirmationModal.inc.php.

Referenced by getLocalizedOptions().

ConfirmationModal::getLocalizedOptions ( )
ConfirmationModal::getOkButton ( )

Get the translation key for the confirmation button text.

Returns
string

Definition at line 73 of file ConfirmationModal.inc.php.

Referenced by getLocalizedOptions().


The documentation for this class was generated from the following file: