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

Public Member Functions

 __construct ($dialogText, $event='confirmationModalConfirmed', $extraArguments=null, $title=null, $titleIcon=null, $okButton=null, $cancelButton=null, $canClose=true)
 
 getEvent ()
 
 getExtraArguments ()
 
 getLocalizedOptions ()
 
- 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

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

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

Constructor & Destructor Documentation

◆ __construct()

JsEventConfirmationModal::__construct (   $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.

Member Function Documentation

◆ getEvent()

JsEventConfirmationModal::getEvent ( )

Get the event.

Returns
string

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

References $_event.

Referenced by getLocalizedOptions().

◆ getExtraArguments()

JsEventConfirmationModal::getExtraArguments ( )

Get the extra arguments.

Returns
string

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

References $_extraArguments.

Referenced by getLocalizedOptions().

◆ getLocalizedOptions()

JsEventConfirmationModal::getLocalizedOptions ( )
See also
LinkActionRequest::getLocalizedOptions()

Reimplemented from ConfirmationModal.

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

References getEvent(), and getExtraArguments().

Field Documentation

◆ $_event

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

◆ $_extraArguments

array JsEventConfirmationModal::$_extraArguments

extra arguments to be passed to the JS controller

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

Referenced by getExtraArguments().


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