Class yii\web\Link

All Classes | Properties | Methods | Constants
Inheritanceyii\web\Link » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.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.

Public Properties

Hide inherited properties

Property Type Description Defined By
$href string A URI RFC3986 or URI template RFC6570. 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

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
serialize() Serializes a list of links into proper array format. yii\web\Link

Constants

Hide inherited constants

Constant Value Description Defined By
REL_SELF 'self' The self link. yii\web\Link

Property Details

Hide inherited properties

$href public property

A URI RFC3986 or URI template RFC6570. This property is required.

public string $href = null
$hreflang public property

The language of the target resource

public string $hreflang = null
$name public property

A secondary key for selecting Link Objects which share the same relation type

public string $name = null
$profile public property

A URI that hints about the profile of the target resource.

public string $profile = null
$templated public property

A value indicating whether $href refers to a URI or URI template.

public boolean $templated = false
$title public property

A label describing the link

public string $title = null
$type public property

A hint to indicate the media type expected when dereferencing the target resource

public string $type = null

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name
$params array

Method parameters
return mixed

The method return value
throws yii\base\UnknownMethodException

when calling unknown method

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

 

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is write-only

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name
$value mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is read-only

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name
throws yii\base\InvalidCallException

if the property is read only.

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

 

                public static function className()
{
    return get_called_class();
}
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

public boolean hasProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}
serialize() public static method

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.

 

                public static function serialize(array $links)
{
    foreach ($links as $rel => $link) {
        if (is_array($link)) {
            foreach ($link as $i => $l) {
                $link[$i] = $l instanceof self ? array_filter((array) $l) : ['href' => $l];
            }
            $links[$rel] = $link;
        } elseif (!$link instanceof self) {
            $links[$rel] = ['href' => $link];
        }
    }
    return $links;
}