Seboettg\CiteProc\Rendering\Name\Names Class Reference

Inheritance diagram for Seboettg\CiteProc\Rendering\Name\Names:

Public Member Functions
	__construct (SimpleXMLElement $node, $parent)
	getDelimiter ()
	getEtAl ()
	getLabel ()
	getName ()
	getParent ()
	getVariables ()
	hasEtAl ()
	hasLabel ()
	hasName ()
	render ($data, $citationNumber=null)
	setEtAl (EtAl $etAl)
	setLabel ($label)
	setName (Name $name)

Detailed Description

Definition at line 36 of file Names.php.

Constructor & Destructor Documentation

__construct()

Seboettg\CiteProc\Rendering\Name\Names::__construct	(	SimpleXMLElement	$node,
			$parent
	)

Names constructor.

Parameters

SimpleXMLElement	$node
	$parent

Exceptions

InvalidStylesheetException

Definition at line 138 of file Names.php.

References Seboettg\CiteProc\Util\Factory\create().

Member Function Documentation

getDelimiter()

Seboettg\CiteProc\Rendering\Name\Names::getDelimiter

(

)

Returns

string

Definition at line 351 of file Names.php.

getEtAl()

Seboettg\CiteProc\Rendering\Name\Names::getEtAl

(

)

Returns

EtAl

Definition at line 307 of file Names.php.

getLabel()

Seboettg\CiteProc\Rendering\Name\Names::getLabel

(

)

Returns

Label

Definition at line 375 of file Names.php.

getName()

Seboettg\CiteProc\Rendering\Name\Names::getName

(

)

Returns

Name

Definition at line 333 of file Names.php.

getParent()

Seboettg\CiteProc\Rendering\Name\Names::getParent

(

)

Returns

mixed

Implements Seboettg\CiteProc\Rendering\HasParent.

Definition at line 391 of file Names.php.

getVariables()

Seboettg\CiteProc\Rendering\Name\Names::getVariables

(

)

Returns

ArrayList

Definition at line 359 of file Names.php.

hasEtAl()

Seboettg\CiteProc\Rendering\Name\Names::hasEtAl

(

)

Returns

bool

Definition at line 299 of file Names.php.

hasLabel()

Seboettg\CiteProc\Rendering\Name\Names::hasLabel

(

)

Returns

bool

Definition at line 367 of file Names.php.

hasName()

Seboettg\CiteProc\Rendering\Name\Names::hasName

(

)

Returns

bool

Definition at line 325 of file Names.php.

render()

Seboettg\CiteProc\Rendering\Name\Names::render	(		$data,
			$citationNumber = null
	)

This outputs the contents of one or more name variables (selected with the required variable attribute), each of which can contain multiple names (e.g. the “author” variable contains all the author names of the cited item). If multiple variables are selected (separated by single spaces), each variable is independently rendered in the order specified, with one exception: when the selection consists of “editor” and “translator”, and when the contents of these two name variables is identical, then the contents of only one name variable is rendered. In addition, the “editortranslator” term is used if the Names element contains a Label element, replacing the default “editor” and “translator” terms (e.g. resulting in “Doe (editor & translator)”).

Parameters

stdClass	$data
int | null	$citationNumber

Returns

string

Exceptions

CiteProcException

Implements Seboettg\CiteProc\Rendering\Rendering.

Definition at line 190 of file Names.php.

References Seboettg\CiteProc\Util\NameHelper\addExtendedMarkup(), Seboettg\CiteProc\CiteProc\getContext(), Seboettg\CiteProc\Util\NameHelper\sameNames(), and Seboettg\CiteProc\RenderingState\SUBSTITUTION.

setEtAl()

Seboettg\CiteProc\Rendering\Name\Names::setEtAl

(

EtAl

$etAl

)

Parameters

EtAl

$etAl

Returns

$this

Definition at line 316 of file Names.php.

setLabel()

Seboettg\CiteProc\Rendering\Name\Names::setLabel

(

$label

)

Parameters

Label

$label

Definition at line 383 of file Names.php.

setName()

Seboettg\CiteProc\Rendering\Name\Names::setName

(

Name

$name

)

Parameters

Name

$name

Returns

$this

Definition at line 342 of file Names.php.

---

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

• Names.php