Open Journal Systems  3.3.0
RemoteActionConfirmationModal Class Reference
Inheritance diagram for RemoteActionConfirmationModal:
ConfirmationModal Modal LinkActionRequest

Public Member Functions

 __construct ($session, $dialogText, $title=null, $remoteAction=null, $titleIcon=null, $okButton=null, $cancelButton=null, $canClose=true)
 
 getCSRFToken ()
 
 getLocalizedOptions ()
 
 getRemoteAction ()
 
- 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

 $_csrfToken
 
 $_remoteAction
 
- Data Fields inherited from ConfirmationModal
 $_cancelButton
 
 $_dialogText
 
 $_okButton
 
- Data Fields inherited from Modal
 $_canClose
 
 $_closeCleanVueInstances
 
 $_closeOnFormSuccessId
 
 $_title
 
 $_titleIcon
 

Detailed Description

Class defining a simple confirmation modal with a remote action and ok/cancel buttons.

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

Constructor & Destructor Documentation

◆ __construct()

RemoteActionConfirmationModal::__construct (   $session,
  $dialogText,
  $title = null,
  $remoteAction = null,
  $titleIcon = null,
  $okButton = null,
  $cancelButton = null,
  $canClose = true 
)

Constructor

Parameters
$sessionSession The user's session object.
$dialogTextstring The localized text to appear in the dialog modal.
$titlestring (optional) The localized modal title.
$remoteActionstring (optional) A URL to be called when the confirmation button is clicked.
$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.

Definition at line 48 of file RemoteActionConfirmationModal.inc.php.

Member Function Documentation

◆ getCSRFToken()

RemoteActionConfirmationModal::getCSRFToken ( )

Get the CSRF token.

Returns
string

Definition at line 71 of file RemoteActionConfirmationModal.inc.php.

References $_csrfToken.

Referenced by getLocalizedOptions().

◆ getLocalizedOptions()

RemoteActionConfirmationModal::getLocalizedOptions ( )

◆ getRemoteAction()

RemoteActionConfirmationModal::getRemoteAction ( )

Get the remote action.

Returns
string

Definition at line 63 of file RemoteActionConfirmationModal.inc.php.

References $_remoteAction.

Referenced by getLocalizedOptions().

Field Documentation

◆ $_csrfToken

string RemoteActionConfirmationModal::$_csrfToken

A CSRF token.

Definition at line 29 of file RemoteActionConfirmationModal.inc.php.

Referenced by getCSRFToken().

◆ $_remoteAction

string RemoteActionConfirmationModal::$_remoteAction

A URL to be called when the confirmation button is clicked.

Definition at line 23 of file RemoteActionConfirmationModal.inc.php.

Referenced by getRemoteAction().


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