| Inheritance | yii\web\Link » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/web/Link.php |
Link represents a link object as defined in JSON Hypermedia API Language.
| Property | Type | Description | Defined By |
|---|---|---|---|
| $href | string | A URI [RFC3986](https://tools. | yii\web\Link |
| $hreflang | string | The language of the target resource | yii\web\Link |
| $name | string | A secondary key for selecting Link Objects which share the same relation type | yii\web\Link |
| $profile | string | A URI that hints about the profile of the target resource. | yii\web\Link |
| $templated | boolean | A value indicating whether $href refers to a URI or URI template. | yii\web\Link |
| $title | string | A label describing the link | yii\web\Link |
| $type | string | A hint to indicate the media type expected when dereferencing the target resource | yii\web\Link |
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Object |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | Initializes the object. | yii\base\Object |
| serialize() | Serializes a list of links into proper array format. | yii\web\Link |
| Constant | Value | Description | Defined By |
|---|---|---|---|
| REL_SELF | 'self' | The self link. | yii\web\Link |
public string $href = null
The language of the target resource
public string $hreflang = null
A secondary key for selecting Link Objects which share the same relation type
public string $name = null
A URI that hints about the profile of the target resource.
public string $profile = null
A value indicating whether $href refers to a URI or URI template.
public boolean $templated = false
A label describing the link
public string $title = null
A hint to indicate the media type expected when dereferencing the target resource
public string $type = null
Serializes a list of links into proper array format.
| public static array serialize ( array $links ) | ||
|---|---|---|
| $links | array |
The links to be serialized |
| return | array |
The proper array representation of the links. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-link.html