Class FOFHalLink

Implementation of the Hypertext Application Language link in PHP.

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/link.php

Methods summary

`public`	# `__construct( string $href, boolean $templated = false, string $name = null, string $hreflang = null, string $title = null )` Public constructor of a FOFHalLink object Public constructor of a FOFHalLink object Parameters `$href` `string` - $href See $this->_href `$templated` `boolean` - $templated See $this->_templated `$name` `string` - $name See $this->_name `$hreflang` `string` - $hreflang See $this->_hreflang `$title` `string` - $title See $this->_title Throws `RuntimeException` - If $href is empty
`public boolean`	# `check( )` Is this a valid link? Checks the existence of required fields, not their values. Is this a valid link? Checks the existence of required fields, not their values. Returns `boolean`
`public mixed`	# `__get( string $name )` Magic getter for the protected properties Magic getter for the protected properties Parameters `$name` `string` - $name The name of the property to retrieve, sans the underscore Returns `mixed` - Null will always be returned if the property doesn't exist
`public`	# `__set( string $name, mixed $value )` Magic setter for the protected properties Magic setter for the protected properties Parameters `$name` `string` - $name The name of the property to set, sans the underscore `$value` `mixed` - $value The value of the property to set

Magic methods summary

Properties summary

`protected string`	`$_href`	# 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. 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.
`protected boolean`	`$_templated`	# This attribute SHOULD be present with a boolean value of true when the href of the link contains a URI Template (RFC6570). This attribute SHOULD be present with a boolean value of true when the href of the link contains a URI Template (RFC6570).
`protected string`	`$_name`	# For distinguishing between Resource and Link elements that share the same relation For distinguishing between Resource and Link elements that share the same relation
`protected string`	`$_hreflang`	# For indicating what the language of the result of dereferencing the link should be. For indicating what the language of the result of dereferencing the link should be.
`protected string`	`$_title`	# For labeling the destination of a link with a human-readable identifier. For labeling the destination of a link with a human-readable identifier.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFHalLink

Methods summary

Parameters

Throws

Returns

Parameters

Returns

Parameters

Magic methods summary

Properties summary