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

Public Member Functions

 getEvent ()
 
 getExtraArguments ()
 
 getLocalizedOptions ()
 
 JsEventConfirmationModal ($dialogText, $event= 'confirmationModalConfirmed', $extraArguments=null, $title=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

 $_event
 
 $_extraArguments
 
- 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 which generates a JS event and ok/cancel buttons.

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

Member Function Documentation

JsEventConfirmationModal::getEvent ( )

Get the event.

Returns
string

Definition at line 64 of file JsEventConfirmationModal.inc.php.

Referenced by getExtraArguments().

JsEventConfirmationModal::getExtraArguments ( )

Get the extra arguments.

Returns
string

Definition at line 72 of file JsEventConfirmationModal.inc.php.

References getEvent().

JsEventConfirmationModal::getLocalizedOptions ( )
JsEventConfirmationModal::JsEventConfirmationModal (   $dialogText,
  $event = 'confirmationModalConfirmed',
  $extraArguments = null,
  $title = null,
  $titleIcon = null,
  $okButton = null,
  $cancelButton = null,
  $canClose = true 
)

Constructor

Parameters
$dialogTextstring The localized text to appear in the dialog modal.
$eventstring the name of the JS event.
$extraArgumentsarray (optional) extra information to be passed as JSON data with the event.
$titlestring (optional) The localized modal title.
$remoteUrlstring (optional) A URL to be redirected to 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 49 of file JsEventConfirmationModal.inc.php.

References $_event.

Member Data Documentation

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 JsEventConfirmationModal().

array JsEventConfirmationModal::$_extraArguments

extra arguments to be passed to the JS controller

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


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