MediaWiki  master
UploadForm Class Reference

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

Inheritance diagram for UploadForm:
Collaboration diagram for UploadForm:

Public Member Functions

 __construct (array $options=[], IContextSource $context=null, LinkRenderer $linkRenderer=null, PermissionManager $permissionManager=null, LocalRepo $localRepo=null, Language $contentLanguage=null, NamespaceInfo $nsInfo=null)
 
 show ()
 Add the upload JS and show the form. More...
 
 trySubmit ()
 Empty function; submission is handled elsewhere. More...
 
- Public Member Functions inherited from HTMLForm
 __construct ( $descriptor, $context=null, $messagePrefix='')
 Build a new HTMLForm from an array of field attributes. More...
 
 addButton ( $data)
 Add a button to the form. More...
 
 addFields ( $descriptor)
 Add fields to the form. More...
 
 addFooterText ( $msg, $section=null)
 Add footer text, inside the form. More...
 
 addHeaderText ( $msg, $section=null)
 Add HTML to the header, inside the form. More...
 
 addHiddenField ( $name, $value, array $attribs=[])
 Add a hidden field to the output. More...
 
 addHiddenFields (array $fields)
 Add an array of hidden fields to the output. More...
 
 addPostText ( $msg)
 Add text to the end of the display. More...
 
 addPreText ( $msg)
 Add HTML to introductory message. More...
 
 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. More...
 
 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. More...
 
 formatErrors ( $errors)
 Format a stack of error messages into a single HTML string. More...
 
 getAction ()
 Get the value for the action attribute of the form. More...
 
 getBody ()
 Get the whole body of the form. More...
 
 getButtons ()
 Get the submit and (potentially) reset buttons. More...
 
 getDisplayFormat ()
 Getter for displayFormat. More...
 
 getErrorsOrWarnings ( $elements, $elementsType)
 Returns a formatted list of errors or warnings from the given elements. More...
 
 getField ( $fieldname)
 
 getFooterText ( $section=null)
 Get footer text. More...
 
 getHeaderText ( $section=null)
 Get header text. More...
 
 getHiddenFields ()
 Get the hidden fields that should go inside the form. More...
 
 getHTML ( $submitResult)
 Returns the raw HTML generated by the form. More...
 
 getLegend ( $key)
 Get a string to go in the "<legend>" of a section fieldset. More...
 
 getMethod ()
 
 getPreText ()
 Get the introductory message HTML. More...
 
 getSubmitText ()
 Get the text for the submit button, either customised or a default. More...
 
 getTitle ()
 
 hasField ( $fieldname)
 
 loadData ()
 Construct the form fields from the Descriptor array. More...
 
 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. More...
 
 prepareForm ()
 Prepare form for submission. More...
 
 setAction ( $action)
 Set the value for the action attribute of the form. More...
 
 setAutocomplete ( $autocomplete)
 Set the value for the autocomplete attribute of the form. More...
 
 setCancelTarget ( $target)
 Sets the target where the user is redirected to after clicking cancel. More...
 
 setCollapsibleOptions ( $collapsedByDefault=false)
 Enable collapsible mode, and set whether the form is collapsed by default. More...
 
 setDisplayFormat ( $format)
 Set format in which to display the form. More...
 
 setFooterText ( $msg, $section=null)
 Set footer text, inside the form. More...
 
 setFormIdentifier ( $ident)
 Set an internal identifier for this form. More...
 
 setHeaderText ( $msg, $section=null)
 Set header text, inside the form. More...
 
 setId ( $id)
 
 setIntro ( $msg)
 Set the introductory message, overwriting any existing message. More...
 
 setMessagePrefix ( $p)
 Set the prefix for various default messages. More...
 
 setMethod ( $method='post')
 Set the method used to submit the form. More...
 
 setName ( $name)
 
 setPostText ( $msg)
 Set text at the end of the display. More...
 
 setPreText ( $msg)
 Set the introductory message HTML, overwriting any existing message. More...
 
 setSubmitCallback ( $cb)
 Set a callback to a function to do something with the form once it's been successfully validated. More...
 
 setSubmitDestructive ()
 Identify that the submit button in the form has a destructive action. More...
 
 setSubmitID ( $t)
 Set the id for the submit button. More...
 
 setSubmitName ( $name)
 
 setSubmitText ( $t)
 Set the text for the submit button. More...
 
 setSubmitTextMsg ( $msg)
 Set the text for the submit button to a message. More...
 
 setSubmitTooltip ( $name)
 
 setTableId ( $id)
 Set the id of the \<table\> or outermost \<div\> element. More...
 
 setTitle ( $t)
 Set the title for form submission. More...
 
 setTokenSalt ( $salt)
 Set the salt for the edit token. More...
 
 setValidationErrorMessage ( $msg)
 Set a message to display on a validation error. More...
 
 setWrapperAttributes ( $attributes)
 For internal use only. More...
 
 setWrapperLegend ( $legend)
 Prompt the whole form to be wrapped in a "<fieldset>", with this text as its "<legend>" element. More...
 
 setWrapperLegendMsg ( $msg)
 Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element. More...
 
 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. More...
 
 showCancel ( $show=true)
 Show a cancel button (or prevent it). More...
 
 suppressDefaultSubmit ( $suppressSubmit=true)
 Stop a default submit button being shown for this form. More...
 
 suppressReset ( $suppressReset=true)
 Stop a reset button being shown for this form. More...
 
 tryAuthorizedSubmit ()
 Try submitting, with edit token check first. More...
 
 wasSubmitted ()
 Test whether the form was considered to have been submitted or not, i.e. More...
 
 wrapForm ( $html)
 Wrap the form innards in an actual "<form>" element Stable to override. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getUser ()
 Stable to override. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Protected Member Functions

 addUploadJS ()
 Add upload JS to the OutputPage. More...
 
 getDescriptionSection ()
 Get the descriptor of the fieldset that contains the file description input. More...
 
 getExtensionsMessage ()
 Get the messages indicating which extensions are preferred and prohibitted. More...
 
 getOptionsSection ()
 Get the descriptor of the fieldset that contains the upload options, such as "watch this file". More...
 
 getSourceSection ()
 Get the descriptor of the fieldset that contains the file source selection. More...
 
