PopupButton

Extends \Joomla\CMS\Toolbar\ToolbarButton

Renders a modal window button

since

3.0

Methods

__call

Magiix method to adapt option accessors.

__call(string $name, array $args) : mixed
inherited
throws

\LogicException

since

4.0.0

Arguments

$name

stringThe method name.

$args

arrayThe method arguments.

Response

mixed

__construct

Init this class.

__construct(string $name = '', string $text = '', array $options = array()) 
inherited
since

4.0.0

throws

\InvalidArgumentException

Arguments

$name

stringName of this button.

$text

stringThe button text, will auto translate.

$options

arrayButton options.

_getCommand

Get the JavaScript command for the button

_getCommand(string $url) : string
since

3.0

Arguments

$url

stringURL for popup

Response

stringJavaScript command string

attributes

attributes(array $value) : self
inherited

Arguments

$value

array

Response

self

bodyHeight

bodyHeight(integer $value) : self

Arguments

$value

integer

Response

self

buttonClass

buttonClass(string $value) : self
inherited

Arguments

$value

string

Response

self

ensureUniqueId

Make sure the id is unique

ensureUniqueId(string $id) : string
inherited
since

4.0.0

Arguments

$id

stringThe id string.

Response

string

fetchButton

Get the button

fetchButton() : string
inherited abstract deprecated

Defined in the final button class

since

3.0

deprecated

5.0 Use render() instead.

Response

string

fetchIconClass

Method to get the CSS class name for an icon identifier

fetchIconClass(string $identifier) : string
inherited

Can be redefined in the final class

since

3.0

Arguments

$identifier

stringIcon identification string

Response

stringCSS class name

fetchId

Get the button CSS Id.

fetchId() : string
inherited
since

3.0

Response

stringButton CSS Id

findOptionName

Find field option name from accessors.

findOptionName(string $name) : boolean|string
inherited static
since

4.0.0

Arguments

$name

stringThe field name.

Response

boolean|string

form

form(string $value) : self
inherited

Arguments

$value

string

Response

self

formValidation

formValidation(boolean $value) : self
inherited

Arguments

$value

boolean

Response

self

getAccessors

Method to configure available option accessors.

getAccessors() : array
inherited static
since

4.0.0

Response

array

getAttributes

getAttributes() : array
inherited

Response

array

getBodyHeight

getBodyHeight() : integer

Response

integer

getButtonClass

getButtonClass() : string
inherited

Response

string

getFooter

getFooter() : string

Response

string

getForm

getForm() : string
inherited

Response

string

getFormValidation

getFormValidation() : boolean
inherited

Response

boolean

getIcon

getIcon() : string
inherited

Response

string

getIframeHeight

getIframeHeight() : integer

Response

integer

getIframeWidth

getIframeWidth() : integer

Response

integer

getLayout

Get layout path.

getLayout() : string
inherited
since

4.0.0

Response

string

getListCheck

getListCheck() : boolean
inherited

Response

boolean

getListCheck

getListCheck() : boolean

Response

boolean

getListCheckMessage

getListCheckMessage() : string
inherited

Response

string

getModalWidth

getModalWidth() : integer

Response

integer

getName

Get button name.

getName() : string
inherited
since

4.0.0

Response

string

getOnclick

getOnclick() : string
inherited

Response

string

getOnclose

getOnclose() : string

Response

string

getOption

Get single option value.

getOption(string $name, mixed $default = null) : mixed
inherited
since

4.0.0

Arguments

$name

stringThe option name.

$default

mixedThe default value if this name not exists.

Response

mixed

getOptions

Get button options.

getOptions() : array
inherited
since

4.0.0

Response

array

getParent

Get parent toolbar instance.

getParent() : \Joomla\CMS\Toolbar\Toolbar
inherited
since

4.0.0

Response

\Joomla\CMS\Toolbar\Toolbar

getSelector

getSelector() : string

Response

string

getTask

getTask() : string
inherited

Response

string

getText

getText() : string
inherited

Response

string

getTitle

getTitle() : string

Response

string

getUrl

getUrl() : string

Response

string

icon

icon(string $value) : self

Arguments

$value

string

Response

self

icon

icon(string $value) : self
inherited

Arguments

$value

string

Response

self

iframeHeight

iframeHeight(integer $value) : self

Arguments

$value

integer

Response

self

iframeWidth

iframeWidth(integer $value) : self

Arguments

$value

integer

Response

self

layout

Set layout path.

layout(string $layout) : static
inherited
since

4.0.0

Arguments

$layout

stringThe layout path name to render.

Response

staticReturn self to support chaining.

listCheck

listCheck(boolean $value) : self
inherited

Arguments

$value

boolean

Response

self

listCheck

listCheck(boolean $value) : self

Arguments

$value

boolean

Response

self

listCheckMessage

listCheckMessage(string $value) : self
inherited

Arguments

$value

string

Response

self

modalWidth

modalWidth(integer $value) : self

Arguments

$value

integer

Response

self

name

Set button name.

name(string $name) : static
inherited
since

4.0.0

Arguments

$name

stringThe button name.

Response

staticReturn self to support chaining.

onclick

onclick(array $value) : self
inherited

Arguments

$value

array

Response

self

onclose

onclose(string $value) : self

Arguments

$value

string

Response

self

prepareOptions

Prepare options for this button.

prepareOptions(array &$options) : void
inherited
since

4.0.0

Arguments

$options

array

render

Get the HTML to render the button

render( &$definition = null) : string
inherited
since

3.0

throws

\Exception

Arguments

$definition

Response

string

renderButton

Render button HTML.

renderButton(array &$options) : string
inherited
since

4.0.0

Arguments

$options

array

Response

stringThe button HTML.

selector

selector(string $value) : self

Arguments

$value

string

Response

self

setOption

Set option value.

setOption(string $name, mixed $value) : static
inherited
since

4.0.0

Arguments

$name

stringThe option name to store value.

$value

mixedThe option value.

Response

static

setOptions

Set all options.

setOptions(array $options) : static
inherited
since

4.0.0

Arguments

$options

arrayThe button options.

Response

staticReturn self to support chaining.

setParent

Set parent Toolbar instance.

setParent(\Joomla\CMS\Toolbar\Toolbar $parent) : static
inherited
since

4.0.0

Arguments

$parent

\Joomla\CMS\Toolbar\ToolbarThe parent Toolbar instance to set.

Response

staticReturn self to support chaining.

task

task(string $value) : self
inherited

Arguments

$value

string

Response

self

text

text(string $value) : self
inherited

Arguments

$value

string

Response

self

title

title(string $value) : self

Arguments

$value

string

Response

self

url

url(string $value) : self

Arguments

$value

string

Response

self

Properties

layout

The layout path to render this button.

inherited
since

4.0.0

Type(s)

string

name

Name of this button.

inherited
since

4.0.0

Type(s)

string

parent

Reference to the object that instantiated the element

inherited
since

4.0.0

Type(s)

\Joomla\CMS\Toolbar\Toolbar

options

Button options.

inherited
since

4.0.0

Type(s)

array

idCounter

Used to track an ids, to avoid duplication

inherited static
since

4.0.0

Type(s)

array