Page::getButtonName()

Page::getButtonName() – Returns a name for a submit button that will invoke a specific action.

Synopsis

require_once 'HTML/QuickForm/Page.php';

string HTML_QuickForm_Page::getButtonName ( string $actionName )

Description

Returns a name for a submit button (or an <input type="image"> control) that will invoke a specific action. This means the following: if you do


<?php
$this->addElement('submit', $this->getButtonName('foo'), 'Foo');
?>

inside the buildForm() method and the user later uses this button to submit the form, then the 'foo' handler (added via addAction() will be called.

Parameter

string $actionName: Name of the action

Return value

returns "name" attribute for a submit button

Throws

throws no exceptions thrown

Note

This function can not be called statically.