*
* '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.
+ * '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
+ * 'id' -- HTML id attribute
+ * 'cssclass' -- CSS class
* '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.
* 'required' -- passed through to the object, indicating that it
* is a required field.
- * 'size' -- the length of text fields
+ * '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()
'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 $mPre = '';
protected $mHeader = '';
+ protected $mFooter = '';
protected $mPost = '';
protected $mId;
$this->mFlatFields = array();
foreach( $descriptor as $fieldname => $info ) {
- $section = '';
- if ( isset( $info['section'] ) )
- $section = $info['section'];
+ $section = isset( $info['section'] )
+ ? $info['section']
+ : '';
- $info['name'] = $fieldname;
+ $info['name'] = isset( $info['name'] )
+ ? $info['name']
+ : $fieldname;
- if ( isset( $info['type'] ) && $info['type'] == 'file' )
+ if ( isset( $info['type'] ) && $info['type'] == 'file' ){
$this->mUseMultipart = true;
+ }
$field = self::loadInputFromParameters( $info );
$field->mParent = $this;
static function addJS() {
if( self::$jsAdded ) return;
- global $wgOut;
+ global $wgOut, $wgStylePath;
- $wgOut->addScriptClass( 'htmlform' );
+ $wgOut->addScriptFile( "$wgStylePath/common/htmlform.js" );
}
/**
function trySubmit() {
# Check for validation
foreach( $this->mFlatFields as $fieldname => $field ) {
- if ( !empty( $field->mParams['nodata'] ) )
+ if ( !empty( $field->mParams['nodata'] ) ){
continue;
+ }
if ( $field->validate(
$this->mFieldData[$fieldname],
$this->mFieldData )
*/
function addHeaderText( $msg ) { $this->mHeader .= $msg; }
+ /**
+ * Add footer text, inside the form.
+ * @param $msg String complete text of message to display
+ */
+ function addFooterText( $msg ) { $this->mFooter .= $msg; }
+
/**
* Add text to the end of the display.
* @param $msg String complete text of message to display
* Add a hidden field to the output
* @param $name String field name
* @param $value String field value
+ * @param $attribs Array
*/
- public function addHiddenField( $name, $value ){
- $this->mHiddenFields[ $name ] = $value;
+ public function addHiddenField( $name, $value, $attribs=array() ){
+ $attribs += array( 'name' => $name );
+ $this->mHiddenFields[] = array( $value, $attribs );
}
public function addButton( $name, $value, $id=null, $attribs=null ){
function displayForm( $submitResult ) {
global $wgOut;
- if ( $submitResult !== false ) {
- $this->displayErrors( $submitResult );
- }
-
$html = ''
+ . $this->getErrors( $submitResult )
. $this->mHeader
. $this->getBody()
. $this->getHiddenFields()
. $this->getButtons()
+ . $this->mFooter
;
$html = $this->wrapForm( $html );
$html = '';
$html .= Html::hidden( 'wpEditToken', $wgUser->editToken(), array( 'id' => 'wpEditToken' ) ) . "\n";
- $html .= Html::hidden( 'title', $this->getTitle() ) . "\n";
+ $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
- foreach( $this->mHiddenFields as $name => $value ){
- $html .= Html::hidden( $name, $value ) . "\n";
+ foreach( $this->mHiddenFields as $data ){
+ list( $value, $attribs ) = $data;
+ $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
}
return $html;
/**
* Format and display an error message stack.
* @param $errors Mixed String or Array of message keys
+ * @return String
*/
- function displayErrors( $errors ) {
+ function getErrors( $errors ) {
if ( is_array( $errors ) ) {
$errorstr = $this->formatErrors( $errors );
} else {
$errorstr = $errors;
}
- $errorstr = Html::rawElement( 'div', array( 'class' => 'error' ), $errorstr );
-
- global $wgOut;
- $wgOut->addHTML( $errorstr );
+ return $errorstr
+ ? Html::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
+ : '';
}
/**
if( !$hasLeftColumn ) // Avoid strange spacing when no labels exist
$classes[] = 'mw-htmlform-nolabel';
$attribs = array(
- 'classes' => implode( ' ', $classes ),
+ 'class' => implode( ' ', $classes ),
);
if ( $sectionName )
$attribs['id'] = Sanitizer::escapeId( "mw-htmlform-$sectionName" );
$fieldData = array();
foreach( $this->mFlatFields as $fieldname => $field ) {
- if ( !empty( $field->mParams['nodata'] ) ) continue;
- if ( !empty( $field->mParams['disabled'] ) ) {
+ if ( !empty( $field->mParams['nodata'] ) ){
+ continue;
+ } elseif ( !empty( $field->mParams['disabled'] ) ) {
$fieldData[$fieldname] = $field->getDefault();
} else {
$fieldData[$fieldname] = $field->loadDataFromRequest( $wgRequest );
$field = $this->mFlatFields[$name];
$value = $field->filter( $value, $this->mFlatFields );
}
-
+
$this->mFieldData = $fieldData;
}
public $mParams;
protected $mLabel; # String label. Set on construction
protected $mID;
+ protected $mClass = '';
protected $mDefault;
public $mParent;
* field input. Don't forget to call parent::validate() to ensure
* that the user-defined callback mValidationCallback is still run
* @param $value String the value the field was submitted with
- * @param $alldata $all the data collected from the form
+ * @param $alldata Array the data collected from the form
* @return Mixed Bool true on success, or String error to display.
*/
function validate( $value, $alldata ) {
$this->mID = $id;
}
+ if ( isset( $params['cssclass'] ) ) {
+ $this->mClass = $params['cssclass'];
+ }
+
if ( isset( $params['validation-callback'] ) ) {
$this->mValidationCallback = $params['validation-callback'];
}
}
$html = $this->getLabelHtml();
- $html .= Html::rawElement( 'td', array( 'class' => 'mw-input' ),
- $this->getInputHTML( $value ) ."\n$errors" );
+ $html .= Html::rawElement(
+ 'td',
+ array( 'class' => 'mw-input' ),
+ $this->getInputHTML( $value ) ."\n$errors"
+ );
$fieldType = get_class( $this );
- $html = Html::rawElement( 'tr', array( 'class' => "mw-htmlform-field-$fieldType" ),
- $html ) . "\n";
+ $html = Html::rawElement(
+ 'tr',
+ array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass}" ),
+ $html
+ ) . "\n";
$helptext = null;
if ( isset( $this->mParams['help-message'] ) ) {
}
function getInputHTML( $value ) {
- global $wgHtml5;
$attribs = array(
'id' => $this->mID,
'name' => $this->mName,
$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] = '';
}
}
# here, rather than creating a new class for each one which
# is essentially just a clone of this one.
if ( isset( $this->mParams['type'] ) ) {
- # Options that apply only to HTML5
- if( $wgHtml5 ){
- 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;
- }
- }
- # Options that apply to HTML4 as well
- switch( $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':
return Html::element( 'input', $attribs );
}
+
+ public function validate( $value, $alldata ){
+ $p = parent::validate( $value, $alldata );
+ if( $p !== true ) return $p;
+
+ if( isset( $this->mParams['required'] ) && $value === '' ){
+ return wfMsgExt( 'htmlform-required', 'parseinline' );
+ }
+ return true;
+ }
}
class HTMLTextAreaField extends HTMLFormField {
}
function getInputHTML( $value ) {
- global $wgHtml5;
$attribs = array(
'id' => $this->mID,
'name' => $this->mName,
$attribs['readonly'] = 'readonly';
}
- if ( $wgHtml5 ) {
- foreach ( array( 'required', 'autofocus' ) as $param ) {
- if ( isset( $this->mParams[$param] ) ) {
- $attribs[$param] = '';
- }
+ foreach ( array( 'required', 'autofocus' ) as $param ) {
+ if ( isset( $this->mParams[$param] ) ) {
+ $attribs[$param] = '';
}
}
-
return Html::element( 'textarea', $attribs, $value );
}
+
+ public function validate( $value, $alldata ){
+ $p = parent::validate( $value, $alldata );
+ if( $p !== true ) return $p;
+
+ if( isset( $this->mParams['required'] ) && $value === '' ){
+ return wfMsgExt( 'htmlform-required', 'parseinline' );
+ }
+ return true;
+ }
}
/**
if ( $p !== true ) return $p;
- if ( intval( $value ) != $value ) {
+ if ( $value !== ''
+ && ( !is_numeric( $value ) || round( $value ) != $value ) )
+ {
return wfMsgExt( 'htmlform-int-invalid', 'parse' );
}
'text',
$tbAttribs );
- return "$select<br/>\n$textbox";
+ return "$select<br />\n$textbox";
}
function loadDataFromRequest( $request ) {
} else {
$thisAttribs = array( 'id' => $this->mID . "-$info", 'value' => $info );
- $checkbox = Xml::check( $this->mName . '[]', in_array( $info, $value ),
+ $checkbox = Xml::check( $this->mName . '[]', in_array( $info, $value, true ),
$attribs + $thisAttribs );
$checkbox .= ' ' . Html::rawElement( 'label', array( 'for' => $this->mID . "-$info" ), $label );
$html .= ' ' .
Html::rawElement( 'label', array( 'for' => $id ), $label );
- $html .= "<br/>\n";
+ $html .= "<br />\n";
}
}
class HTMLHiddenField extends HTMLFormField {
+ public function __construct( $params ){
+ parent::__construct( $params );
+ # forcing the 'wp' prefix on hidden field names
+ # is undesirable
+ $this->mName = substr( $this->mName, 2 );
+ }
+
public function getTableRow( $value ){
+ $params = array();
+ if( $this->mID ){
+ $params['id'] = $this->mID;
+ }
$this->mParent->addHiddenField(
- $this->mParams['name'],
- $this->mParams['default']
+ $this->mName,
+ $this->mDefault,
+ $params
);
return '';
}
public function getInputHTML( $value ){ return ''; }
}
+/**
+ * Add a submit button inline in the form (as opposed to
+ * HTMLForm::addButton(), which will add it at the end).
+ */
class HTMLSubmitField extends HTMLFormField {
- public function getTableRow( $value ){
- $this->mParent->addButton(
- $this->mParams['name'],
- $this->mParams['default'],
- isset($this->mParams['id']) ? $this->mParams['id'] : null,
- $this->getTooltipAndAccessKey()
+ function __construct( $info ) {
+ $info['nodata'] = true;
+ parent::__construct( $info );
+ }
+
+ function getInputHTML( $value ) {
+ return Xml::submitButton(
+ $value,
+ array(
+ 'class' => 'mw-htmlform-submit',
+ 'name' => $this->mName,
+ 'id' => $this->mID,
+ )
);
}
-
- public function getInputHTML( $value ){ return ''; }
+
+ protected function needsLabel() {
+ return false;
+ }
}
class HTMLEditTools extends HTMLFormField {
public function getTableRow( $value ) {
return "<tr><td></td><td class=\"mw-input\">"
. '<div class="mw-editTools">'
- . wfMsgForContent( 'edittools' )
+ . wfMsgExt( empty( $this->mParams['message'] )
+ ? 'edittools' : $this->mParams['message'],
+ array( 'parse', 'content' ) )
. "</div></td></tr>\n";
}
-}
\ No newline at end of file
+}
dépôts / lhc / web / wiklou.git / blobdiff