Seboettg\CiteProc\Context Class Reference

Public Member Functions
	__construct ($locale=null)
	addMacro ($key, $macro)
	getBibliography ()
	getBibliographySpecificOptions ()
	getCitation ()
	getCitationItems ()
	getCitationSpecificOptions ()
	getCssStyle ()
	getGlobalOptions ()
	getInfo ()
	getLocale ()
	getMacro ($key)
	getMacros ()
	getMarkupExtension ()
	getMode ()
	getRenderingState ()
	getResults ()
	getRoot ()
	getSorting ()
	hasCitationItems ()
	isCitationsAsArray ()
	isModeBibliography ()
	isModeCitation ()
	setBibliography (Bibliography $bibliography)
	setBibliographySpecificOptions (BibliographyOptions $bibliographySpecificOptions)
	setCitation ($citation)
	setCitationItems (&$citationItems)
	setCitationsAsArray ($citationsAsArray=true)
	setCitationSpecificOptions (CitationOptions $citationSpecificOptions)
	setCssStyle (CssStyle $cssStyle)
	setGlobalOptions (GlobalOptions $globalOptions)
	setInfo (Info $info)
	setLocale (Locale $locale)
	setMarkupExtension ($markupExtension)
	setMode ($mode)
	setRenderingState (RenderingState $renderingState)
	setRoot (Root $root)
	setSorting ($sorting)

Protected Attributes
	$markupExtension = []

Detailed Description

Definition at line 32 of file Context.php.

Constructor & Destructor Documentation

__construct()

Seboettg\CiteProc\Context::__construct

(

$locale = null

)

Definition at line 170 of file Context.php.

References Seboettg\CiteProc\RenderingState\RENDERING.

Member Function Documentation

addMacro()

Seboettg\CiteProc\Context::addMacro	(		$key,
			$macro
	)

Definition at line 182 of file Context.php.

getBibliography()

Seboettg\CiteProc\Context::getBibliography

(

)

Returns

Bibliography

Definition at line 215 of file Context.php.

getBibliographySpecificOptions()

Seboettg\CiteProc\Context::getBibliographySpecificOptions

(

)

Returns

BibliographyOptions

Definition at line 390 of file Context.php.

getCitation()

Seboettg\CiteProc\Context::getCitation

(

)

Returns

Citation

Definition at line 231 of file Context.php.

getCitationItems()

Seboettg\CiteProc\Context::getCitationItems

(

)

Returns

DataList

Definition at line 305 of file Context.php.

getCitationSpecificOptions()

Seboettg\CiteProc\Context::getCitationSpecificOptions

(

)

Returns

CitationOptions

Definition at line 406 of file Context.php.

getCssStyle()

Seboettg\CiteProc\Context::getCssStyle

(

)

Returns

CssStyle

Definition at line 430 of file Context.php.

getGlobalOptions()

Seboettg\CiteProc\Context::getGlobalOptions

(

)

Returns

GlobalOptions

Definition at line 358 of file Context.php.

getInfo()

Seboettg\CiteProc\Context::getInfo

(

)

Definition at line 440 of file Context.php.

getLocale()

Seboettg\CiteProc\Context::getLocale

(

)

Returns

Locale

Definition at line 207 of file Context.php.

getMacro()

Seboettg\CiteProc\Context::getMacro

(

$key

)

Parameters

$key

Returns

Macro

Definition at line 191 of file Context.php.

getMacros()

Seboettg\CiteProc\Context::getMacros

(

)

Returns

ArrayList

Definition at line 326 of file Context.php.

getMarkupExtension()

Seboettg\CiteProc\Context::getMarkupExtension

(

)

Returns

array

Definition at line 448 of file Context.php.

References Seboettg\CiteProc\Context\$markupExtension.

getMode()

Seboettg\CiteProc\Context::getMode

(

)

return the render mode (citation|bibliography)

Returns

string

Definition at line 271 of file Context.php.

getRenderingState()

Seboettg\CiteProc\Context::getRenderingState

(

)

Returns

RenderingState

Definition at line 374 of file Context.php.

getResults()

Seboettg\CiteProc\Context::getResults

(

)

