Semantic MediaWiki and related extensions
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
PFRegExpInput Class Reference
Inheritance diagram for PFRegExpInput:
Inheritance graph
[legend]
Collaboration diagram for PFRegExpInput:
Collaboration graph
[legend]

Public Member Functions

 __construct ( $input_number, $cur_value, $input_name, $disabled, array $other_args)
 
 getResourceModuleNames ()
 
 getHtmlText ()
 
 getJsInitFunctionData ()
 
 getJsValidationFunctionData ()
 
- Public Member Functions inherited from PFFormInput
 __construct ( $input_number, $cur_value, $input_name, $disabled, array $other_args)
 
 getDefaultParameters ()
 
 getHtmlText ()
 
 getJsInitFunctionData ()
 
 getJsValidationFunctionData ()
 
 getResourceModuleNames ()
 
 addJsInitFunctionData ( $name, $param=null)
 
 addJsValidationFunctionData ( $name, $param='null')
 
 addJavaScript ()
 

Static Public Member Functions

static newFromInput ( $formInput)
 
static getName ()
 
static getParameters ()
 
static getOtherPropTypesHandled ()
 
- Static Public Member Functions inherited from PFFormInput
static getName ()
 
static getHandledPropertyTypes ()
 
static getParameters ()
 
static canHandleLists ()
 
static getDefaultPropTypes ()
 
static getDefaultPropTypeLists ()
 
static getOtherPropTypesHandled ()
 
static getOtherPropTypeListsHandled ()
 
static getDefaultCargoTypes ()
 
static getDefaultCargoTypeLists ()
 
static getOtherCargoTypesHandled ()
 
static getOtherCargoTypeListsHandled ()
 

Protected Attributes

 $mBaseInput
 
- Protected Attributes inherited from PFFormInput
 $mInputNumber
 
 $mCurrentValue
 
 $mInputName
 
 $mIsMandatory
 
 $mIsDisabled
 
 $mOtherArgs
 
 $mJsInitFunctionData = array()
 
 $mJsValidationFunctionData = array()
 

Detailed Description

This class represents the RegExp input.

Constructor & Destructor Documentation

◆ __construct()

PFRegExpInput::__construct (   $input_number,
  $cur_value,
  $input_name,
  $disabled,
array  $other_args 
)
Parameters
string$input_numberThe number of the input in the form.
string$cur_valueThe current value of the input field.
string$input_nameThe name of the input.
bool$disabledIs this input disabled?
array$other_argsAn associative array of other parameters that were present in the input definition.

Member Function Documentation

◆ getHtmlText()

PFRegExpInput::getHtmlText ( )

Returns the HTML code to be included in the output page for this input.

Ideally this HTML code should provide a basic functionality even if the browser is not JavaScript capable. I.e. even without JavaScript the user should be able to input values.

Returns
string

◆ getJsInitFunctionData()

PFRegExpInput::getJsInitFunctionData ( )

Returns the name and parameters for the initialization JavaScript function for this input type, if any.

Returns
array[]

◆ getJsValidationFunctionData()

PFRegExpInput::getJsValidationFunctionData ( )

Returns the name and parameters for the validation JavaScript functions for this input type, if any.

Returns
array[]

◆ getName()

static PFRegExpInput::getName ( )
static

Returns the name of the input type this class handles.

This is the name to be used in the field definition for the "input type" parameter.

Returns
String The name of the input type this class handles.

◆ getOtherPropTypesHandled()

static PFRegExpInput::getOtherPropTypesHandled ( )
static

Returns the set of SMW property types which this input can handle, but for which it isn't the default input.

Deprecated:
Returns
string[]

◆ getParameters()

static PFRegExpInput::getParameters ( )
static

Returns the set of parameters for this form input.

Returns
array[]

◆ getResourceModuleNames()

PFRegExpInput::getResourceModuleNames ( )

Returns the names of the resource modules this input type uses.

Returns the names of the modules as an array or - if there is only one module - as a string.

Returns
null|string|array

◆ newFromInput()

static PFRegExpInput::newFromInput (   $formInput)
static

Makes this input a wrapper around a previously-defined input.

Parameters
PFFormInput$formInput
Returns
PFRegExpInput

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