Seboettg\CiteProc\CiteProc Class Reference

Public Member Functions
	__construct ($styleSheet, $lang="en-US", $markupExtension=[])
	__destruct ()
	init ($citationAsArray=false)
	render ($data, $mode="bibliography", $citationItems=[], $citationAsArray=false)
	renderCssStyles ()

Static Public Member Functions
static	getContext ()
static	setContext ($context)

Protected Member Functions
	bibliography ($data)
	citation ($data, $citationItems)

Detailed Description

Definition at line 32 of file CiteProc.php.

Constructor & Destructor Documentation

__construct()

Seboettg\CiteProc\CiteProc::__construct	(		$styleSheet,
			$lang = "en-US",
			$markupExtension = []
	)

CiteProc constructor.

Parameters

string	$styleSheet	xml formatted csl stylesheet
string	$lang
array	$markupExtension

Definition at line 89 of file CiteProc.php.

__destruct()

Seboettg\CiteProc\CiteProc::__destruct

(

)

Definition at line 96 of file CiteProc.php.

Member Function Documentation

bibliography()

Seboettg\CiteProc\CiteProc::bibliography (   $data )

protected

Parameters

DataList

$data

Returns

string

Definition at line 143 of file CiteProc.php.

Referenced by Seboettg\CiteProc\CiteProc\render().

citation()

Seboettg\CiteProc\CiteProc::citation (   $data,   $citationItems  )

protected

Parameters

DataList	$data
ArrayList	$citationItems

Returns

string

Definition at line 154 of file CiteProc.php.

Referenced by Seboettg\CiteProc\CiteProc\render().

getContext()

static Seboettg\CiteProc\CiteProc::getContext ( )

static

Returns

Context

Definition at line 45 of file CiteProc.php.

Referenced by Seboettg\CiteProc\Style\Bibliography\__construct(), Seboettg\CiteProc\Style\Citation\__construct(), Seboettg\CiteProc\Style\StyleElement\__construct(), Seboettg\CiteProc\Styles\addAffixes(), Seboettg\CiteProc\Styles\addSurroundingQuotes(), Seboettg\CiteProc\Util\CiteProcHelper\applyAdditionMarkupFunction(), Seboettg\CiteProc\Util\StringHelper\initializeBySpaceOrHyphen(), Seboettg\CiteProc\Style\initInheritableNameAttributes(), Seboettg\CiteProc\Style\Sort\Key\isMacro(), Seboettg\CiteProc\Rendering\Date\DatePart\monthFromLocale(), Seboettg\CiteProc\Style\Bibliography\render(), Seboettg\CiteProc\Rendering\Name\EtAl\render(), Seboettg\CiteProc\Rendering\Layout\render(), Seboettg\CiteProc\Rendering\Label\render(), Seboettg\CiteProc\Rendering\Text\render(), Seboettg\CiteProc\Rendering\Name\Substitute\render(), Seboettg\CiteProc\CiteProc\render(), Seboettg\CiteProc\Rendering\Name\Names\render(), Seboettg\CiteProc\CiteProc\renderCssStyles(), Seboettg\CiteProc\Rendering\Date\DatePart\renderDay(), Seboettg\CiteProc\Rendering\Date\DatePart\renderYear(), and Seboettg\CiteProc\CiteProcTest\testGetInfo().

init()

Seboettg\CiteProc\CiteProc::init

(

$citationAsArray = false

)

initializes CiteProc and start parsing XML stylesheet

Parameters

bool

$citationAsArray

Exceptions

CiteProcException

Definition at line 215 of file CiteProc.php.

Referenced by Seboettg\CiteProc\CiteProc\render(), and Seboettg\CiteProc\CiteProc\renderCssStyles().

render()

Seboettg\CiteProc\CiteProc::render	(		$data,
			$mode = "bibliography",
			$citationItems = [],
			$citationAsArray = false
	)

Parameters

array | DataList	$data
string	$mode	(citation|bibliography)
array	$citationItems
bool	$citationAsArray

Returns

string

Exceptions

CiteProcException

Definition at line 167 of file CiteProc.php.

References Seboettg\CiteProc\CiteProc\bibliography(), Seboettg\CiteProc\CiteProc\citation(), Seboettg\CiteProc\Util\CiteProcHelper\cloneArray(), Seboettg\CiteProc\CiteProc\getContext(), Seboettg\CiteProc\CiteProc\init(), and Seboettg\CiteProc\CiteProc\setContext().

Referenced by Seboettg\CiteProc\Rendering\Name\NameTest\testEnrichMarkupNamesCitationsAndBibliography().

renderCssStyles()

Seboettg\CiteProc\CiteProc::renderCssStyles

(

)

Returns

string

Exceptions

CiteProcException

Definition at line 230 of file CiteProc.php.

References Seboettg\CiteProc\CiteProc\getContext(), and Seboettg\CiteProc\CiteProc\init().

setContext()

static Seboettg\CiteProc\CiteProc::setContext (   $context )

static

Parameters

Context

$context

Definition at line 53 of file CiteProc.php.

Referenced by Seboettg\CiteProc\CiteProc\render(), Seboettg\CiteProc\Rendering\NumberTest\setUp(), Seboettg\CiteProc\Rendering\GroupTest\setUp(), and Seboettg\CiteProc\Node\Choose\Choose\ChooseTest\testIsNumeric().

---

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

• CiteProc.php