- Protected Member Functions inherited from HTMLForm
 formatSection (array $fieldsHtml, $sectionName, $anyFieldHasLabel)
 Put a form section together from the individual fields' HTML, merging it and wrapping. More...
 
 getFormAttributes ()
 Get HTML attributes for the <form> tag. More...
 
 getMessage ( $value)
 Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message. More...
 
 wrapFieldSetSection ( $legend, $section, $attributes, $isRoot)
 Wraps the given $section into an user-visible fieldset. More...
 

Protected Attributes

 $mComment
 
 $mDestFile
 
 $mDestWarningAck
 
 $mForReUpload
 
 $mHideIgnoreWarning
 
 $mMaxFileSize = []
 
array $mMaxUploadSize = []
 
 $mSessionKey
 
 $mSourceIds
 
 $mTextAfterSummary
 
 $mTextTop
 
 $mWatch
 
- Protected Attributes inherited from HTMLForm
array $availableDisplayFormats
 Available formats in which to display the form. More...
 
array $availableSubclassDisplayFormats
 Available formats in which to display the form. More...
 
string $displayFormat = 'table'
 Format in which to display form. More...
 
bool string $mAction = false
 Form action URL. More...
 
string null $mAutocomplete = null
 Form attribute autocomplete. More...
 
array[] $mButtons = []
 -var array<array{name:string,value:string,label-message?:string|string[]|MessageSpecifier,label?:string,label-raw?:string,id?:string,attribs?:array,flags?:string|string[],framed?:bool}> More...
 
 $mCancelTarget
 
bool $mCollapsed = false
 Whether the form is collapsed by default. More...
 
bool $mCollapsible = false
 Whether the form can be collapsed. More...
 
 $mFieldTree = []
 
HTMLFormField[] $mFlatFields = []
 
 $mFooter = ''
 
 $mFormIdentifier
 
 $mHeader = ''
 
array[] $mHiddenFields = []
 -var array<int,array{0:string,1:array}> More...
 
 $mId
 
 $mMessagePrefix
 
 $mMethod = 'post'
 
 $mName
 
 $mPost = ''
 
 $mPre = ''
 
 $mSectionFooters = []
 
 $mSectionHeaders = []
 
 $mShowCancel = false
 
 $mShowReset = false
 
 $mShowSubmit = true
 
 $mSubmitCallback
 
string[] $mSubmitFlags = [ 'primary', 'progressive' ]
 
 $mSubmitID
 
 $mSubmitName
 
 $mSubmitText
 
 $mSubmitTooltip
 
bool $mSubSectionBeforeFields = true
 If true, sections that contain both fields and subsections will render their subsections before their fields. More...
 
 $mTableId = ''
 
 $mTitle
 
string array $mTokenSalt = ''
 Salt for the edit token. More...
 
 $mUseMultipart = false
 
 $mValidationErrorMessage
 
 $mWasSubmitted = false
 
 $mWrapperAttributes = []
 
 $mWrapperLegend = false
 

Private Attributes

Language $contentLanguage
 
LocalRepo $localRepo
 
NamespaceInfo $nsInfo
 

Additional Inherited Members

- Static Public Member Functions inherited from HTMLForm
static factory ( $displayFormat,... $arguments)
 Construct a HTMLForm object for given display type. More...
 
static getClassFromDescriptor ( $fieldname, &$descriptor)
 Get the HTMLFormField subclass for this descriptor. More...
 
static loadInputFromParameters ( $fieldname, $descriptor, HTMLForm $parent=null)
 Initialise a new Object for the field Stable to override. More...
 
- Public Attributes inherited from HTMLForm
 $mFieldData
 
- Static Public Attributes inherited from HTMLForm
static string[] $typeMappings
 A mapping of 'type' inputs onto standard HTMLFormField subclasses. More...
 

Detailed Description

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

Definition at line 28 of file UploadForm.php.

Constructor & Destructor Documentation

◆ __construct()

UploadForm::__construct ( array  $options = [],
IContextSource  $context = null,
LinkRenderer  $linkRenderer = null,
PermissionManager  $permissionManager = null,
LocalRepo  $localRepo = null,
Language  $contentLanguage = null,
NamespaceInfo  $nsInfo = null 
)
Parameters
array$options
IContextSource | null$context
LinkRenderer | null$linkRenderer
PermissionManager | null$permissionManager
LocalRepo | null$localRepo
Language | null$contentLanguage
NamespaceInfo | null$nsInfo

Definition at line 65 of file UploadForm.php.

References $contentLanguage, ContextSource\$context, $localRepo, $nsInfo, HTMLForm\addFooterText(), getDescriptionSection(), getOptionsSection(), ContextSource\getOutput(), getSourceSection(), HTMLForm\getTitle(), ContextSource\msg(), ContextSource\setContext(), HTMLForm\setId(), HTMLForm\setSubmitName(), HTMLForm\setSubmitText(), and HTMLForm\setSubmitTooltip().

Member Function Documentation

◆ addUploadJS()

UploadForm::addUploadJS ( )
protected

◆ 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 296 of file UploadForm.php.

References $file, $mComment, $mDestFile, $mTextAfterSummary, HTMLForm\addHeaderText(), Html\element(), ContextSource\getConfig(), and ContextSource\getUser().

Referenced by __construct().

◆ getExtensionsMessage()

UploadForm::getExtensionsMessage ( )
protected

Get the messages indicating which extensions are preferred and prohibitted.

Returns
string HTML string containing the message

Definition at line 249 of file UploadForm.php.

References ContextSource\getConfig(), ContextSource\getLanguage(), and 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 395 of file UploadForm.php.

References $mWatch, and ContextSource\getUser().

Referenced by __construct().

◆ getSourceSection()

UploadForm::getSourceSection ( )
protected

◆ show()

UploadForm::show ( )

Add the upload JS and show the form.

Returns
bool|Status

Reimplemented from HTMLForm.

Definition at line 438 of file UploadForm.php.

References addUploadJS().

◆ trySubmit()

UploadForm::trySubmit ( )

Empty function; submission is handled elsewhere.

Returns
bool False

Reimplemented from HTMLForm.

Definition at line 480 of file UploadForm.php.

Member Data Documentation

◆ $contentLanguage

Language UploadForm::$contentLanguage
private

Definition at line 51 of file UploadForm.php.

Referenced by __construct().

◆ $localRepo

LocalRepo UploadForm::$localRepo
private

Definition at line 48 of file UploadForm.php.

Referenced by __construct().

◆ $mComment

UploadForm::$mComment
protected

Definition at line 36 of file UploadForm.php.

Referenced by getDescriptionSection().

◆ $mDestFile

UploadForm::$mDestFile
protected

Definition at line 34 of file UploadForm.php.

Referenced by getDescriptionSection().

◆ $mDestWarningAck

UploadForm::$mDestWarningAck
protected

Definition at line 33 of file UploadForm.php.

◆ $mForReUpload

UploadForm::$mForReUpload
protected

Definition at line 30 of file UploadForm.php.

◆ $mHideIgnoreWarning

UploadForm::$mHideIgnoreWarning
protected

Definition at line 32 of file UploadForm.php.

◆ $mMaxFileSize

UploadForm::$mMaxFileSize = []
protected

Definition at line 42 of file UploadForm.php.

◆ $mMaxUploadSize

array UploadForm::$mMaxUploadSize = []
protected

Definition at line 45 of file UploadForm.php.

Referenced by addUploadJS().

◆ $mSessionKey

UploadForm::$mSessionKey
protected

Definition at line 31 of file UploadForm.php.

Referenced by getSourceSection().

◆ $mSourceIds

UploadForm::$mSourceIds
protected

Definition at line 40 of file UploadForm.php.

Referenced by addUploadJS().

◆ $mTextAfterSummary

UploadForm::$mTextAfterSummary
protected

Definition at line 38 of file UploadForm.php.

Referenced by getDescriptionSection().

◆ $mTextTop

UploadForm::$mTextTop
protected

Definition at line 37 of file UploadForm.php.

Referenced by getSourceSection().

◆ $mWatch

UploadForm::$mWatch
protected

Definition at line 29 of file UploadForm.php.

Referenced by getOptionsSection().

◆ $nsInfo

NamespaceInfo UploadForm::$nsInfo
private

Definition at line 54 of file UploadForm.php.

Referenced by __construct().


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