A License class for use on Special:Upload. More...

Inherits MediaWiki\HTMLForm\HTMLFormField.

Collaboration diagram for MediaWiki\Specials\FormFields\Licenses:

[legend]

Public Member Functions

__construct ( $params)

getInputHTML ( $value)

This function must be implemented to return the HTML to generate the input object itself.It should not implement the surrounding table cells/rows, or labels/help messages.

Parameters

mixed $value The value to set the input to; eg a default text for a text input.

Returns: string Valid HTML.

getLicenses ()

Accessor for $this->lines.

getLines ()

Accessor for $this->lines.

Public Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField

cancelSubmit ( $value, $alldata)

Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.

canDisplayErrors ()

True if this field type is able to display errors; false if validation errors need to be displayed in the main HTMLForm error area.

filter ( $value, $alldata)

getAttributes (array $list)

Returns the given attributes from the parameters.

getCodex ( $value)

Get the Codex version of the div.

getDefault ()

getDescriptionHtmlSpan (?string $descriptionHtml, array $cssClasses=[])

getDescriptionText ()

Determine the help text to display.

getDiv ( $value)

Get the complete div for the input, including help text, labels, and whatever.

getErrorsAndErrorClass ( $value)

Determine form errors to display and their classes.

getErrorsRaw ( $value)

Determine form errors to display, returning them in an array.

getHelpText ()

Determine the help text to display.

getHelpTextHtmlDiv ( $helptext, $cssClasses=[])

Generate help text HTML in div format.

getHelpTextHtmlRaw ( $helptext)

Generate help text HTML formatted for raw output.

getHelpTextHtmlTable ( $helptext)

Generate help text HTML in table format.

getInline ( $value)

Get the complete field as an inline element.

getInputCodex ( $value, $hasErrors)

Same as getInputHTML, but for Codex.

getInputOOUI ( $value)

Same as getInputHTML, but returns an OOUI object.

getLabel ()

getLabelHtml ( $cellAttributes=[])

getName ()

Get the field name that will be used for submission.

getOOUI ( $value)

Get the OOUI version of the div.

getOptions ()

Fetch the array of options from the field's parameters.

getOptionsOOUI ()

Get options and make them into arrays suitable for OOUI.

getRaw ( $value)

Get the complete raw fields for the input, including help text, labels, and whatever.

getTableRow ( $value)

Get the complete table row for the input, including help text, labels, and whatever.

getTooltipAndAccessKey ()

Returns the attributes required for the tooltip and accesskey, for Html::element() etc.

getTooltipAndAccessKeyOOUI ()

Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.

hasVisibleOutput ()

If this field has a user-visible output or not.

isDisabled ( $alldata)

Test whether this field is supposed to be disabled, based on the values of the other form fields.

isDisabledNoJs ( $alldata)

Test whether this field is disabled in the generated HTML, either due to the 'disabled' parameter, or due to 'hide-if-nojs' or 'disable-if-nojs' rules.

isHelpInline ()

Determine if the help text should be displayed inline.

isHidden ( $alldata)

Test whether this field is supposed to be hidden, based on the values of the other form fields.

isHiddenNoJs ( $alldata)

Test whether this field is hidden in the generated HTML due to 'hide-if-nojs' rules.

loadDataFromRequest ( $request)

Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.

msg ( $key,... $params)

Get a translated interface message.

needsJSForHtml5FormValidation ()

Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.

setShowEmptyLabel ( $show)

Tell the field whether to generate a separate label element if its label is blank.

skipLoadData ( $request)

Skip this field when collecting data.

validate ( $value, $alldata)

Override this function to add specific validation checks on the field input.

