Класс yii\web\Link
| Наследование | yii\web\Link » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/Link.php |
Link представляет собой объект ссылки, как определено в языке API гипермедиа JSON.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $href | строка | URI [RFC3986](https://tools | yii\web\Link |
| $hreflang | строка | Язык целевого ресурса | yii\web\Link |
| $name | строка | Дополнительный ключ для выбора объектов Link, которые используют тот же тип отношения | yii\web\Link |
| $profile | строка | URI, который указывает на профиль целевого ресурса. | yii\web\Link |
| $templated | булево | Значение, указывающее, ссылается ли $href на URI или шаблон URI. | yii\web\Link |
| $title | строка | Подпись, описывающая ссылку | yii\web\Link |
| $type | строка | Подсказка для указания ожидаемого медиа-типа при разборе целевого ресурса | yii\web\Link |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| serialize() | Сериализует список ссылок в правильный формат массива. | yii\web\Link |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| REL_SELF | 'self' | Ссылка на себя. | yii\web\Link |
Подробности свойств
$href общедоступное свойство
URI RFC3986 или шаблон URI RFC6570. Это свойство обязательно.
public string $href = null
$hreflang общедоступное свойство
Язык целевого ресурса
public string $hreflang = null
$name общедоступное свойство
Дополнительный ключ для выбора объектов Link, которые используют тот же тип отношения
public string $name = null
$profile общедоступное свойство
URI, который указывает на профиль целевого ресурса.
public string $profile = null
$templated общедоступное свойство
Значение, указывающее, ссылается ли $href на URI или шаблон URI.
public boolean $templated = false
$title общедоступное свойство
Подпись, описывающая ссылку
public string $title = null
$type общедоступное свойство
Подсказка для указания ожидаемого медиа-типа при разборе целевого ресурса
public string $type = null
Подробности методов
serialize() общедоступный статический метод
Сериализует список ссылок в правильный формат массива.
| public static массив serialize ( массив $links ) | ||
|---|---|---|
| $links | массив |
Ссылки для сериализации |
| return | массив |
Правильное представление ссылок в виде массива. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-link.html