PHP Class Hal\Link

Inheritance: extends AbstractHal
Afficher le fichier Open project: zircote/hal Class Usage Examples

Protected Properties

Свойство Type Description
$_href string Applications which use HAL MAY clarify the integrity of specific embedded content via the description of the relevant @rel value. - As a link: This attribute MAY contain a URI template. Whether or not this is the case SHOULD be indicated to clients by the @rel value.
$_hreflang string For indicating what the language of the result of dereferencing the link should be.
$_name string For distinguishing between Resource and Link elements that share the same @rel value. The @name attribute SHOULD NOT be used exclusively for identifying elements within a HAL representation, it is intended only as a 'secondary key' to a given @rel value.
$_rel string The Subject Resource is the closest parent Resource element.
$_templated boolean Whether this link is "templated"
$_title string For labeling the destination of a link with a human-readable identifier.

Méthodes publiques

Méthode Description
__construct ( string $href, string $rel = 'self', string $title = null, string $name = null, string $hreflang = null, boolean $templated = false )
getHref ( ) : string
getHreflang ( ) : string
getName ( ) : string
getRel ( ) : string
getTemplated ( ) : boolean
getTitle ( ) : string
setHref ( string $href ) : Link
setHreflang ( string $hreflang ) : Link
setName ( string $name ) : Link
setRel ( string $rel ) : Link
setTemplated ( boolean $templated ) : Link
setTitle ( string $title ) : Link
toArray ( ) : array

Method Details

__construct() public méthode

public __construct ( string $href, string $rel = 'self', string $title = null, string $name = null, string $hreflang = null, boolean $templated = false )
$href string
$rel string
$title string
$name string
$hreflang string
$templated boolean

getHref() public méthode

public getHref ( ) : string
Résultat string

getHreflang() public méthode

public getHreflang ( ) : string
Résultat string

getName() public méthode

public getName ( ) : string
Résultat string

getRel() public méthode

public getRel ( ) : string
Résultat string

getTemplated() public méthode

public getTemplated ( ) : boolean
Résultat boolean

getTitle() public méthode

public getTitle ( ) : string
Résultat string

setHref() public méthode

public setHref ( string $href ) : Link
$href string
Résultat Link

setHreflang() public méthode

public setHreflang ( string $hreflang ) : Link
$hreflang string
Résultat Link

setName() public méthode

public setName ( string $name ) : Link
$name string
Résultat Link

setRel() public méthode

public setRel ( string $rel ) : Link
$rel string
Résultat Link

setTemplated() public méthode

public setTemplated ( boolean $templated ) : Link
$templated boolean
Résultat Link

setTitle() public méthode

public setTitle ( string $title ) : Link
$title string
Résultat Link

toArray() public méthode

public toArray ( ) : array
Résultat array

Property Details

$_href protected_oe property

Applications which use HAL MAY clarify the integrity of specific embedded content via the description of the relevant @rel value. - As a link: This attribute MAY contain a URI template. Whether or not this is the case SHOULD be indicated to clients by the @rel value.
protected string $_href
Résultat string

$_hreflang protected_oe property

For indicating what the language of the result of dereferencing the link should be.
protected string $_hreflang
Résultat string

$_name protected_oe property

For distinguishing between Resource and Link elements that share the same @rel value. The @name attribute SHOULD NOT be used exclusively for identifying elements within a HAL representation, it is intended only as a 'secondary key' to a given @rel value.
protected string $_name
Résultat string

$_rel protected_oe property

The Subject Resource is the closest parent Resource element.
protected string $_rel
Résultat string

$_templated protected_oe property

Whether this link is "templated"
See link: https://tools.ietf.org/html/rfc6570
protected bool $_templated
Résultat boolean

$_title protected_oe property

For labeling the destination of a link with a human-readable identifier.
protected string $_title
Résultat string