Class luya\cms\LinkConverter

Inheritanceluya\cms\LinkConverter » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version1.0.5

Convert a given config into a {{luya\web\LinkInterface}} Object.

From a array with config:

$converter = LinkConverter::fromArray($config);
return $converter->getLink();

or from object context

$converter = new LinkConverter();

// set value and type from current object context.
$converter->value = $this->value;
$converter->type = $this->type;

return $converter->getLink();

In very rare case you may want to provide some extra informations to the the different link types, like for intern pages a language container, then you can also use the converter like this.

$converter = new LinkConverter([
    'type' => $this->redirectMapData('type'),
    'value' => $this->redirectMapData('value'),
]);

switch ($converter->type) {
    case $converter::TYPE_EXTERNAL_URL:
        return $converter->getWebsiteLink($converter->value, $converter->target)->getHref();
        break;
    case $converter::TYPE_INTERNAL_PAGE:
        return $converter->getPageLink($converter->value, $converter->target, $this->lang)->getHref();
        break;
    case $converter::TYPE_LINK_TO_EMAIL:
        return $converter->getEmailLink($converter->value)->getHref();
        break;
    case $converter::TYPE_LINK_TO_FILE:
        return $converter->getFileLink($converter->value, $converter->target)->getHref();
        break;
}

But keep in mind, with this solution you have to adjust new TYPES by yourself.

Public Properties

Hide inherited properties

Property Type Description Defined By
$target string Whether its _blank or _self. luya\cms\LinkConverter
$type integer A numeric representation of the type of link. luya\cms\LinkConverter
$value mixed The value which will be associated to the type. luya\cms\LinkConverter

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
fromArray() Generate a link converter object from an array. luya\cms\LinkConverter
getEmailLink() Get an Email Link Object. luya\cms\LinkConverter
getFileLink() Get a File Link Object. luya\cms\LinkConverter
getLink() Get the {{luya\web\LinkInterface}} from the given configuration trough type. luya\cms\LinkConverter
getPageLink() Get CMS Page Link Object. luya\cms\LinkConverter
getTelephoneLink() Get a Telefphone Link Object. luya\cms\LinkConverter
getWebsiteLink() Get a Website Link Object. luya\cms\LinkConverter
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

Constants

Hide inherited constants

Constant Value Description Defined By
TYPE_EXTERNAL_URL 2 luya\cms\LinkConverter
TYPE_INTERNAL_PAGE 1 luya\cms\LinkConverter

Property Details

Hide inherited properties

$target public property

Whether its _blank or _self.

public string $target null
$type public property

A numeric representation of the type of link.

public integer $type null
$value public property

The value which will be associated to the type.

public mixed $value 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();
}

            
fromArray() public static method

Generate a link converter object from an array.

If type is empty, false is returned. This allows us to have predefined values from value and target and do not throw an exception.

public static luya\cms\LinkConverter|false fromArray ( array $configuration )
$configuration array

                public static function fromArray(array $configuration)
{
    $type = ArrayHelper::getValue($configuration, 'type');
    $value = ArrayHelper::getValue($configuration, 'value');
    $target = ArrayHelper::getValue($configuration, 'target');
    if (empty($type)) {
        return false;
    }
    return (new self(['type' => $type, 'value' => $value, 'target' => $target]));
}

            
getEmailLink() public method

Get an Email Link Object.

public luya\web\EmailLink getEmailLink ( $email )
$email string

getFileLink() public method

Get a File Link Object.

public luya\admin\file\Item|boolean getFileLink ( $fileId, $target )
$fileId integer
$target string

getLink() public method

Get the {{luya\web\LinkInterface}} from the given configuration trough type.

public luya\web\LinkInterface|boolean getLink ( )

getPageLink() public method

Get CMS Page Link Object.

public luya\cms\menu\Item|boolean getPageLink ( $navId, $target, $lang null )
$navId integer
$target string
$lang string

getTelephoneLink() public method

Get a Telefphone Link Object.

public luya\web\TelephoneLink getTelephoneLink ( $telephone )
$telephone string

getWebsiteLink() public method

Get a Website Link Object.

public luya\web\WebsiteLink getWebsiteLink ( $href, $target )
$href string
$target string

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()
{
}