SMWParamFormat Class Reference

List of all members.

Public Member Functions
	__construct ()
	Constructor.
	doManipulation (&$value, Parameter $parameter, array &$parameters)
	setPrintRequests (array $printRequests)
	Sets the print requests of the query, used for determining the default format if none is provided.
Static Public Member Functions
static	resolveFormatAliases (&$format)
	Turns format aliases into main formats.
Protected Member Functions
	getValidFormatName ($value)
	Takes a format name, which can be an alias and returns a format name which will be valid for sure.
	getDefaultFormat ()
	Determines and returns the default format, based on the queries print requests, if provided.
Protected Attributes
	$printRequests = null

---

Detailed Description

Definition at line 15 of file SMW_ParamFormat.php.

---

Constructor & Destructor Documentation

SMWParamFormat::__construct

(

)

Constructor.

Since:

1.6.2

Definition at line 33 of file SMW_ParamFormat.php.

---

Member Function Documentation

SMWParamFormat::doManipulation	(	&$	value,
		Parameter $	parameter,
		array &$	parameters
	)

See also:

ItemParameterManipulation::doManipulation

Since:

1.6.2

Definition at line 42 of file SMW_ParamFormat.php.

References SMWQueryProcessor::getResultPrinter().

SMWParamFormat::getValidFormatName

(

$

value

)

[protected]

Takes a format name, which can be an alias and returns a format name which will be valid for sure.

Aliases are resvolved. If the given format name is invalid, the predefined default format will be returned.

Since:

1.6.2

Parameters:

string

$value

Returns:

string

Definition at line 63 of file SMW_ParamFormat.php.

References $smwgResultFormats, and getDefaultFormat().

static SMWParamFormat::resolveFormatAliases

(

&$

format

)

[static]

Turns format aliases into main formats.

Since:

1.6.2

Parameters:

string

$format

Returns:

boolean Indicates if the passed format was an alias, and thus was changed.

Definition at line 88 of file SMW_ParamFormat.php.

References $smwgResultAliases.

Referenced by SMWQueryProcessor::getResultFormat().

SMWParamFormat::getDefaultFormat

(

)

[protected]

Determines and returns the default format, based on the queries print requests, if provided.

Since:

1.6.2

Returns:

string Array key in $smwgResultFormats

This hook allows extensions to override SMWs implementation of default result format handling.

Since:

1.5.2

Definition at line 112 of file SMW_ParamFormat.php.

Referenced by getValidFormatName().

SMWParamFormat::setPrintRequests

(

array $

printRequests

)

Sets the print requests of the query, used for determining the default format if none is provided.

Since:

1.6.2

Parameters:

$printRequests

array of SMWPrintRequest

Definition at line 144 of file SMW_ParamFormat.php.

---

Member Data Documentation

SMWParamFormat::$printRequests = null [protected]

Definition at line 26 of file SMW_ParamFormat.php.

---

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

• SemanticMediaWiki/includes/params/SMW_ParamFormat.php