MediaWiki  master
Licenses Class Reference

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

Inheritance diagram for Licenses:
Collaboration diagram for Licenses:

Public Member Functions

 __construct ( $params)
 #- More...
 
 getInputHTML ( $value)
 
 getLicenses ()
 Accessor for $this->lines. More...
 
 getLines ()
 #- More...
 
- Public Member Functions inherited from HTMLFormField
 __construct ( $params)
 Initialise the object. More...
 
 cancelSubmit ( $value, $alldata)
 Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm. More...
 
 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. More...
 
 filter ( $value, $alldata)
 
 getAttributes (array $list)
 Returns the given attributes from the parameters. More...
 
 getDefault ()
 
 getDiv ( $value)
 Get the complete div for the input, including help text, labels, and whatever. More...
 
 getErrorsAndErrorClass ( $value)
 Determine form errors to display and their classes. More...
 
 getErrorsRaw ( $value)
 Determine form errors to display, returning them in an array. More...
 
 getHelpText ()
 Determine the help text to display. More...
 
 getHelpTextHtmlDiv ( $helptext)
 Generate help text HTML in div format. More...
 
 getHelpTextHtmlRaw ( $helptext)
 Generate help text HTML formatted for raw output. More...
 
 getHelpTextHtmlTable ( $helptext)
 Generate help text HTML in table format. More...
 
 getInline ( $value)
 Get the complete field as an inline element. More...
 
 getInputHTML ( $value)
 This function must be implemented to return the HTML to generate the input object itself. More...
 
 getInputOOUI ( $value)
 Same as getInputHTML, but returns an OOUI object. More...
 
 getLabel ()
 
 getLabelHtml ( $cellAttributes=[])
 
 getOOUI ( $value)
 Get the OOUI version of the div. More...
 
 getOptions ()
 Fetch the array of options from the field's parameters. More...
 
 getOptionsOOUI ()
 Get options and make them into arrays suitable for OOUI. More...
 
 getRaw ( $value)
 Get the complete raw fields for the input, including help text, labels, and whatever. More...
 
 getTableRow ( $value)
 Get the complete table row for the input, including help text, labels, and whatever. More...
 
 getTooltipAndAccessKey ()
 Returns the attributes required for the tooltip and accesskey, for Html::element() etc. More...
 
 getTooltipAndAccessKeyOOUI ()
 Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config. More...
 
 getVForm ( $value)
 Get the complete field for the input, including help text, labels, and whatever. More...
 
 hasVisibleOutput ()
 If this field has a user-visible output or not. More...
 
 isHelpInline ()
 Determine if the help text should be displayed inline. More...
 
 isHidden ( $alldata)
 Test whether this field is supposed to be hidden, based on the values of the other form fields. More...
 
 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. More...
 
 msg ( $key,... $params)
 Get a translated interface message. More...
 
 needsJSForHtml5FormValidation ()
 Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly. More...
 
 setShowEmptyLabel ( $show)
 Tell the field whether to generate a separate label element if its label is blank. More...
 
 skipLoadData ( $request)
 Skip this field when collecting data. More...
 
 validate ( $value, $alldata)
 Override this function to add specific validation checks on the field input. More...
 

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 HTMLFormField
 getFieldLayoutOOUI ( $inputField, $config)
 Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output. More...
 
 getLabelAlignOOUI ()
 Get label alignment when generating field for OOUI. 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...
 
 getNearestFieldByName ( $alldata, $name)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 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. More...
 
 isHiddenRecurse (array $alldata, array $params)
 Helper function for isHidden to handle recursive data structures. More...
 
 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. More...
 
 needsLabel ()
 Should this field have a label, or is there no input element with the appropriate id for the label to point to? More...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 

Static Protected Member Functions

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

Protected Attributes

string $html
 
array $lines = []
 
string $msg
 
string null $selected
 
- Protected Attributes inherited from HTMLFormField
 $mClass = ''
 
 $mDefault
 
 $mDir
 
 $mFilterCallback
 
 $mHelpClass = false
 
 $mHideIf = null
 
 $mID
 
 $mLabel
 
 $mName
 
array bool null $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 
 $mVFormClass = ''
 

Additional Inherited Members

- Static Public Member Functions inherited from HTMLFormField
static flattenOptions ( $options)
 flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>". More...
 
static forceToStringRecursive ( $array)
 Recursively forces values in an array to strings, because issues arise with integer 0 as a value. More...
 
- Public Attributes inherited from HTMLFormField
array array [] $mParams
 
HTMLForm null $mParent
 

Detailed Description

A License class for use on Special:Upload.

Definition at line 31 of file Licenses.php.

Constructor & Destructor Documentation

◆ __construct()

Licenses::__construct (   $params)

#-

Parameters
array$params

Definition at line 48 of file Licenses.php.

References makeLines(), and HTMLFormField\msg().

Member Function Documentation

◆ buildLine()

Licenses::buildLine (   $line)
protected
Parameters
string$line
Returns
License

Definition at line 86 of file Licenses.php.

References $line.

Referenced by getInputHTML(), and makeLines().

◆ getInputHTML()

Licenses::getInputHTML (   $value)

◆ getLicenses()

Licenses::getLicenses ( )

Accessor for $this->lines.

Returns
array
Deprecated:
since 1.31 Use getLines() instead

Definition at line 212 of file Licenses.php.

References getLines().

◆ getLines()

Licenses::getLines ( )

#-

Accessor for $this->lines

Returns
array

Definition at line 201 of file Licenses.php.

References $lines.

Referenced by getInputHTML(), and getLicenses().

◆ getMessageFromParams()

static Licenses::getMessageFromParams (   $params)
staticprotected
Parameters
array$params
Returns
string

Definition at line 61 of file Licenses.php.

References wfMessage().

◆ makeHtml()

Licenses::makeHtml (   $tagset,
  $depth = 0 
)
protected
Parameters
array$tagset
int$depth
Returns
string

Definition at line 149 of file Licenses.php.

References $html, and outputOption().

Referenced by getInputHTML().

◆ makeLines()

Licenses::makeLines ( )
protected
Access:
private

Definition at line 93 of file Licenses.php.

References $line, buildLine(), HTMLFormField\msg(), stackItem(), and trimStars().

Referenced by __construct().

◆ outputOption()

Licenses::outputOption (   $message,
  $value,
  $attribs = null,
  $depth = 0 
)
protected
Parameters
string$message
string$value
null | array$attribs
int$depth
Returns
string

Definition at line 182 of file Licenses.php.

References Xml\element(), and HTMLFormField\msg().

Referenced by makeHtml().

◆ stackItem()

Licenses::stackItem ( $list,
  $path,
  $item 
)
protected
Parameters
array&$list
array$path
mixed$item

Definition at line 134 of file Licenses.php.

References $path.

Referenced by makeLines().

◆ trimStars()

Licenses::trimStars (   $str)
protected
Parameters
string$str
Returns
array

Definition at line 124 of file Licenses.php.

Referenced by makeLines().

Member Data Documentation

◆ $html

string Licenses::$html
protected

Definition at line 39 of file Licenses.php.

Referenced by getInputHTML(), and makeHtml().

◆ $lines

array Licenses::$lines = []
protected

Definition at line 36 of file Licenses.php.

Referenced by getLines().

◆ $msg

string Licenses::$msg
protected

Definition at line 33 of file Licenses.php.

◆ $selected

string null Licenses::$selected
protected

Definition at line 42 of file Licenses.php.


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