# Linkable

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

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [web](/docs/api/yii/web/index.md) › Linkable

| interface | `yii\web\Linkable` |
| --- | --- |
| Since | 2.0 |
| Source | [`framework/web/Linkable.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/web/Linkable.php#L17) |

Implemented by 1 type:

- [`yii\data\Pagination`](/docs/api/yii/data/pagination/index.md)

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

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`getLinks()`](#method-getLinks) abstract | Returns a list of links. | `Linkable` |

## Method details

### getLinks() <span id="method-getLinks"></span>

```php
abstract public function getLinks(): array
```

Returns a list of links.

Each link is either a URI or a [`Link`](/docs/api/yii/web/link/index.md) 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