78 $args = func_get_args();
80 if ( $this->mParent ) {
83 $callback =
'wfMessage';
86 return call_user_func_array( $callback,
$args );
115 while ( preg_match(
'/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
116 array_unshift( $thisKeys, $m[2] );
119 if ( substr( $tmp, 0, 2 ) ==
'wp' &&
120 !array_key_exists( $tmp, $alldata ) &&
121 array_key_exists( substr( $tmp, 2 ), $alldata )
124 $tmp = substr( $tmp, 2 );
126 array_unshift( $thisKeys, $tmp );
130 while ( preg_match(
'/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
131 array_unshift( $nameKeys, $m[2] );
134 array_unshift( $nameKeys, $tmp );
137 for ( $i = count( $thisKeys ) - 1; $i >= 0; $i-- ) {
138 $keys = array_merge( array_slice( $thisKeys, 0, $i ), $nameKeys );
142 if ( !is_array( $data ) || !array_key_exists(
$key, $data ) ) {
147 $testValue = (
string)$data;
164 $op = array_shift( $params );
169 foreach ( $params
as $i => $p ) {
170 if ( !is_array( $p ) ) {
172 "Expected array, found " . gettype( $p ) .
" at index $i"
182 foreach ( $params
as $i => $p ) {
183 if ( !is_array( $p ) ) {
185 "Expected array, found " . gettype( $p ) .
" at index $i"
195 foreach ( $params
as $i => $p ) {
196 if ( !is_array( $p ) ) {
198 "Expected array, found " . gettype( $p ) .
" at index $i"
208 foreach ( $params
as $i => $p ) {
209 if ( !is_array( $p ) ) {
211 "Expected array, found " . gettype( $p ) .
" at index $i"
221 if ( count( $params ) !== 1 ) {
222 throw new MWException(
"NOT takes exactly one parameter" );
225 if ( !is_array( $p ) ) {
227 "Expected array, found " . gettype( $p ) .
" at index 0"
234 if ( count( $params ) !== 2 ) {
235 throw new MWException(
"$op takes exactly two parameters" );
238 if ( !is_string( $field ) || !is_string(
$value ) ) {
239 throw new MWException(
"Parameters for $op must be strings" );
244 return (
$value === $testValue );
246 return (
$value !== $testValue );
254 "Invalid hide-if specification for $this->mName: " .
255 $ex->getMessage() .
" in " . var_export( $origParams,
true ),
270 if ( !$this->mHideIf ) {
303 if ( $this->
isHidden( $alldata ) ) {
307 if ( isset( $this->mParams[
'required'] )
308 && $this->mParams[
'required'] !==
false
311 return $this->
msg(
'htmlform-required' )->parse();
314 if ( isset( $this->mValidationCallback ) ) {
315 return call_user_func( $this->mValidationCallback,
$value, $alldata, $this->mParent );
322 if ( isset( $this->mFilterCallback ) ) {
323 $value = call_user_func( $this->mFilterCallback,
$value, $alldata, $this->mParent );
349 $this->mShowEmptyLabels = $show;
360 if (
$request->getCheck( $this->mName ) ) {
361 return $request->getText( $this->mName );
379 $this->mParent =
$params[
'parent'];
382 # Generate the label from a message, if possible
383 if ( isset(
$params[
'label-message'] ) ) {
385 } elseif ( isset(
$params[
'label'] ) ) {
386 if (
$params[
'label'] ===
' ' ) {
388 $this->mLabel =
' ';
390 $this->mLabel = htmlspecialchars(
$params[
'label'] );
392 } elseif ( isset(
$params[
'label-raw'] ) ) {
393 $this->mLabel =
$params[
'label-raw'];
396 $this->mName =
"wp{$params['fieldname']}";
397 if ( isset(
$params[
'name'] ) ) {
398 $this->mName =
$params[
'name'];
401 if ( isset(
$params[
'dir'] ) ) {
406 $validName = str_replace( [
'.5B',
'.5D' ], [
'[',
']' ], $validName );
407 if ( $this->mName != $validName && !isset(
$params[
'nodata'] ) ) {
408 throw new MWException(
"Invalid name '{$this->mName}' passed to " . __METHOD__ );
411 $this->mID =
"mw-input-{$this->mName}";
413 if ( isset(
$params[
'default'] ) ) {
414 $this->mDefault =
$params[
'default'];
417 if ( isset(
$params[
'id'] ) ) {
421 if ( $id != $validId ) {
422 throw new MWException(
"Invalid id '$id' passed to " . __METHOD__ );
428 if ( isset(
$params[
'cssclass'] ) ) {
429 $this->mClass =
$params[
'cssclass'];
432 if ( isset(
$params[
'csshelpclass'] ) ) {
433 $this->mHelpClass =
$params[
'csshelpclass'];
436 if ( isset(
$params[
'validation-callback'] ) ) {
437 $this->mValidationCallback =
$params[
'validation-callback'];
440 if ( isset(
$params[
'filter-callback'] ) ) {
441 $this->mFilterCallback =
$params[
'filter-callback'];
444 if ( isset(
$params[
'flatlist'] ) ) {
445 $this->mClass .=
' mw-htmlform-flatlist';
448 if ( isset(
$params[
'hidelabel'] ) ) {
449 $this->mShowEmptyLabels =
false;
452 if ( isset(
$params[
'hide-if'] ) ) {
453 $this->mHideIf =
$params[
'hide-if'];
468 $fieldType = get_class( $this );
470 $cellAttributes = [];
474 if ( !empty( $this->mParams[
'vertical-label'] ) ) {
475 $cellAttributes[
'colspan'] = 2;
476 $verticalLabel =
true;
478 $verticalLabel =
false;
485 [
'class' =>
'mw-input' ] + $cellAttributes,
486 $inputHtml .
"\n$errors"
489 if ( $this->mHideIf ) {
491 $rowClasses .=
' mw-htmlform-hide-if';
494 if ( $verticalLabel ) {
496 $rowAttributes + [
'class' =>
"mw-htmlform-vertical-label $rowClasses" ], $label );
499 'class' =>
"mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
506 'class' =>
"mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
511 return $html . $helptext;
526 $fieldType = get_class( $this );
528 $cellAttributes = [];
533 'mw-htmlform-nolabel' => ( $label ===
'' )
536 $horizontalLabel = isset( $this->mParams[
'horizontal-label'] )
537 ? $this->mParams[
'horizontal-label'] :
false;
539 if ( $horizontalLabel ) {
540 $field =
' ' . $inputHtml .
"\n$errors";
544 [
'class' => $outerDivClass ] + $cellAttributes,
545 $inputHtml .
"\n$errors"
548 $divCssClasses = [
"mw-htmlform-field-$fieldType",
551 $wrapperAttributes = [
552 'class' => $divCssClasses,
554 if ( $this->mHideIf ) {
556 $wrapperAttributes[
'class'][] =
' mw-htmlform-hide-if';
575 if ( !$inputField ) {
580 new OOUI\Widget( [
'content' =>
new OOUI\HtmlSnippet( $this->
getDiv(
$value ) ) ] ),
581 [
'infusable' =>
false,
'align' =>
'top' ]
586 if ( is_string( $inputField ) ) {
590 $inputField =
new OOUI\Widget( [
'content' =>
new OOUI\HtmlSnippet( $inputField ) ] );
594 $fieldType = get_class( $this );
597 foreach ( $errors
as &$error ) {
598 $error =
new OOUI\HtmlSnippet( $error );
602 'classes' => [
"mw-htmlform-field-$fieldType",
$this->mClass ],
604 'help' => $helpText !== null ?
new OOUI\HtmlSnippet( $helpText ) : null,
606 'infusable' => $infusable,
612 $config[
'label'] =
new OOUI\HtmlSnippet( $label );
631 if ( isset( $this->mClassWithButton ) ) {
632 $buttonWidget = $this->mClassWithButton->getInputOOUI(
'' );
633 return new OOUI\ActionFieldLayout( $inputField, $buttonWidget, $config );
635 return new OOUI\FieldLayout( $inputField, $config );
651 $cellAttributes = [];
672 $this->mVFormClass =
' mw-ui-vform-field';
686 $cellAttributes = [];
689 $html =
"\n" . $errors .
705 if ( is_null( $helptext ) ) {
710 if ( $this->mHideIf ) {
712 $rowAttributes[
'class'] =
'mw-htmlform-hide-if';
715 $tdClasses = [
'htmlform-tip' ];
716 if ( $this->mHelpClass !==
false ) {
719 $row =
Html::rawElement(
'td', [
'colspan' => 2,
'class' => $tdClasses ], $helptext );
734 if ( is_null( $helptext ) ) {
738 $wrapperAttributes = [
739 'class' =>
'htmlform-tip',
741 if ( $this->mHelpClass !==
false ) {
742 $wrapperAttributes[
'class'] .=
" {$this->mHelpClass}";
744 if ( $this->mHideIf ) {
746 $wrapperAttributes[
'class'] .=
' mw-htmlform-hide-if';
772 if ( isset( $this->mParams[
'help-message'] ) ) {
773 $this->mParams[
'help-messages'] = [ $this->mParams[
'help-message'] ];
776 if ( isset( $this->mParams[
'help-messages'] ) ) {
777 foreach ( $this->mParams[
'help-messages']
as $msg ) {
780 if ( $msg->exists() ) {
781 if ( is_null( $helptext ) ) {
784 $helptext .= $this->
msg(
'word-separator' )->escaped();
786 $helptext .= $msg->parse();
789 } elseif ( isset( $this->mParams[
'help'] ) ) {
790 $helptext = $this->mParams[
'help'];
806 if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
810 $errors = self::formatErrors( $errors );
811 $errorClass =
'mw-htmlform-invalid-input';
814 return [ $errors, $errorClass ];
827 if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
831 if ( !is_array( $errors ) ) {
832 $errors = [ $errors ];
834 foreach ( $errors
as &$error ) {
835 if ( $error instanceof
Message ) {
836 $error = $error->parse();
851 # Don't output a for= attribute for labels with no associated input.
852 # Kind of hacky here, possibly we don't want these to be <label>s at all.
859 $labelValue = trim( $this->
getLabel() );
861 if ( $labelValue !==
' ' && $labelValue !==
'' ) {
865 $displayFormat = $this->mParent->getDisplayFormat();
867 $horizontalLabel = isset( $this->mParams[
'horizontal-label'] )
868 ? $this->mParams[
'horizontal-label'] :
false;
870 if ( $displayFormat ===
'table' ) {
873 [
'class' =>
'mw-label' ] + $cellAttributes,
875 } elseif ( $hasLabel || $this->mShowEmptyLabels ) {
876 if ( $displayFormat ===
'div' && !$horizontalLabel ) {
879 [
'class' =>
'mw-label' ] + $cellAttributes,
890 if ( isset( $this->mDefault ) ) {
903 if ( empty( $this->mParams[
'tooltip'] ) ) {
917 static $boolAttribs = [
'disabled',
'required',
'autofocus',
'multiple',
'readonly' ];
920 foreach ( $list
as $key ) {
921 if ( in_array( $key, $boolAttribs ) ) {
922 if ( !empty( $this->mParams[$key] ) ) {
925 } elseif ( isset( $this->mParams[$key] ) ) {
959 if ( is_array( $array ) ) {
960 return array_map( [ __CLASS__,
'forceToStringRecursive' ], $array );
962 return strval( $array );
973 if ( $this->mOptions ===
false ) {
974 if ( array_key_exists(
'options-messages', $this->mParams ) ) {
975 $this->mOptions = $this->
lookupOptionsKeys( $this->mParams[
'options-messages'] );
976 } elseif ( array_key_exists(
'options', $this->mParams ) ) {
977 $this->mOptionsLabelsNotFromMessage =
true;
978 $this->mOptions = self::forceToStringRecursive( $this->mParams[
'options'] );
979 } elseif ( array_key_exists(
'options-message', $this->mParams ) ) {
981 $message = $this->
getMessage( $this->mParams[
'options-message'] )->inContentLanguage()->plain();
984 $this->mOptions = [];
985 foreach ( explode(
"\n", $message )
as $option ) {
989 } elseif ( substr(
$value, 0, 1 ) ==
'*' && substr(
$value, 1, 1 ) !=
'*' ) {
990 # A new group is starting...
993 } elseif ( substr(
$value, 0, 2 ) ==
'**' ) {
995 $opt = trim( substr(
$value, 2 ) );
996 if ( $optgroup ===
false ) {
997 $this->mOptions[$opt] = $opt;
999 $this->mOptions[$optgroup][$opt] = $opt;
1002 # groupless reason list
1004 $this->mOptions[$option] = $option;
1008 $this->mOptions = null;
1022 if ( $oldoptions === null ) {
1028 foreach ( $oldoptions
as $text => $data ) {
1031 'label' => (
string)$text,
1049 if ( is_array( $value ) ) {
1050 $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
1067 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1068 $errors = array_shift( $errors );
1071 if ( is_array( $errors ) ) {
1073 foreach ( $errors
as $error ) {
1074 if ( $error instanceof
Message ) {
1083 if ( $errors instanceof
Message ) {
1084 $errors = $errors->parse();
1100 if ( $this->mParent ) {
1101 $message->setContext( $this->mParent );
1114 return !empty( $this->mParams[
'nodata'] );
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
the array() calling protocol came about after MediaWiki 1.4rc1.
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
static tooltipAndAccesskeyAttribs($name, array $msgParams=[])
Returns the attributes for the tooltip and access key.
magic word the default is to use $key to get the label
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
static escapeId($id, $options=[])
Given a value, escape it so that it can be used in an id attribute and return it. ...
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
error also a ContextSource you ll probably need to make sure the header is varied on $request
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on
Allows to change the fields on the form that will be generated $name
static newFromSpecifier($value)
Transform a MessageSpecifier or a primitive value used interchangeably with specifiers (a message key...