* The constructor input is an associative array of $fieldname => $info,
* where $info is an Associative Array with any of the following:
*
- * 'class' -- the subclass of HTMLFormField that will be used
- * to create the object. *NOT* the CSS class!
- * 'type' -- roughly translates into the <select> type attribute.
- * if 'class' is not specified, this is used as a map
- * through HTMLForm::$typeMappings to get the class name.
- * 'default' -- default value when the form is displayed
- * 'id' -- HTML id attribute
- * 'options' -- varies according to the specific object.
- * 'label-message' -- message key for a message to use as the label.
- * can be an array of msg key and then parameters to
- * the message.
- * 'label' -- alternatively, a raw text message. Overridden by
- * label-message
- * 'help-message' -- message key for a message to use as a help text.
- * can be an array of msg key and then parameters to
- * the message.
- * 'required' -- passed through to the object, indicating that it
- * is a required field.
- * 'size' -- the length of text fields
- * 'filter-callback -- a function name to give you the chance to
- * massage the inputted value before it's processed.
- * @see HTMLForm::filter()
- * 'validation-callback' -- a function name to give you the chance
- * to impose extra validation on the field input.
- * @see HTMLForm::validate()
- *
+ * 'class' -- the subclass of HTMLFormField that will be used
+ * to create the object. *NOT* the CSS class!
+ * 'type' -- roughly translates into the <select> type attribute.
+ * if 'class' is not specified, this is used as a map
+ * through HTMLForm::$typeMappings to get the class name.
+ * 'default' -- default value when the form is displayed
+ * 'id' -- HTML id attribute
+ * 'options' -- varies according to the specific object.
+ * 'label-message' -- message key for a message to use as the label.
+ * can be an array of msg key and then parameters to
+ * the message.
+ * 'label' -- alternatively, a raw text message. Overridden by
+ * label-message
+ * 'help-message' -- message key for a message to use as a help text.
+ * can be an array of msg key and then parameters to
+ * the message.
+ * 'required' -- passed through to the object, indicating that it
+ * is a required field.
+ * 'size' -- the length of text fields
+ * 'filter-callback -- a function name to give you the chance to
+ * massage the inputted value before it's processed.
+ * @see HTMLForm::filter()
+ * 'validation-callback' -- a function name to give you the chance
+ * to impose extra validation on the field input.
+ * @see HTMLForm::validate()
+ *
* TODO: Document 'section' / 'subsection' stuff
*/
class HTMLForm {
# A mapping of 'type' inputs onto standard HTMLFormField subclasses
static $typeMappings = array(
'text' => 'HTMLTextField',
+ 'textarea' => 'HTMLTextAreaField',
'select' => 'HTMLSelectField',
'radio' => 'HTMLRadioField',
'multiselect' => 'HTMLMultiSelectField',
'selectorother' => 'HTMLSelectOrOtherField',
'submit' => 'HTMLSubmitField',
'hidden' => 'HTMLHiddenField',
+ 'edittools' => 'HTMLEditTools',
# HTMLTextField will output the correct type="" attribute automagically.
- # There are about four zillion other HTML 5 input types, like url, but
+ # There are about four zillion other HTML5 input types, like url, but
# we don't use those at the moment, so no point in adding all of them.
'email' => 'HTMLTextField',
'password' => 'HTMLTextField',
protected $mMessagePrefix;
protected $mFlatFields;
protected $mFieldTree;
- protected $mShowReset;
+ protected $mShowReset = false;
public $mFieldData;
+
protected $mSubmitCallback;
protected $mValidationErrorMessage;
- protected $mIntro;
+
+ protected $mPre = '';
+ protected $mHeader = '';
+ protected $mPost = '';
+ protected $mId;
+
protected $mSubmitID;
+ protected $mSubmitName;
protected $mSubmitText;
+ protected $mSubmitTooltip;
protected $mTitle;
+ protected $mUseMultipart = false;
protected $mHiddenFields = array();
protected $mButtons = array();
+
+ protected $mWrapperLegend = false;
/**
* Build a new HTMLForm from an array of field attributes
$info['name'] = $fieldname;
+ if ( isset( $info['type'] ) && $info['type'] == 'file' )
+ $this->mUseMultipart = true;
+
$field = self::loadInputFromParameters( $info );
$field->mParent = $this;
}
$this->mFieldTree = $loadedDescriptor;
-
- $this->mShowReset = true;
}
/**
static function addJS() {
if( self::$jsAdded ) return;
- global $wgOut;
+ global $wgOut, $wgStylePath;
- $wgOut->addScriptClass( 'htmlform' );
+ $wgOut->addScriptFile( "$wgStylePath/common/htmlform.js" );
}
/**
* Validate all the fields, and call the submision callback
* function if everything is kosher.
* @return Mixed Bool true == Successful submission, Bool false
- * == No submission attempted, anything else == Error to
- * display.
+ * == No submission attempted, anything else == Error to
+ * display.
*/
function trySubmit() {
# Check for validation
* Set a callback to a function to do something with the form
* once it's been successfully validated.
* @param $cb String function name. The function will be passed
- * the output from HTMLForm::filterDataForSubmit, and must
- * return Bool true on success, Bool false if no submission
- * was attempted, or String HTML output to display on error.
+ * the output from HTMLForm::filterDataForSubmit, and must
+ * return Bool true on success, Bool false if no submission
+ * was attempted, or String HTML output to display on error.
*/
function setSubmitCallback( $cb ) {
$this->mSubmitCallback = $cb;
/**
* Set a message to display on a validation error.
* @param $msg Mixed String or Array of valid inputs to wfMsgExt()
- * (so each entry can be either a String or Array)
+ * (so each entry can be either a String or Array)
*/
function setValidationErrorMessage( $msg ) {
$this->mValidationErrorMessage = $msg;
}
+
+ /**
+ * Set the introductory message, overwriting any existing message.
+ * @param $msg String complete text of message to display
+ */
+ function setIntro( $msg ) { $this->mPre = $msg; }
/**
- * Set the introductory message
+ * Add introductory text.
* @param $msg String complete text of message to display
*/
- function setIntro( $msg ) {
- $this->mIntro = $msg;
- }
+ function addPreText( $msg ) { $this->mPre .= $msg; }
+
+ /**
+ * Add header text, inside the form.
+ * @param $msg String complete text of message to display
+ */
+ function addHeaderText( $msg ) { $this->mHeader .= $msg; }
+
+ /**
+ * Add text to the end of the display.
+ * @param $msg String complete text of message to display
+ */
+ function addPostText( $msg ) { $this->mPost .= $msg; }
/**
* Add a hidden field to the output
$this->mHiddenFields[ $name ] = $value;
}
- public function addButton( $name, $value, $id=null ){
- $this->mButtons[] = compact( 'name', 'value', 'id' );
+ public function addButton( $name, $value, $id=null, $attribs=null ){
+ $this->mButtons[] = compact( 'name', 'value', 'id', 'attribs' );
}
/**
$this->displayErrors( $submitResult );
}
- if ( isset( $this->mIntro ) ) {
- $wgOut->addHTML( $this->mIntro );
- }
-
- $html = $this->getBody();
-
- // Hidden fields
- $html .= $this->getHiddenFields();
-
- // Buttons
- $html .= $this->getButtons();
+ $html = ''
+ . $this->mHeader
+ . $this->getBody()
+ . $this->getHiddenFields()
+ . $this->getButtons()
+ ;
$html = $this->wrapForm( $html );
- $wgOut->addHTML( $html );
+ $wgOut->addHTML( ''
+ . $this->mPre
+ . $html
+ . $this->mPost
+ );
}
/**
* @return String wrapped HTML.
*/
function wrapForm( $html ) {
- return Html::rawElement(
- 'form',
- array(
- 'action' => $this->getTitle()->getFullURL(),
- 'method' => 'post',
- ),
- $html
+
+ # Include a <fieldset> wrapper for style, if requested.
+ if ( $this->mWrapperLegend !== false ){
+ $html = Xml::fieldset( $this->mWrapperLegend, $html );
+ }
+ # Use multipart/form-data
+ $encType = $this->mUseMultipart
+ ? 'multipart/form-data'
+ : 'application/x-www-form-urlencoded';
+ # Attributes
+ $attribs = array(
+ 'action' => $this->getTitle()->getFullURL(),
+ 'method' => 'post',
+ 'class' => 'visualClear',
+ 'enctype' => $encType,
);
+ if ( !empty( $this->mId ) )
+ $attribs['id'] = $this->mId;
+
+ return Html::rawElement( 'form', $attribs, $html );
}
/**
global $wgUser;
$html = '';
- $html .= Html::hidden( 'wpEditToken', $wgUser->editToken() ) . "\n";
- $html .= Html::hidden( 'title', $this->getTitle() ) . "\n";
+ $html .= Html::hidden( 'wpEditToken', $wgUser->editToken(), array( 'id' => 'wpEditToken' ) ) . "\n";
+ $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
foreach( $this->mHiddenFields as $name => $value ){
$html .= Html::hidden( $name, $value ) . "\n";
if ( isset( $this->mSubmitID ) )
$attribs['id'] = $this->mSubmitID;
+ if ( isset( $this->mSubmitName ) )
+ $attribs['name'] = $this->mSubmitName;
+ if ( isset( $this->mSubmitTooltip ) ) {
+ global $wgUser;
+ $attribs += $wgUser->getSkin()->tooltipAndAccessKeyAttribs( $this->mSubmitTooltip );
+ }
$attribs['class'] = 'mw-htmlform-submit';
'name' => $button['name'],
'value' => $button['value']
);
+ if ( $button['attribs'] )
+ $attrs += $button['attribs'];
if( isset( $button['id'] ) )
$attrs['id'] = $button['id'];
$html .= Html::element( 'input', $attrs );
? $this->mSubmitText
: wfMsg( 'htmlform-submit' );
}
+
+ public function setSubmitName( $name ) {
+ $this->mSubmitName = $name;
+ }
+
+ public function setSubmitTooltip( $name ) {
+ $this->mSubmitTooltip = $name;
+ }
+
/**
* Set the id for the submit button.
function setSubmitID( $t ) {
$this->mSubmitID = $t;
}
+
+ public function setId( $id ) {
+ $this->mId = $id;
+ }
+ /**
+ * Prompt the whole form to be wrapped in a <fieldset>, with
+ * this text as its <legend> element.
+ * @param $legend String HTML to go inside the <legend> element.
+ * Will be escaped
+ */
+ public function setWrapperLegend( $legend ){ $this->mWrapperLegend = $legend; }
/**
* Set the prefix for various default messages
* TODO: Document
* @param $fields
*/
- function displaySection( $fields ) {
+ function displaySection( $fields, $sectionName = '' ) {
$tableHtml = '';
$subsectionHtml = '';
$hasLeftColumn = false;
if( $value->getLabel() != ' ' )
$hasLeftColumn = true;
} elseif ( is_array( $value ) ) {
- $section = $this->displaySection( $value );
+ $section = $this->displaySection( $value, $key );
$legend = wfMsg( "{$this->mMessagePrefix}-$key" );
$subsectionHtml .= Xml::fieldset( $legend, $section ) . "\n";
}
$classes = array();
if( !$hasLeftColumn ) // Avoid strange spacing when no labels exist
$classes[] = 'mw-htmlform-nolabel';
- $classes = implode( ' ', $classes );
+ $attribs = array(
+ 'classes' => implode( ' ', $classes ),
+ );
+ if ( $sectionName )
+ $attribs['id'] = Sanitizer::escapeId( "mw-htmlform-$sectionName" );
- $tableHtml = Html::rawElement( 'table', array( 'class' => $classes ),
+ $tableHtml = Html::rawElement( 'table', $attribs,
Html::rawElement( 'tbody', array(), "\n$tableHtml\n" ) ) . "\n";
return $subsectionHtml . "\n" . $tableHtml;
/**
* Stop a reset button being shown for this form
* @param $suppressReset Bool set to false to re-enable the
- * button again
+ * button again
*/
function suppressReset( $suppressReset = true ) {
$this->mShowReset = !$suppressReset;
protected $mFilterCallback;
protected $mName;
public $mParams;
- protected $mLabel; # String label. Set on construction
+ protected $mLabel; # String label. Set on construction
protected $mID;
protected $mDefault;
public $mParent;
* the input object itself. It should not implement the surrounding
* table cells/rows, or labels/help messages.
* @param $value String the value to set the input to; eg a default
- * text for a text input.
+ * text for a text input.
* @return String valid HTML.
*/
abstract function getInputHTML( $value );
$errors = Html::rawElement( 'span', array( 'class' => 'error' ), $errors );
}
- $html = '';
-
- # Don't output a for= attribute for labels with no associated input.
- # Kind of hacky here, possibly we don't want these to be <label>s at all.
- $for = array();
- if ( $this->needsLabel() ) {
- $for['for'] = $this->mID;
- }
- $html .= Html::rawElement( 'td', array( 'class' => 'mw-label' ),
- Html::rawElement( 'label', $for, $this->getLabel() )
- );
+ $html = $this->getLabelHtml();
$html .= Html::rawElement( 'td', array( 'class' => 'mw-input' ),
$this->getInputHTML( $value ) ."\n$errors" );
function getLabel() {
return $this->mLabel;
}
+ function getLabelHtml() {
+ # Don't output a for= attribute for labels with no associated input.
+ # Kind of hacky here, possibly we don't want these to be <label>s at all.
+ $for = array();
+ if ( $this->needsLabel() ) {
+ $for['for'] = $this->mID;
+ }
+ return Html::rawElement( 'td', array( 'class' => 'mw-label' ),
+ Html::rawElement( 'label', $for, $this->getLabel() )
+ );
+ }
function getDefault() {
if ( isset( $this->mDefault ) ) {
return null;
}
}
+
+ /**
+ * Returns the attributes required for the tooltip and accesskey.
+ *
+ * @return array Attributes
+ */
+ public function getTooltipAndAccessKey() {
+ if ( empty( $this->mParams['tooltip'] ) )
+ return array();
+
+ global $wgUser;
+ return $wgUser->getSkin()->tooltipAndAccessKeyAttribs();
+ }
/**
* flatten an array of options to a single array, for instance,
* a set of <options> inside <optgroups>.
* @param $options Associative Array with values either Strings
- * or Arrays
+ * or Arrays
* @return Array flattened input
*/
public static function flattenOptions( $options ) {
return $flatOpts;
}
+
}
class HTMLTextField extends HTMLFormField {
}
function getInputHTML( $value ) {
- global $wgHtml5;
$attribs = array(
'id' => $this->mID,
'name' => $this->mName,
'size' => $this->getSize(),
'value' => $value,
- );
+ ) + $this->getTooltipAndAccessKey();
if ( isset( $this->mParams['maxlength'] ) ) {
$attribs['maxlength'] = $this->mParams['maxlength'];
$attribs['disabled'] = 'disabled';
}
- if ( $wgHtml5 ) {
- # TODO: Enforce pattern, step, required, readonly on the server
- # side as well
- foreach ( array( 'min', 'max', 'pattern', 'title', 'step',
- 'placeholder' ) as $param ) {
- if ( isset( $this->mParams[$param] ) ) {
- $attribs[$param] = $this->mParams[$param];
- }
+ # TODO: Enforce pattern, step, required, readonly on the server side as
+ # well
+ foreach ( array( 'min', 'max', 'pattern', 'title', 'step',
+ 'placeholder' ) as $param ) {
+ if ( isset( $this->mParams[$param] ) ) {
+ $attribs[$param] = $this->mParams[$param];
}
- foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' )
- as $param ) {
- if ( isset( $this->mParams[$param] ) ) {
- $attribs[$param] = '';
- }
+ }
+ foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' ) as
+ $param ) {
+ if ( isset( $this->mParams[$param] ) ) {
+ $attribs[$param] = '';
}
+ }
- # Implement tiny differences between some field variants
- # here, rather than creating a new class for each one which
- # is essentially just a clone of this one.
- if ( isset( $this->mParams['type'] ) ) {
- switch ( $this->mParams['type'] ) {
- case 'email':
- $attribs['type'] = 'email';
- break;
- case 'int':
- $attribs['type'] = 'number';
- break;
- case 'float':
- $attribs['type'] = 'number';
- $attribs['step'] = 'any';
- break;
- case 'password':
- $attribs['type'] = 'password';
- break;
- }
+ # Implement tiny differences between some field variants
+ # here, rather than creating a new class for each one which
+ # is essentially just a clone of this one.
+ if ( isset( $this->mParams['type'] ) ) {
+ switch ( $this->mParams['type'] ) {
+ case 'email':
+ $attribs['type'] = 'email';
+ break;
+ case 'int':
+ $attribs['type'] = 'number';
+ break;
+ case 'float':
+ $attribs['type'] = 'number';
+ $attribs['step'] = 'any';
+ break;
+ # Pass through
+ case 'password':
+ case 'file':
+ $attribs['type'] = $this->mParams['type'];
+ break;
}
}
return Html::element( 'input', $attribs );
}
}
+class HTMLTextAreaField extends HTMLFormField {
+
+ function getCols() {
+ return isset( $this->mParams['cols'] )
+ ? $this->mParams['cols']
+ : 80;
+ }
+ function getRows() {
+ return isset( $this->mParams['rows'] )
+ ? $this->mParams['rows']
+ : 25;
+ }
+
+ function getInputHTML( $value ) {
+ $attribs = array(
+ 'id' => $this->mID,
+ 'name' => $this->mName,
+ 'cols' => $this->getCols(),
+ 'rows' => $this->getRows(),
+ ) + $this->getTooltipAndAccessKey();
+
+
+ if ( !empty( $this->mParams['disabled'] ) ) {
+ $attribs['disabled'] = 'disabled';
+ }
+ if ( !empty( $this->mParams['readonly'] ) ) {
+ $attribs['readonly'] = 'readonly';
+ }
+
+ foreach ( array( 'required', 'autofocus' ) as $param ) {
+ if ( isset( $this->mParams[$param] ) ) {
+ $attribs[$param] = '';
+ }
+ }
+
+ return Html::element( 'textarea', $attribs, $value );
+ }
+}
/**
* A field that will contain a numeric value
if ( !empty( $this->mParams['invert'] ) )
$value = !$value;
- $attr = array( 'id' => $this->mID );
+ $attr = $this->getTooltipAndAccessKey();
+ $attr['id'] = $this->mID;
if( !empty( $this->mParams['disabled'] ) ) {
$attr['disabled'] = 'disabled';
}
'text',
$tbAttribs );
- return "$select<br/>\n$textbox";
+ return "$select<br />\n$textbox";
}
function loadDataFromRequest( $request ) {
$html .= ' ' .
Html::rawElement( 'label', array( 'for' => $id ), $label );
- $html .= "<br/>\n";
+ $html .= "<br />\n";
}
}
$this->mParent->addButton(
$this->mParams['name'],
$this->mParams['default'],
- isset($this->mParams['id']) ? $this->mParams['id'] : null
+ isset($this->mParams['id']) ? $this->mParams['id'] : null,
+ $this->getTooltipAndAccessKey()
);
}
public function getInputHTML( $value ){ return ''; }
}
+class HTMLEditTools extends HTMLFormField {
+ public function getInputHTML( $value ) {
+ return '';
+ }
+ public function getTableRow( $value ) {
+ return "<tr><td></td><td class=\"mw-input\">"
+ . '<div class="mw-editTools">'
+ . wfMsgExt( empty( $this->mParams['message'] )
+ ? 'edittools' : $this->mParams['message'],
+ array( 'parse', 'content' ) )
+ . "</div></td></tr>\n";
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff