Class FOFHalLinks

Implementation of the Hypertext Application Language links in PHP. This is actually a collection of links.

Package: FrameworkOnFramework\hal
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.1
Located at fof/hal/links.php

Methods summary

`public boolean`	# `addLink( string $rel, FOFHalLink $link, boolean $overwrite = true )` Add a single link to the links collection Add a single link to the links collection Parameters `$rel` `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. `$link` `FOFHalLink` - $link The actual link object `$overwrite` `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 Returns `boolean` - True if the link was added to the collection
`public boolean`	# `addLinks( string $rel, array $links, boolean $overwrite = true )` Add multiple links to the links collection Add multiple links to the links collection Parameters `$rel` `string` - $rel The relation of the links to the document. See RFC 5988. `$links` `array` - $links An array of FOFHalLink objects `$overwrite` `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 Returns `boolean` - True if the link was added to the collection
`public array\|FOFHalLink`	# `getLinks( string $rel = null )` Returns the collection of links Returns the collection of links Parameters `$rel` `string` - $rel Optional; the relation to return the links for Returns `array\|FOFHalLink`

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFHalLinks

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary