Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
RemoteActionConfirmationModal Class Reference
Inheritance diagram for RemoteActionConfirmationModal:
ConfirmationModal Modal LinkActionRequest

Public Member Functions

 getLocalizedOptions ()
 
 getRemoteAction ()
 
 RemoteActionConfirmationModal ($dialogText, $title=null, $remoteAction=null, $titleIcon=null, $okButton=null, $cancelButton=null, $canClose=true)
 
- Public Member Functions inherited from ConfirmationModal
 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 ()
 

Public Attributes

 $_remoteAction
 
- Public Attributes inherited from ConfirmationModal
 $_cancelButton
 
 $_dialogText
 
 $_okButton
 
- Public Attributes inherited from Modal
 $_canClose
 
 $_title
 
 $_titleIcon
 
 $_width
 

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.

Member Function Documentation

RemoteActionConfirmationModal::getLocalizedOptions ( )
RemoteActionConfirmationModal::getRemoteAction ( )

Get the remote action.

Returns
string

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

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

Constructor

Parameters
$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 41 of file RemoteActionConfirmationModal.inc.php.

Member Data Documentation

string RemoteActionConfirmationModal::$_remoteAction

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

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


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