Référence de l'interface LinkInterface

Graphe d'héritage de LinkInterface:

Fonctions membres publiques
	getHref ()
	isTemplated ()
	getRels ()
	getAttributes ()

Description détaillée

A readable link object.

Documentation des fonctions membres

getAttributes()

getAttributes

(

)

Returns a list of attributes that describe the target URI.

Renvoie

array A key-value list of attributes, where the key is a string and the value is either a PHP primitive or an array of PHP strings. If no values are found an empty array MUST be returned.

Implémenté dans Link.

getHref()

getHref

(

)

Returns the target of the link.

The target link must be one of:

• An absolute URI, as defined by RFC 5988.
• A relative URI, as defined by RFC 5988. The base of the relative link is assumed to be known based on context by the client.
• A URI template as defined by RFC 6570.

If a URI template is returned, isTemplated() MUST return True.

Renvoie

string

Implémenté dans Link.

getRels()

getRels

(

)

Returns the relationship type(s) of the link.

This method returns 0 or more relationship types for a link, expressed as an array of strings.

Renvoie

string[]

Implémenté dans Link.

isTemplated()

isTemplated

(

)

Returns whether or not this is a templated link.

Renvoie

bool True if this link object is templated, False otherwise.

Implémenté dans Link.

---

La documentation de cette interface a été générée à partir du fichier suivant :

• LinkInterface.php