Référence de la classe GenericLinkProvider

Graphe d'héritage de GenericLinkProvider:

Fonctions membres publiques
	__construct (array $links=[])
	getLinks ()
	getLinksByRel ($rel)
	withLink (LinkInterface $link)
	withoutLink (LinkInterface $link)

Attributs privés
	$links = []

Documentation des constructeurs et destructeur

__construct()

__construct

(

array

$links = []

)

Paramètres

LinkInterface[]

$links

Références $link, GenericLinkProvider\$links, et $this.

Documentation des fonctions membres

getLinks()

getLinks

(

)

{Returns an iterable of LinkInterface objects.The iterable may be an array or any PHP object. If no links are available, an empty array or MUST be returned.

Renvoie

LinkInterface[]|

}

Implémente LinkProviderInterface.

getLinksByRel()

getLinksByRel

(

$rel

)

{Returns an iterable of LinkInterface objects that have a specific relationship.The iterable may be an array or any PHP object. If no links with that relationship are available, an empty array or MUST be returned.

Renvoie

LinkInterface[]|

}

Implémente LinkProviderInterface.

Références $link, GenericLinkProvider\$links, et $rel.

withLink()

withLink

(

LinkInterface

$link

)

{Returns an instance with the specified link included.If the specified link is already present, this method MUST return normally without errors. The link is present if $link is === identical to a link object already in the collection.

Paramètres

LinkInterface

$link

A link object that should be included in this collection.

Renvoie

static

}

Renvoie

static

Implémente EvolvableLinkProviderInterface.

Références $link, et $this.

withoutLink()

withoutLink

(

LinkInterface

$link

)

{Returns an instance with the specifed link removed.If the specified link is not present, this method MUST return normally without errors. The link is present if $link is === identical to a link object already in the collection.

Paramètres

LinkInterface

$link

The link to remove.

Renvoie

static

}

Renvoie

static

Implémente EvolvableLinkProviderInterface.

Références $link, et $this.

Documentation des champs

$links

$links = []

private

Référencé par GenericLinkProvider\__construct(), et GenericLinkProvider\getLinksByRel().

---

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

• symfony/web-link/GenericLinkProvider.php