Protected Member Functions
	buildLine ( $line)

	makeHtml ( $tagset, $depth=0)

	makeLines ()

	outputOption ( $message, $value, $attribs=null, $depth=0)

	stackItem (&$list, $path, $item)

	trimStars ( $str)

Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField
	checkStateRecurse (array $alldata, array $params)
	Helper function for isHidden and isDisabled to handle recursive data structures.

	escapeLabel ( $label)
	The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

	getClassName ()
	Gets the non namespaced class name.

	getFieldLayoutOOUI ( $inputField, $config)
	Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.

	getLabelAlignOOUI ()
	Get label alignment when generating field for OOUI.

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

	getNearestField ( $name, $backCompat=false)
	Get the closest field matching a given name.

	getNearestFieldByName ( $alldata, $name, $asDisplay=false)
	Fetch a field value from $alldata for the closest field matching a given name.

	getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
	Fetch a field value from $alldata for the closest field matching a given name.

	getOOUIModules ()
	Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.

	isSubmitAttempt (WebRequest $request)
	Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just view it? This can't normally be distinguished for e.g.

	makeLabelSnippet ( $label)
	The keys in the array returned by getOptions() can be either HTML or plain text depending on $this->mOptionsLabelsNotFromMessage.

	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to?

	parseCondState ( $params)
	Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML.

	parseCondStateForClient ()
	Parse the cond-state array for client-side.

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

	validateCondState ( $params)
	Validate the cond-state params, the existence check of fields should be done later.

Static Protected Member Functions
static	getMessageFromParams ( $params)

Static Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Protected Attributes
string	$html

array License[]	$lines = []

string	$msg

string	$selected

Protected Attributes inherited from MediaWiki\HTMLForm\HTMLFormField
string	$mClass = ''

array	$mCondState = []
	Array to hold params for 'hide-if' or 'disable-if' statements.

array	$mCondStateClass = []

mixed	$mDefault

string	$mDir

string false	$mHelpClass = false

string	$mID

string	$mLabel
	String label, as HTML.

string	$mName

array null false	$mOptions = false

bool	$mOptionsLabelsNotFromMessage = false

bool	$mShowEmptyLabels = true
	If true will generate an empty div element with no label.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField
static	flattenOptions ( $options)
	flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>".

static	forceToStringRecursive ( $array)
	Recursively forces values in an array to strings, because issues arise with integer 0 as a value.

Public Attributes inherited from MediaWiki\HTMLForm\HTMLFormField
array array[]	$mParams

HTMLForm	$mParent

Detailed Description

A License class for use on Special:Upload.

Definition at line 22 of file Licenses.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\FormFields\Licenses::__construct ( $params )

Parameters

array $params

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 32 of file Licenses.php.

References MediaWiki\Specials\FormFields\Licenses\makeLines(), and MediaWiki\HTMLForm\HTMLFormField\msg().

Member Function Documentation

◆ buildLine()

MediaWiki\Specials\FormFields\Licenses::buildLine ( $line )

protected

Parameters

string $line

Returns: License

Definition at line 70 of file Licenses.php.

Referenced by MediaWiki\Specials\FormFields\Licenses\getInputHTML(), and MediaWiki\Specials\FormFields\Licenses\makeLines().

◆ getInputHTML()

MediaWiki\Specials\FormFields\Licenses::getInputHTML ( $value )

This function must be implemented to return the HTML to generate the input object itself.It should not implement the surrounding table cells/rows, or labels/help messages.

Parameters

mixed $value The value to set the input to; eg a default text for a text input.

Returns: string Valid HTML.

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 199 of file Licenses.php.

References MediaWiki\Specials\FormFields\Licenses\$html, MediaWiki\HTMLForm\HTMLFormField\$mID, MediaWiki\HTMLForm\HTMLFormField\$mName, MediaWiki\Specials\FormFields\Licenses\buildLine(), MediaWiki\Specials\FormFields\Licenses\getLines(), and MediaWiki\Specials\FormFields\Licenses\makeHtml().

◆ getLicenses()

MediaWiki\Specials\FormFields\Licenses::getLicenses ( )

Accessor for $this->lines.

Returns: array

Deprecated: since 1.31 Use getLines() instead

Definition at line 192 of file Licenses.php.

References MediaWiki\Specials\FormFields\Licenses\getLines().

◆ getLines()

MediaWiki\Specials\FormFields\Licenses::getLines ( )

Accessor for $this->lines.

Returns: License[]

