Référence de la classe FOFHalLinks

Fonctions membres publiques
	addLink ($rel, FOFHalLink $link, $overwrite=true)
	addLinks ($rel, array $links, $overwrite=true)
	getLinks ($rel=null)

Attributs privés
	$_links = array()

Documentation des fonctions membres

addLink()

addLink	(		$rel,
		FOFHalLink	$link,
			$overwrite = true
	)

Add a single link to the links collection

Paramètres

string	$rel	The relation of the link to the document. See RFC 5988 http://tools.ietf.org/html/rfc5988#section-6.2.2 A document MUST always have a "self" link.
FOFHalLink	$link	The actual link object
boolean	$overwrite	When false and a link of $rel relation exists, an array of links is created. Otherwise the existing link is overwriten with the new one

Renvoie

boolean True if the link was added to the collection

Références $link, $rel, et elseif.

addLinks()

addLinks	(		$rel,
		array	$links,
			$overwrite = true
	)

Add multiple links to the links collection

Paramètres

string	$rel	The relation of the links to the document. See RFC 5988.
array	$links	An array of FOFHalLink objects
boolean	$overwrite	When false and a link of $rel relation exists, an array of links is created. Otherwise the existing link is overwriten with the new one

Renvoie

boolean True if the link was added to the collection

Références $link, et $rel.

getLinks()

getLinks

(

$rel = null

)

Returns the collection of links

Paramètres

string

$rel

Optional; the relation to return the links for

Renvoie

array|FOFHalLink

Références $rel, et elseif.

Documentation des champs

$_links

$_links = array()

private

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/fof/hal/links.php