PHP Класс Hal\Link

Наследование: extends AbstractHal
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_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.

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

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 getHref ( ) : string
Результат string

getHreflang() публичный Метод

public getHreflang ( ) : string
Результат string

getName() публичный Метод

public getName ( ) : string
Результат string

getRel() публичный Метод

public getRel ( ) : string
Результат string

getTemplated() публичный Метод

public getTemplated ( ) : boolean
Результат boolean

getTitle() публичный Метод

public getTitle ( ) : string
Результат string

setHref() публичный Метод

public setHref ( string $href ) : Link
$href string
Результат Link

setHreflang() публичный Метод

public setHreflang ( string $hreflang ) : Link
$hreflang string
Результат Link

setName() публичный Метод

public setName ( string $name ) : Link
$name string
Результат Link

setRel() публичный Метод

public setRel ( string $rel ) : Link
$rel string
Результат Link

setTemplated() публичный Метод

public setTemplated ( boolean $templated ) : Link
$templated boolean
Результат Link

setTitle() публичный Метод

public setTitle ( string $title ) : Link
$title string
Результат Link

toArray() публичный Метод

public toArray ( ) : array
Результат array

Описание свойств

$_href защищенное свойство

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
Результат string

$_hreflang защищенное свойство

For indicating what the language of the result of dereferencing the link should be.
protected string $_hreflang
Результат string

$_name защищенное свойство

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
Результат string

$_rel защищенное свойство

The Subject Resource is the closest parent Resource element.
protected string $_rel
Результат string

$_templated защищенное свойство

Whether this link is "templated"
См. ссылку: https://tools.ietf.org/html/rfc6570
protected bool $_templated
Результат boolean

$_title защищенное свойство

For labeling the destination of a link with a human-readable identifier.
protected string $_title
Результат string