Definition at line 181 of file Licenses.php.

References MediaWiki\Specials\FormFields\Licenses\$lines.

Referenced by MediaWiki\Specials\FormFields\Licenses\getInputHTML(), and MediaWiki\Specials\FormFields\Licenses\getLicenses().

◆ getMessageFromParams()

static MediaWiki\Specials\FormFields\Licenses::getMessageFromParams ( $params )

staticprotected

Parameters

array $params

Returns: string

Definition at line 45 of file Licenses.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfMessage().

◆ makeHtml()

MediaWiki\Specials\FormFields\Licenses::makeHtml	(		$tagset,
			$depth = 0 )

protected

Parameters

array	$tagset
int	$depth

Returns: string

Definition at line 132 of file Licenses.php.

References MediaWiki\Specials\FormFields\Licenses\$html, MediaWiki\Specials\FormFields\Licenses\makeHtml(), and MediaWiki\Specials\FormFields\Licenses\outputOption().

Referenced by MediaWiki\Specials\FormFields\Licenses\getInputHTML(), and MediaWiki\Specials\FormFields\Licenses\makeHtml().

◆ makeLines()

MediaWiki\Specials\FormFields\Licenses::makeLines ( )

protected

Access: internal

Definition at line 77 of file Licenses.php.

References MediaWiki\Specials\FormFields\Licenses\$lines, MediaWiki\Specials\FormFields\Licenses\buildLine(), MediaWiki\HTMLForm\HTMLFormField\msg(), MediaWiki\Specials\FormFields\Licenses\stackItem(), and MediaWiki\Specials\FormFields\Licenses\trimStars().

Referenced by MediaWiki\Specials\FormFields\Licenses\__construct().

◆ outputOption()

MediaWiki\Specials\FormFields\Licenses::outputOption	(	$message,
		$value,
		$attribs = null,
		$depth = 0 )

protected

Parameters

string	$message
string	$value
null \| array	$attribs
int	$depth

Returns: string

Definition at line 164 of file Licenses.php.

References MediaWiki\Html\element(), and MediaWiki\HTMLForm\HTMLFormField\msg().

Referenced by MediaWiki\Specials\FormFields\Licenses\makeHtml().

◆ stackItem()

MediaWiki\Specials\FormFields\Licenses::stackItem	(	&	$list,
			$path,
			$item )

protected

Parameters

License[]	&$list
int[]	$path
License	$item

Definition at line 117 of file Licenses.php.

References $path.

Referenced by MediaWiki\Specials\FormFields\Licenses\makeLines().

◆ trimStars()

MediaWiki\Specials\FormFields\Licenses::trimStars ( $str )

protected

Parameters

string $str

Returns: array

Definition at line 107 of file Licenses.php.

Referenced by MediaWiki\Specials\FormFields\Licenses\makeLines().

Member Data Documentation

◆ $html

string MediaWiki\Specials\FormFields\Licenses::$html

protected

Definition at line 26 of file Licenses.php.

Referenced by MediaWiki\Specials\FormFields\Licenses\getInputHTML(), and MediaWiki\Specials\FormFields\Licenses\makeHtml().

◆ $lines

array License [] MediaWiki\Specials\FormFields\Licenses::$lines = []

protected

Definition at line 25 of file Licenses.php.

Referenced by MediaWiki\Specials\FormFields\Licenses\getLines(), and MediaWiki\Specials\FormFields\Licenses\makeLines().

◆ $msg

string MediaWiki\Specials\FormFields\Licenses::$msg

protected

Definition at line 23 of file Licenses.php.

◆ $selected

string MediaWiki\Specials\FormFields\Licenses::$selected

protected

Definition at line 27 of file Licenses.php.

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

includes/Specials/FormFields/Licenses.php

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildLine()

◆ getInputHTML()

◆ getLicenses()

◆ getLines()

◆ getMessageFromParams()

◆ makeHtml()

◆ makeLines()

◆ outputOption()

◆ stackItem()

◆ trimStars()

Member Data Documentation

◆ $html

◆ $lines

◆ $msg

◆ $selected