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

Public Member Functions

 __construct ($dialogText, $title=null, $remoteUrl=null, $titleIcon=null, $okButton=null, $cancelButton=null, $canClose=true)
 
 getLocalizedOptions ()
 
 getRemoteUrl ()
 
- 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

 $_remoteUrl
 
- 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 redirect url and ok/cancel buttons.

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

Constructor & Destructor Documentation

◆ __construct()

RedirectConfirmationModal::__construct (   $dialogText,
  $title = null,
  $remoteUrl = 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.
$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 41 of file RedirectConfirmationModal.inc.php.

Member Function Documentation

◆ getLocalizedOptions()

RedirectConfirmationModal::getLocalizedOptions ( )
See also
LinkActionRequest::getLocalizedOptions()

Reimplemented from ConfirmationModal.

Definition at line 65 of file RedirectConfirmationModal.inc.php.

References getRemoteUrl().

◆ getRemoteUrl()

RedirectConfirmationModal::getRemoteUrl ( )

Get the remote url.

Returns
string

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

References $_remoteUrl.

Referenced by getLocalizedOptions().

Field Documentation

◆ $_remoteUrl

string RedirectConfirmationModal::$_remoteUrl

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

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

Referenced by getRemoteUrl().


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