Modal Class Reference

Inheritance diagram for Modal:

Public Member Functions
	__construct ($title=null, $titleIcon=null, $canClose=true, $closeOnFormSuccessId=null, $closeCleanVueInstances=[])
	getCanClose ()
	getCloseButtonText ()
	getJSLinkActionRequest ()
	getLocalizedOptions ()
	getTitle ()
	getTitleIcon ()
Public Member Functions inherited from LinkActionRequest
	__construct ()

Data Fields
	$_canClose
	$_closeCleanVueInstances
	$_closeOnFormSuccessId
	$_title
	$_titleIcon

Detailed Description

Abstract base class for all modal dialogs.

Definition at line 21 of file Modal.inc.php.

Constructor & Destructor Documentation

__construct()

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

Constructor

Parameters

$title	string (optional) The localized modal title.
$titleIcon	string (optional) The icon to be used in the modal title bar.
$canClose	boolean (optional) Whether the modal will have a close button.
$width	int (optional) Override the default width of 'auto' for confirmation modals. Useful for modals that display large blocks of text.
$closeOnFormSuccessId	string (optional) Close the modal when the form with this id fires a formSuccess event.
$closeCleanVueInstances	array (optional) When the modal is closed destroy the registered vue instances with these ids

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

Member Function Documentation

getCanClose()

Modal::getCanClose

(

)

Whether the modal has a close icon in the title bar.

Returns

boolean

Definition at line 101 of file Modal.inc.php.

References $_canClose.

Referenced by getLocalizedOptions().

getCloseButtonText()

Modal::getCloseButtonText

(

)

Get the text to be displayed on the close button for screen readers

Definition at line 108 of file Modal.inc.php.

Referenced by getLocalizedOptions().

getJSLinkActionRequest()

Modal::getJSLinkActionRequest

(

)

See also

LinkActionRequest::getJSLinkActionRequest()

Reimplemented from LinkActionRequest.

Definition at line 119 of file Modal.inc.php.

getLocalizedOptions()

Modal::getLocalizedOptions

(

)

See also

LinkActionRequest::getLocalizedOptions()

Reimplemented from LinkActionRequest.

Reimplemented in ConfirmationModal, JsEventConfirmationModal, RemoteActionConfirmationModal, RedirectConfirmationModal, AjaxModal, and WizardModal.

Definition at line 126 of file Modal.inc.php.

References getCanClose(), getCloseButtonText(), getTitle(), and getTitleIcon().

getTitle()

Modal::getTitle

(

)

Get the localized title.

Returns

string

Definition at line 85 of file Modal.inc.php.

References $_title.

Referenced by getLocalizedOptions().

getTitleIcon()

Modal::getTitleIcon

(

)

Get the title bar icon.

Returns

string

Definition at line 93 of file Modal.inc.php.

References $_titleIcon.

Referenced by getLocalizedOptions().

Field Documentation

$_canClose

boolean Modal::$_canClose

Whether the modal has a close icon in the title bar.

Definition at line 38 of file Modal.inc.php.

Referenced by getCanClose().

$_closeCleanVueInstances

array Modal::$_closeCleanVueInstances

The id of any Vue instances that must be destroyed when modal closed

Definition at line 50 of file Modal.inc.php.

$_closeOnFormSuccessId

string Modal::$_closeOnFormSuccessId

The id of a form which should close the modal when completed

Definition at line 44 of file Modal.inc.php.

$_title

string Modal::$_title

The localized title of the modal.

Definition at line 26 of file Modal.inc.php.

Referenced by getTitle().

$_titleIcon

string Modal::$_titleIcon

The icon to be displayed in the title bar.

Definition at line 32 of file Modal.inc.php.

Referenced by getTitleIcon().

---

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

• Modal.inc.php