Class luya\admin\ngrest\base\NgRestRelation

Inheritanceluya\admin\ngrest\base\NgRestRelation » yii\base\BaseObject
Implementsluya\admin\ngrest\base\NgRestRelationInterface, yii\base\Configurable
Available since version1.0.0

NgRest Relation definition.

An NgRest Relation defined which is used by {{luya\admin\ngrest\base\NgRestModel::ngRestRelations()}} array.

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
getApiEndpoint() Get the api endpoint for the relation in order to make the relation data call. luya\admin\ngrest\base\NgRestRelation
getArrayIndex() Get the array index of the relation in the relations array. luya\admin\ngrest\base\NgRestRelation
getDataProvider() luya\admin\ngrest\base\NgRestRelation
getLabel() Get the label of the relation. luya\admin\ngrest\base\NgRestRelation
getModelClass() Get the encoded model class name. luya\admin\ngrest\base\NgRestRelation
getRelationLink() Get relation link informations. luya\admin\ngrest\base\NgRestRelation
getTabLabelAttribute() Returns the tab label attribute name. luya\admin\ngrest\base\NgRestRelation
getTargetModel() Get the target model class path. luya\admin\ngrest\base\NgRestRelation
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
setApiEndpoint() luya\admin\ngrest\base\NgRestRelation
setArrayIndex() Set the index of the relation in the relations array. luya\admin\ngrest\base\NgRestRelation
setDataProvider() luya\admin\ngrest\base\NgRestRelation
setLabel() luya\admin\ngrest\base\NgRestRelation
setModelClass() Set the model class of the current ngRestModel. luya\admin\ngrest\base\NgRestRelation
setRelationLink() luya\admin\ngrest\base\NgRestRelation
setTabLabelAttribute() Tab label attribute Setter. luya\admin\ngrest\base\NgRestRelation
setTargetModel() Set the target model class. luya\admin\ngrest\base\NgRestRelation

Property Details

Hide inherited properties

$apiEndpoint public property
public void getApiEndpoint ( )
public void setApiEndpoint ( $apiEndpoint )
$arrayIndex public property
public void getArrayIndex ( )
public void setArrayIndex ( $index )
$dataProvider public property
$label public property
public void getLabel ( )
public void setLabel ( $label )
$modelClass public property
public void getModelClass ( )
public void setModelClass ( $modelClass )
$tabLabelAttribute public property
public void getTabLabelAttribute ( )
public void setTabLabelAttribute ( $attribute )
$targetModel public property (available since version 2.0.0)
public string getTargetModel ( )
public void setTargetModel ( $targetModel )

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

            
getApiEndpoint() public method

Get the api endpoint for the relation in order to make the relation data call.

public void getApiEndpoint ( )

                public function getApiEndpoint()
{
    if ($this->_apiEndpoint) {
        return $this->_apiEndpoint;
    }
    $targetModel = $this->getTargetModel();
    return $targetModel::ngRestApiEndpoint();
}

            
getArrayIndex() public method

Get the array index of the relation in the relations array.

public void getArrayIndex ( )

                public function getArrayIndex()
{
    return $this->_arrayIndex;
}

            
getDataProvider() public method

public yii\db\QueryInterface getDataProvider ( )

                public function getDataProvider()
{
    return $this->_dataProvider;
}

            
getLabel() public method

Get the label of the relation.

public void getLabel ( )

                public function getLabel()
{
    return $this->_label;
}

            
getModelClass() public method

Get the encoded model class name.

public void getModelClass ( )

                public function getModelClass()
{
    return $this->_modelClass;
}

            
getRelationLink() public method

Get relation link informations.

public void getRelationLink ( )

getTabLabelAttribute() public method

Returns the tab label attribute name.

In order to change the tab label, any of the available and exposed attributes can be taken. The attribute must be defined in {{luya\admin\ngrest\base\NgRestModel::ngRestScopes()}} list scope. The tab can only display labels which are returned by the API.

public void getTabLabelAttribute ( )

                public function getTabLabelAttribute()
{
    return $this->_tabLabelAttribute;
}

            
getTargetModel() public method (available since version 2.0.0)

Get the target model class path.

public string getTargetModel ( )

                public function getTargetModel()
{
    if (!$this->_targetModel) {
        throw new InvalidConfigException("The targetModel configuration of an ngrest relation can not be empty.");
    }
    return $this->_targetModel;
}

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

            
setApiEndpoint() public method

public void setApiEndpoint ( $apiEndpoint )
$apiEndpoint string

                public function setApiEndpoint($apiEndpoint)
{
    $this->_apiEndpoint = $apiEndpoint;
}

            
setArrayIndex() public method

Set the index of the relation in the relations array.

public void setArrayIndex ( $index )
$index

                public function setArrayIndex($index)
{
    $this->_arrayIndex = $index;
}

            
setDataProvider() public method

public void setDataProvider ( yii\db\QueryInterface $query )
$query yii\db\QueryInterface

                public function setDataProvider(QueryInterface $query)
{
    $this->_dataProvider = $query;
}

            
setLabel() public method

public void setLabel ( $label )
$label string

                public function setLabel($label)
{
    $this->_label = $label;
}

            
setModelClass() public method

Set the model class of the current ngRestModel.

public void setModelClass ( $modelClass )
$modelClass string

                public function setModelClass($modelClass)
{
    $this->_modelClass = base64_encode($modelClass);
}

            
setRelationLink() public method

public void setRelationLink ( $relationLink )
$relationLink string

setTabLabelAttribute() public method

Tab label attribute Setter.

The attribute must be declared in the {{luya\admin\ngrest\base\NgRestModel::ngRestScopes()}} list scope.

public void setTabLabelAttribute ( $attribute )
$attribute string

The name of the attribute which should be taken.

                public function setTabLabelAttribute($attribute)
{
    $this->_tabLabelAttribute = $attribute;
}

            
setTargetModel() public method (available since version 2.0.0)

Set the target model class.

public void setTargetModel ( $targetModel )
$targetModel string

                public function setTargetModel($targetModel)
{
    $this->_targetModel = $targetModel;
}