SFTextAreaInput Class Reference
[Form Inputs]

The SFTextAreaInput class. More...

Inherits SFFormInput.

Inherited by SFTextAreaWithAutocompleteInput.

List of all members.

Public Member Functions
	__construct ($input_number, $cur_value, $input_name, $disabled, $other_args)
	Constructor for the SFTextAreaInput class.
	getResourceModuleNames ()
	Returns the names of the resource modules this input type uses.
	getHtmlText ()
	Returns the HTML code to be included in the output page for this input.
Static Public Member Functions
static	getName ()
	Returns the name of the input type this class handles.
static	getDefaultPropTypes ()
	Returns the set of SMW property types for which this input is meant to be the default one - ideally, no more than one input should declare itself the default for any specific type.
static	getOtherPropTypesHandled ()
	Returns the set of SMW property types which this input can handle, but for which it isn't the default input.
static	getOtherPropTypeListsHandled ()
	Returns the set of SMW property types which this input can handle, but for which it isn't the default input.
static	getParameters ()
	Returns the set of parameters for this form input.
Protected Member Functions
	getTextAreaAttributes ()
Protected Attributes
	$mUseWikieditor = false

---

Detailed Description

The SFTextAreaInput class.

Definition at line 15 of file SF_TextAreaInput.php.

---

Constructor & Destructor Documentation

SFTextAreaInput::__construct	(	$	input_number,
		$	cur_value,
		$	input_name,
		$	disabled,
		$	other_args
	)

Constructor for the SFTextAreaInput class.

Parameters:

	String	$input_number The number of the input in the form. For a simple HTML input element this should end up in the id attribute in the format 'input_<number>'.
	String	$cur_value The current value of the input field. For a simple HTML input element this should end up in the value attribute.
	String	$input_name The name of the input. For a simple HTML input element this should end up in the name attribute.
	Array	$other_args An associative array of other parameters that were present in the input definition.

Reimplemented from SFFormInput.

Definition at line 35 of file SF_TextAreaInput.php.

References SFFormInput::addJsInitFunctionData().

---

Member Function Documentation

static SFTextAreaInput::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. Should be declared abstract. Static functions cannot be abstract. Do we need this method at all? The name should be set outside this class when the input type is registered.

Reimplemented from SFFormInput.

Reimplemented in SFTextAreaWithAutocompleteInput.

Definition at line 56 of file SF_TextAreaInput.php.

static SFTextAreaInput::getDefaultPropTypes

(

)

[static]

Returns the set of SMW property types for which this input is meant to be the default one - ideally, no more than one input should declare itself the default for any specific type.

Deprecated:

Returns:

Array of arrays (key is the property type, value is an array of default args to be used for this input)

Reimplemented from SFFormInput.

Reimplemented in SFTextAreaWithAutocompleteInput.

Definition at line 60 of file SF_TextAreaInput.php.

static SFTextAreaInput::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:

Array of strings

Reimplemented from SFFormInput.

Definition at line 64 of file SF_TextAreaInput.php.

static SFTextAreaInput::getOtherPropTypeListsHandled

(

)

[static]

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

Deprecated:

Returns:

Array of strings

Reimplemented from SFFormInput.

Definition at line 68 of file SF_TextAreaInput.php.

static SFTextAreaInput::getParameters

(

)

[static]

Returns the set of parameters for this form input.

Reimplemented from SFFormInput.

Reimplemented in SFTextAreaWithAutocompleteInput.

Definition at line 72 of file SF_TextAreaInput.php.

SFTextAreaInput::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

Reimplemented from SFFormInput.

Definition at line 116 of file SF_TextAreaInput.php.

SFTextAreaInput::getTextAreaAttributes

(

)

[protected]

Reimplemented in SFTextAreaWithAutocompleteInput.

Definition at line 120 of file SF_TextAreaInput.php.

Referenced by getHtmlText().

SFTextAreaInput::getHtmlText

(

)

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

Reimplemented from SFFormInput.

Definition at line 205 of file SF_TextAreaInput.php.

References getTextAreaAttributes().

---

Member Data Documentation

SFTextAreaInput::$mUseWikieditor = false [protected]

Definition at line 17 of file SF_TextAreaInput.php.

---

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

• SemanticForms/includes/forminputs/SF_TextAreaInput.php