Open Journal Systems  3.3.0
AjaxModal Class Reference
Inheritance diagram for AjaxModal:
Modal LinkActionRequest WizardModal

Public Member Functions

 __construct ($url, $title=null, $titleIcon=null, $canClose=true, $closeOnFormSuccessId=null, $closeCleanVueInstances=[])
 
 getLocalizedOptions ()
 
 getUrl ()
 
- 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

 $_url
 
- Data Fields inherited from Modal
 $_canClose
 
 $_closeCleanVueInstances
 
 $_closeOnFormSuccessId
 
 $_title
 
 $_titleIcon
 

Detailed Description

A modal that retrieves its content from via AJAX.

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

Constructor & Destructor Documentation

◆ __construct()

AjaxModal::__construct (   $url,
  $title = null,
  $titleIcon = null,
  $canClose = true,
  $closeOnFormSuccessId = null,
  $closeCleanVueInstances = [] 
)

Constructor

Parameters
$urlstring The URL of the AJAX resource to load into the modal.
$titlestring (optional) The localized modal title.
$titleIconstring (optional) The icon to be used in the modal title bar.
$canCloseboolean (optional) Whether the modal will have a close button.
$closeOnFormSuccessIdstring (optional) Close the modal when the form with this id fires a formSuccess event.
$closeCleanVueInstancesarray (optional) When the modal is closed destroy the registered vue instances with these ids

Definition at line 36 of file AjaxModal.inc.php.

Member Function Documentation

◆ getLocalizedOptions()

AjaxModal::getLocalizedOptions ( )
See also
LinkActionRequest::getLocalizedOptions()

Reimplemented from Modal.

Reimplemented in WizardModal.

Definition at line 62 of file AjaxModal.inc.php.

References getUrl().

◆ getUrl()

AjaxModal::getUrl ( )

Get the URL to be loaded into the modal.

Returns
string

Definition at line 51 of file AjaxModal.inc.php.

References $_url.

Referenced by getLocalizedOptions().

Field Documentation

◆ $_url

string AjaxModal::$_url

The URL to be loaded into the modal.

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

Referenced by getUrl().


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