Référence de la classe PopupButton

Graphe d'héritage de PopupButton:

Fonctions membres publiques
	fetchButton ( $type='Modal', $name='', $text='', $url='', $iframeWidth=640, $iframeHeight=480, $bodyHeight=null, $modalWidth=null, $onClose='', $title='', $footer=null)
Fonctions membres publiques hérités de ToolbarButton
	__construct (string $name='', string $text='', array $options=[])
	render (&$definition=null)
	fetchIconClass ($identifier)
	fetchButton ()
	getParent ()
	setParent (Toolbar $parent)
	getOptions ()
	setOptions (array $options)
	getOption (string $name, $default=null)
	setOption (string $name, $value)
	getName ()
	name (string $name)
	getLayout ()
	layout (string $layout)
	__call (string $name, array $args)

Fonctions membres protégées
	prepareOptions (array &$options)
	renderButton (array &$options)
Fonctions membres protégées hérités de ToolbarButton
	prepareOptions (array &$options)
	renderButton (array &$options)
	fetchId ()
	ensureUniqueId (string $id)

Fonctions membres protégées statiques
static	getAccessors ()
Fonctions membres protégées statiques hérités de ToolbarButton
static	getAccessors ()

Attributs protégés
	$layout = 'joomla.toolbar.popup'
Attributs protégés hérités de ToolbarButton
	$name
	$parent
	$layout
	$options = []

Fonctions membres privées
	_getCommand ($url)

Membres hérités additionnels
Attributs protégés statiques hérités de ToolbarButton
static	$idCounter = []

Description détaillée

Renders a modal window button

self url(string $value) self icon(string $value) self iframeWidth(int $value) self iframeHeight(int $value) self bodyHeight(int $value) self modalWidth(int $value) self onclose(string $value) self title(string $value) self footer(string $value) self selector(string $value) self listCheck(bool $value) string getUrl() int getIframeWidth() int getIframeHeight() int getBodyHeight() int getModalWidth() string getOnclose() string getTitle() string getFooter() string getSelector() bool getListCheck()

Depuis

3.0

Documentation des fonctions membres

_getCommand()

_getCommand (   $url )

private

Get the JavaScript command for the button

Paramètres

string

$url

URL for popup

Renvoie

string JavaScript command string

Depuis

3.0

Références $url, et Uri\base().

fetchButton()

fetchButton	(		$type = 'Modal',
			$name = '',
			$text = '',
			$url = '',
			$iframeWidth = 640,
			$iframeHeight = 480,
			$bodyHeight = null,
			$modalWidth = null,
			$onClose = '',
			$title = '',
			$footer = null
	)

Fetch the HTML for the button

Paramètres

string	$type	Unused string, formerly button type.
string	$name	Modal name, used to generate element ID
string	$text	The link text
string	$url	URL for popup
integer	$iframeWidth	Width of popup
integer	$iframeHeight	Height of popup
integer	$bodyHeight	Optional height of the modal body in viewport units (vh)
integer	$modalWidth	Optional width of the modal in viewport units (vh)
string	$onClose	JavaScript for the onClose event.
string	$title	The title text
string	$footer	The footer html

Renvoie

string HTML string for the button

Depuis

3.0

Références $bodyHeight, $modalWidth, $name, $text, $title, $url, et name.

getAccessors()

static getAccessors ( )

staticprotected

Method to configure available option accessors.

Renvoie

array

Depuis

4.0.0

prepareOptions()

prepareOptions ( array &  $options )

protected

Prepare options for this button.

Paramètres

array

$options

The options about this button.

Renvoie

void

Depuis

4.0.0

Références $options.

renderButton()

renderButton ( array &  $options )

protected

Render button HTML.

Paramètres

array

$options

The button options.

Renvoie

string The button HTML.

Depuis

4.0.0

Références $html, $options, $params, $selector, HTMLHelper\_(), Factory\getDocument(), et null.

Documentation des champs

$layout

$layout = 'joomla.toolbar.popup'

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• PopupButton.php