Sub class of HTMLForm that provides the form section of SpecialUpload. More...

Collaboration diagram for UploadForm:

[legend]

Public Member Functions
	__construct (array $options=[], ?IContextSource $context=null, ?LinkRenderer $linkRenderer=null, ?LocalRepo $localRepo=null, ?Language $contentLanguage=null, ?NamespaceInfo $nsInfo=null, ?HookContainer $hookContainer=null)

	show ()
	Add the upload JS and show the form.

	trySubmit ()
	Empty function; submission is handled elsewhere.

Public Member Functions inherited from MediaWiki\HTMLForm\HTMLForm
	__construct ( $descriptor, IContextSource $context, $messagePrefix='')
	Build a new HTMLForm from an array of field attributes.

	addButton ( $data)
	Add a button to the form.

	addFields ( $descriptor)
	Add fields to the form.

	addFooterHtml ( $html, $section=null)
	Add footer HTML, inside the form.

	addFooterText ( $msg, $section=null)
	Add footer text, inside the form.

	addHeaderHtml ( $html, $section=null)
	Add HTML to the header, inside the form.

	addHeaderText ( $msg, $section=null)
	Add HTML to the header, inside the form.

	addHiddenField ( $name, $value, array $attribs=[])
	Add a hidden field to the output Array values are discarded for security reasons (per WebRequest::getVal)

	addHiddenFields (array $fields)
	Add an array of hidden fields to the output Array values are discarded for security reasons (per WebRequest::getVal)

	addPostHtml ( $html)
	Add HTML to the end of the display.

	addPostText ( $msg)
	Add text to the end of the display.

	addPreHtml ( $html)
	Add HTML to introductory message.

	addPreText ( $msg)
	Add HTML to introductory message.

	displayForm ( $submitResult)
	Display the form (sending to the context's OutputPage object), with an appropriate error message or stack of messages, and any validation errors, etc.

	displaySection ( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)

	filterDataForSubmit ( $data)
	Overload this if you want to apply special filtration routines to the form as a whole, after it's submitted but before it's processed.

	formatErrors ( $errors)
	Format a stack of error messages into a single HTML string.

	getAction ()
	Get the value for the action attribute of the form.

	getBody ()
	Get the whole body of the form.

	getButtons ()
	Get the submit and (potentially) reset buttons.

	getDisplayFormat ()
	Getter for displayFormat.

	getErrorsOrWarnings ( $elements, $elementsType)
	Returns a formatted list of errors or warnings from the given elements.

	getField ( $fieldname)

	getFooterHtml ( $section=null)
	Get footer HTML.

	getFooterText ( $section=null)
	Get footer text.

	getHeaderHtml ( $section=null)
	Get header HTML.

	getHeaderText ( $section=null)
	Get header text.

	getHiddenFields ()
	Get the hidden fields that should go inside the form.

	getHTML ( $submitResult)
	Returns the raw HTML generated by the form.

	getLegend ( $key)
	Get a string to go in the "<legend>" of a section fieldset.

	getMethod ()

	getPostHtml ()
	Get HTML at the end of the display.

	getPreHtml ()
	Get the introductory message HTML.

	getPreText ()
	Get the introductory message HTML.

	getSubmitText ()
	Get the text for the submit button, either customised or a default.

	getTitle ()

	hasField ( $fieldname)

	loadData ()

	needsJSForHtml5FormValidation ()
	Whether this form, with its current fields, requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.

	prepareForm ()
	Prepare form for submission.

	setAction ( $action)
	Set the value for the action attribute of the form.

	setAutocomplete ( $autocomplete)
	Set the value for the autocomplete attribute of the form.

	setCancelTarget ( $target)
	Sets the target where the user is redirected to after clicking cancel.

	setCollapsibleOptions ( $collapsedByDefault=false)
	Enable collapsible mode, and set whether the form is collapsed by default.

	setDisplayFormat ( $format)
	Set format in which to display the form.

	setFooterHtml ( $html, $section=null)
	Set footer HTML, inside the form.

	setFooterText ( $msg, $section=null)
	Set footer text, inside the form.

	setFormIdentifier (string $ident, bool $single=false)
	Set an internal identifier for this form.

	setHeaderHtml ( $html, $section=null)
	Set header HTML, inside the form.

	setHeaderText ( $msg, $section=null)
	Set header text, inside the form.

	setId ( $id)

	setIntro ( $msg)
	Set the introductory message, overwriting any existing message.

	setMessagePrefix ( $p)
	Set the prefix for various default messages.

	setMethod ( $method='post')
	Set the method used to submit the form.

	setName ( $name)

	setPostHtml ( $html)
	Set HTML at the end of the display.

	setPostText ( $msg)
	Set text at the end of the display.

	setPreHtml ( $html)
	Set the introductory message HTML, overwriting any existing message.

	setPreText ( $msg)
	Set the introductory message HTML, overwriting any existing message.

	setSections ( $sections)
	Set an array of information about sections.

	setSubmitCallback ( $cb)
	Set a callback to a function to do something with the form once it's been successfully validated.

	setSubmitDestructive ()
	Identify that the submit button in the form has a destructive action.

	setSubmitID ( $t)
	Set the id for the submit button.

	setSubmitName ( $name)

	setSubmitText ( $t)
	Set the text for the submit button.

	setSubmitTextMsg ( $msg)
	Set the text for the submit button to a message.

	setSubmitTooltip ( $name)

	setTableId ( $id)
	Set the id of the \<table\> or outermost \<div\> element.

	setTitle ( $t)
	Set the title for form submission.

	setTokenSalt ( $salt)
	Set the salt for the edit token.

	setValidationErrorMessage ( $msg)
	Set a message to display on a validation error.

	setWrapperAttributes ( $attributes)
	For internal use only.

	setWrapperLegend ( $legend)
	Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element.

	setWrapperLegendMsg ( $msg)
	Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.

	showAlways ()
	Same as self::show with the difference, that the form will be added to the output, no matter, if the validation was good or not.

	showCancel ( $show=true)
	Show a cancel button (or prevent it).

	suppressDefaultSubmit ( $suppressSubmit=true)
	Stop a default submit button being shown for this form.

	tryAuthorizedSubmit ()
	Try submitting, with edit token check first.

	wasSubmitted ()
	Test whether the form was considered to have been submitted or not, i.e.

	wrapForm ( $html)
	Wrap the form innards in an actual "<form>" element.

Public Member Functions inherited from MediaWiki\Context\ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getLanguageCode ()

	getOutput ()

	getRequest ()

	getSkin ()

	getTiming ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

Protected Member Functions
	addUploadJS ()
	Add upload JS to the OutputPage.

	getDescriptionSection ()
	Get the descriptor of the fieldset that contains the file description input.

	getExtensionsMessage ()
	Get the messages indicating which extensions are preferred and prohibited.

	getOptionsSection ()
	Get the descriptor of the fieldset that contains the upload options, such as "watch this file".

	getSourceSection ()
	Get the descriptor of the fieldset that contains the file source selection.

Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLForm
	formatField (HTMLFormField $field, $value)
	Generate the HTML for an individual field in the current display format.

	formatSection (array $fieldsHtml, $sectionName, $anyFieldHasLabel)
	Put a form section together from the individual fields' HTML, merging it and wrapping.

	getCancelTargetURL ()

	getFormAttributes ()
	Get HTML attributes for the `<form>` tag.

	getMessage ( $value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.

	loadFieldData ()
	Load data of form fields from the request.

	wrapFieldSetSection ( $legend, $section, $attributes, $isRoot)
	Wraps the given $section into a user-visible fieldset.

Protected Attributes
string	$mComment

string	$mDestFile

bool	$mDestWarningAck

bool	$mForReUpload

bool	$mHideIgnoreWarning

array	$mMaxUploadSize = []

string	$mSessionKey

string[]	$mSourceIds

string	$mTextAfterSummary
	raw html

string	$mTextTop
	raw html

bool	$mWatch

Protected Attributes inherited from MediaWiki\HTMLForm\HTMLForm
array	$availableDisplayFormats
	Available formats in which to display the form.

array	$availableSubclassDisplayFormats
	Available formats in which to display the form.

string	$displayFormat = 'table'
	Format in which to display form.

string false	$mAction = false
	Form action URL.

string null	$mAutocomplete = null
	Form attribute autocomplete.

array[]	$mButtons = []

LinkTarget string null	$mCancelTarget

bool	$mCollapsed = false
	Whether the form is collapsed by default.

bool	$mCollapsible = false
	Whether the form can be collapsed.

array	$mFieldTree = []

HTMLFormField[]	$mFlatFields = []

string	$mFooter = ''

string null	$mFormIdentifier

string	$mHeader = ''

array[]	$mHiddenFields = []

string null	$mId

string	$mMessagePrefix

string	$mMethod = 'post'

string null	$mName

string	$mPost = ''

string	$mPre = ''

string[]	$mSectionFooters = []

string[]	$mSectionHeaders = []

array[]	$mSections = []
	Additional information about form sections.

bool	$mShowCancel = false

bool	$mShowSubmit = true

bool	$mSingleForm = false

callable null	$mSubmitCallback

string[]	$mSubmitFlags = [ 'primary', 'progressive' ]

string null	$mSubmitID

string null	$mSubmitName

string null	$mSubmitText

string null	$mSubmitTooltip

bool	$mSubSectionBeforeFields = true
	If true, sections that contain both fields and subsections will render their subsections before their fields.

string	$mTableId = ''

Title null	$mTitle

string array	$mTokenSalt = ''
	Salt for the edit token.

bool	$mUseMultipart = false

array[]	$mValidationErrorMessage

bool	$mWasSubmitted = false

array	$mWrapperAttributes = []

string false	$mWrapperLegend = false

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\HTMLForm\HTMLForm
static	factory ( $displayFormat, $descriptor, IContextSource $context, $messagePrefix='')
	Construct a HTMLForm object for given display type.

static	getClassFromDescriptor ( $fieldname, &$descriptor)
	Get the HTMLFormField subclass for this descriptor.

static	loadInputFromParameters ( $fieldname, $descriptor, ?HTMLForm $parent=null)
	Initialise a new Object for the field.

Public Attributes inherited from MediaWiki\HTMLForm\HTMLForm
array	$mFieldData

Static Public Attributes inherited from MediaWiki\HTMLForm\HTMLForm
static string[]	$typeMappings
	A mapping of 'type' inputs onto standard HTMLFormField subclasses.

Detailed Description

Sub class of HTMLForm that provides the form section of SpecialUpload.

Definition at line 38 of file UploadForm.php.

Constructor & Destructor Documentation

◆ __construct()

UploadForm::__construct	(	array	$options = [],
		?IContextSource	$context = null,
		?LinkRenderer	$linkRenderer = null,
		?LocalRepo	$localRepo = null,
		?Language	$contentLanguage = null,
		?NamespaceInfo	$nsInfo = null,
		?HookContainer	$hookContainer = null )

Parameters

array	$options
IContextSource \| null	$context
LinkRenderer \| null	$linkRenderer
LocalRepo \| null	$localRepo
Language \| null	$contentLanguage
NamespaceInfo \| null	$nsInfo
HookContainer \| null	$hookContainer

Definition at line 79 of file UploadForm.php.

References MediaWiki\HTMLForm\HTMLForm\addFooterHtml(), MediaWiki\Context\ContextSource\getAuthority(), MediaWiki\Context\ContextSource\getContext(), getDescriptionSection(), getOptionsSection(), MediaWiki\Context\ContextSource\getOutput(), getSourceSection(), getTitle(), MediaWiki\Context\ContextSource\msg(), MediaWiki\Context\ContextSource\setContext(), MediaWiki\HTMLForm\HTMLForm\setId(), MediaWiki\HTMLForm\HTMLForm\setSubmitName(), MediaWiki\HTMLForm\HTMLForm\setSubmitTextMsg(), and MediaWiki\HTMLForm\HTMLForm\setSubmitTooltip().

Member Function Documentation

◆ addUploadJS()

UploadForm::addUploadJS ( )

protected

Add upload JS to the OutputPage.

Definition at line 459 of file UploadForm.php.

References MediaWiki\Context\ContextSource\getConfig(), and MediaWiki\Context\ContextSource\getOutput().

Referenced by show().

◆ getDescriptionSection()

UploadForm::getDescriptionSection ( )

protected

Get the descriptor of the fieldset that contains the file description input.

The section is 'description'

Returns: array Descriptor array

Definition at line 305 of file UploadForm.php.

References MediaWiki\HTMLForm\HTMLForm\addHeaderHtml(), MediaWiki\Context\ContextSource\getConfig(), and MediaWiki\Context\ContextSource\getUser().

Referenced by __construct().

◆ getExtensionsMessage()

UploadForm::getExtensionsMessage ( )

protected

Get the messages indicating which extensions are preferred and prohibited.

Returns: string HTML string containing the message

Definition at line 257 of file UploadForm.php.

References MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Context\ContextSource\getLanguage(), and MediaWiki\Context\ContextSource\msg().

Referenced by getSourceSection().

◆ getOptionsSection()

UploadForm::getOptionsSection ( )

protected

Get the descriptor of the fieldset that contains the upload options, such as "watch this file".

The section is 'options'

Returns: array Descriptor array

Definition at line 408 of file UploadForm.php.

References MediaWiki\Context\ContextSource\getUser().

Referenced by __construct().

◆ getSourceSection()

UploadForm::getSourceSection ( )

protected

Get the descriptor of the fieldset that contains the file source selection.

The section is 'source'

Returns: array Descriptor array

Definition at line 166 of file UploadForm.php.

References MediaWiki\Context\ContextSource\getAuthority(), MediaWiki\Context\ContextSource\getConfig(), getExtensionsMessage(), MediaWiki\Context\ContextSource\getRequest(), and MediaWiki\Context\ContextSource\msg().

Referenced by __construct().

◆ show()

UploadForm::show ( )

Add the upload JS and show the form.

Returns: bool|Status

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 451 of file UploadForm.php.

References addUploadJS().

◆ trySubmit()

UploadForm::trySubmit ( )

Empty function; submission is handled elsewhere.

Returns: bool False

Reimplemented from MediaWiki\HTMLForm\HTMLForm.

Definition at line 492 of file UploadForm.php.

Member Data Documentation

◆ $mComment

string UploadForm::$mComment

protected

Definition at line 53 of file UploadForm.php.

◆ $mDestFile

string UploadForm::$mDestFile

protected

Definition at line 50 of file UploadForm.php.

◆ $mDestWarningAck

bool UploadForm::$mDestWarningAck

protected

Definition at line 48 of file UploadForm.php.

◆ $mForReUpload

bool UploadForm::$mForReUpload

protected

Definition at line 42 of file UploadForm.php.

◆ $mHideIgnoreWarning

bool UploadForm::$mHideIgnoreWarning

protected

Definition at line 46 of file UploadForm.php.

◆ $mMaxUploadSize

array UploadForm::$mMaxUploadSize = []

protected

Definition at line 63 of file UploadForm.php.

◆ $mSessionKey

string UploadForm::$mSessionKey

protected

Definition at line 44 of file UploadForm.php.

◆ $mSourceIds

string [] UploadForm::$mSourceIds

protected

Definition at line 60 of file UploadForm.php.

◆ $mTextAfterSummary

string UploadForm::$mTextAfterSummary

protected

raw html

Definition at line 57 of file UploadForm.php.

◆ $mTextTop

string UploadForm::$mTextTop

protected

raw html

Definition at line 55 of file UploadForm.php.

◆ $mWatch

bool UploadForm::$mWatch

protected

Definition at line 40 of file UploadForm.php.

The documentation for this class was generated from the following file:

includes/specials/forms/UploadForm.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUploadJS()

◆ getDescriptionSection()

◆ getExtensionsMessage()

◆ getOptionsSection()

◆ getSourceSection()

◆ show()

◆ trySubmit()

Member Data Documentation

◆ $mComment

◆ $mDestFile

◆ $mDestWarningAck

◆ $mForReUpload

◆ $mHideIgnoreWarning

◆ $mMaxUploadSize

◆ $mSessionKey

◆ $mSourceIds

◆ $mTextAfterSummary

◆ $mTextTop

◆ $mWatch