Linkable

API reference › yii › web › Linkable

interface	yii\web\Linkable
Since	2.0
Source	framework/web/Linkable.php

Implemented by 1 type

• yii\data\Pagination

Linkable is the interface that should be implemented by classes that typically represent locatable resources.

Methods

Method	Description	Defined by
getLinks() abstract	Returns a list of links.	Linkable

Method details

getLinks()

abstract public function getLinks(): array

Returns a list of links.

Each link is either a URI or a Link object. The return value of this method should be an array whose keys are the relation names and values the corresponding links.

If a relation name corresponds to multiple links, use an array to represent them.

For example,

[
    'self' => 'https://example.com/users/1',
    'friends' => [
        'https://example.com/users/2',
        'https://example.com/users/3',
    ],
    'manager' => $managerLink, // $managerLink is a Link object
]

Returns

array: The links