Docs For Class FOFHalLink

Description

Implementation of the Hypertext Application Language link in PHP.

since: 2.1

Located in /libraries/fof/hal/link.php (line 16)

Variable Summary

string $_href

string $_hreflang

string $_name

boolean $_templated

string $_title

Method Summary

FOFHalLink __construct (string $href, [boolean $templated = false], [string $name = null], [string $hreflang = null], [string $title = null])

boolean check ()

mixed __get (string $name)

void __set (string $name, mixed $value)

Variables

string $_href = '' (line 26)

For indicating the target URI. Corresponds with the ’Target IRI’ as defined in Web Linking (RFC 5988). This attribute MAY contain a URI Template (RFC6570) and in which case, SHOULD be complemented by an additional templated attribtue on the link with a boolean value true.

access: protected

string $_hreflang = null (line 49)

For indicating what the language of the result of dereferencing the link should be.

access: protected

string $_name = null (line 42)

For distinguishing between Resource and Link elements that share the same relation

access: protected

boolean $_templated = false (line 34)

This attribute SHOULD be present with a boolean value of true when the href of the link contains a URI Template (RFC6570).

access: protected

string $_title = null (line 56)

For labeling the destination of a link with a human-readable identifier.

access: protected

Methods

Constructor __construct (line 69)

Public constructor of a FOFHalLink object

throws: RuntimeException If $href is empty
access: public

FOFHalLink __construct (string $href, [boolean $templated = false], [string $name = null], [string $hreflang = null], [string $title = null])

string $href: See $this->_href
boolean $templated: See $this->_templated
string $name: See $this->_name
string $hreflang: See $this->_hreflang
string $title: See $this->_title

check (line 89)

Is this a valid link? Checks the existence of required fields, not their values.

access: public

boolean check ()

__get (line 101)

Magic getter for the protected properties

return: Null will always be returned if the property doesn't exist
access: public

mixed __get (string $name)

string $name: The name of the property to retrieve, sans the underscore

__set (line 123)

Magic setter for the protected properties

access: public

void __set (string $name, mixed $value)

string $name: The name of the property to set, sans the underscore
mixed $value: The value of the property to set