PlainTextReferencesList Class Reference

Public Member Functions
	__construct ($listContent, $ordering)
&	getListContent ()
	getOrdering ()
	setListContent (&$listContent)
	setOrdering ($ordering)

Data Fields
	$_listContent
	$_ordering

Detailed Description

Class representing an ordered list of plain text citation output.

Definition at line 20 of file PlainTextReferencesList.inc.php.

Constructor & Destructor Documentation

__construct()

PlainTextReferencesList::__construct	(		$listContent,
			$ordering
	)

Constructor.

Parameters

$listContent	string
$ordering	integer one of the REFERENCES_LIST_ORDERING_* constants

Definition at line 38 of file PlainTextReferencesList.inc.php.

Member Function Documentation

getListContent()

& PlainTextReferencesList::getListContent

(

)

Get the list content

Returns

string

Definition at line 59 of file PlainTextReferencesList.inc.php.

References $_listContent.

getOrdering()

PlainTextReferencesList::getOrdering

(

)

Get the ordering

Returns

integer

Definition at line 75 of file PlainTextReferencesList.inc.php.

References $_ordering.

setListContent()

PlainTextReferencesList::setListContent

(

&

$listContent

)

Set the list content

Parameters

$listContent

string

Definition at line 51 of file PlainTextReferencesList.inc.php.

setOrdering()

PlainTextReferencesList::setOrdering

(

$ordering

)

Set the ordering

Parameters

$ordering

integer

Definition at line 67 of file PlainTextReferencesList.inc.php.

Field Documentation

$_listContent

string PlainTextReferencesList::$_listContent

the actual list

Definition at line 31 of file PlainTextReferencesList.inc.php.

Referenced by getListContent().

$_ordering

integer PlainTextReferencesList::$_ordering

one of the REFERENCES_LIST_ORDERING_* constants

Definition at line 25 of file PlainTextReferencesList.inc.php.

Referenced by getOrdering().

---

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

• PlainTextReferencesList.inc.php