Returns

ArrayList

Definition at line 334 of file Context.php.

getRoot()

Seboettg\CiteProc\Context::getRoot

(

)

Returns

Root

Definition at line 342 of file Context.php.

getSorting()

Seboettg\CiteProc\Context::getSorting

(

)

Definition at line 262 of file Context.php.

hasCitationItems()

Seboettg\CiteProc\Context::hasCitationItems

(

)

Definition at line 318 of file Context.php.

isCitationsAsArray()

Seboettg\CiteProc\Context::isCitationsAsArray

(

)

Definition at line 252 of file Context.php.

isModeBibliography()

Seboettg\CiteProc\Context::isModeBibliography

(

)

returns true if the render mode is set to bibliography

Returns

bool

Definition at line 297 of file Context.php.

isModeCitation()

Seboettg\CiteProc\Context::isModeCitation

(

)

returns true if the render mode is set to citation

Returns

bool

Definition at line 288 of file Context.php.

setBibliography()

Seboettg\CiteProc\Context::setBibliography

(

Bibliography

$bibliography

)

Parameters

Bibliography

$bibliography

Definition at line 223 of file Context.php.

setBibliographySpecificOptions()

Seboettg\CiteProc\Context::setBibliographySpecificOptions

(

BibliographyOptions

$bibliographySpecificOptions

)

Parameters

BibliographyOptions

$bibliographySpecificOptions

Definition at line 398 of file Context.php.

setCitation()

Seboettg\CiteProc\Context::setCitation

(

$citation

)

Parameters

Citation

$citation

Definition at line 239 of file Context.php.

setCitationItems()

Seboettg\CiteProc\Context::setCitationItems

(

&

$citationItems

)

Parameters

DataList

$citationItems

Definition at line 313 of file Context.php.

setCitationsAsArray()

Seboettg\CiteProc\Context::setCitationsAsArray

(

$citationsAsArray = true

)

Parameters

$citationsAsArray

Definition at line 247 of file Context.php.

setCitationSpecificOptions()

Seboettg\CiteProc\Context::setCitationSpecificOptions

(

CitationOptions

$citationSpecificOptions

)

Parameters

CitationOptions

$citationSpecificOptions

Definition at line 414 of file Context.php.

setCssStyle()

Seboettg\CiteProc\Context::setCssStyle

(

CssStyle

$cssStyle

)

Parameters

CssStyle

$cssStyle

Definition at line 422 of file Context.php.

setGlobalOptions()

Seboettg\CiteProc\Context::setGlobalOptions

(

GlobalOptions

$globalOptions

)

Parameters

GlobalOptions

$globalOptions

Definition at line 366 of file Context.php.

setInfo()

Seboettg\CiteProc\Context::setInfo

(

Info

$info

)

Definition at line 435 of file Context.php.

setLocale()

Seboettg\CiteProc\Context::setLocale

(

Locale

$locale

)

Parameters

Locale

$locale

Definition at line 199 of file Context.php.

setMarkupExtension()

Seboettg\CiteProc\Context::setMarkupExtension

(

$markupExtension

)

Parameters

array

$markupExtension

Definition at line 456 of file Context.php.

References Seboettg\CiteProc\Context\$markupExtension.

setMode()

Seboettg\CiteProc\Context::setMode

(

$mode

)

Parameters

string

$mode

Definition at line 279 of file Context.php.

setRenderingState()

Seboettg\CiteProc\Context::setRenderingState

(

RenderingState

$renderingState

)

Parameters

RenderingState | string

$renderingState

Definition at line 382 of file Context.php.

setRoot()

Seboettg\CiteProc\Context::setRoot

(

Root

$root

)

Parameters

Root

$root

Definition at line 350 of file Context.php.

setSorting()

Seboettg\CiteProc\Context::setSorting

(

$sorting

)

Definition at line 257 of file Context.php.

Field Documentation

$markupExtension

array Context::$markupExtension = []

protected

Definition at line 160 of file Context.php.

Referenced by Seboettg\CiteProc\Context\getMarkupExtension(), and Seboettg\CiteProc\Context\setMarkupExtension().

---

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

• Context.php