Final Class luya\admin\models\UserSetting

Inheritanceluya\admin\models\UserSetting » yii\base\BaseObject
ImplementsArrayAccess, yii\base\Configurable
Available since version1.0.0

Store and read user settings.

UserSettins allows you to store values a user specific inside the database. For example the last state of the cms page tree.

Store a value for a key

Yii::$app->adminuser->identity->setting->set('lastPage', '.../url/to/last/page');

null, true and false are also valid values to store. To remove a settings entry call the remove() method:

Yii::$app->adminuser->identity->setting->remove('lastPage');

In order to set arrayable values use dot notation, for example.

Yii::$app->adminuser->identity->setting->set('menutree.id1', true);
Yii::$app->adminuser->identity->setting->set('menutree.id2', false);

The same works to get and delete array keys:

Yii::$app->adminuser->identity->setting->get('menutree.id1');

If the key does not exists, null will be returned by default.

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
get() Get a key of the user settings, dot notation is allowed to return a key of an array. luya\admin\models\UserSetting
getArray() Returns multiple array keys from the user settings table. luya\admin\models\UserSetting
has() Check if an element existing inside the user settings or not. luya\admin\models\UserSetting
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
offsetExists() luya\admin\models\UserSetting
offsetGet() luya\admin\models\UserSetting
offsetSet() luya\admin\models\UserSetting
offsetUnset() luya\admin\models\UserSetting
remove() Remove an element from the user settings data array. luya\admin\models\UserSetting
set() Add a new element to the user settings array. luya\admin\models\UserSetting

Constants

Hide inherited constants

Constant Value Description Defined By
SEPERATOR '.' luya\admin\models\UserSetting

Property Details

Hide inherited properties

$data public property
public $data = []
$sender public property
public $sender 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();
}

            
get() public method

Get a key of the user settings, dot notation is allowed to return a key of an array.

public string|array|null get ( $key, $default null )
$key string
$default string|boolean|null

                public function get($key, $default = null)
{
    $array = $this->data;
    foreach (explode(self::SEPERATOR, $key) as $item) {
        if (is_array($array) && array_key_exists($item, $array)) {
            $array = $array[$item];
        } else {
            return $default;
        }
    }
    return $array;
}

            
getArray() public method

Returns multiple array keys from the user settings table.

Example usage:

getArray(['key1', 'key2', [
    'key1' => false,
    'key2' => true,
]);

The above example would return the default value true for key2 if this element is not found inside the user settings.

public array getArray ( array $keys, array $defaultMapping = [] )
$keys array

Provide an array of keys you to select.

$defaultMapping array

In order to define a default value for a given key, just use the variable name as array key.`

                public function getArray(array $keys, array $defaultMapping = [])
{
    $data = [];
    foreach ($keys as $key) {
        $data[$key] = $this->get($key, array_key_exists($key, $defaultMapping) ? $defaultMapping[$key] : null);
    }
    return $data;
}

            
has() public method

Check if an element existing inside the user settings or not.

public boolean has ( $key )
$key string

                public function has($key)
{
    $array = $this->data;
    foreach (explode(self::SEPERATOR, $key) as $item) {
        if (is_array($array) && array_key_exists($item, $array)) {
            $array = $array[$item];
        } else {
            return false;
        }
    }
    return true;
}

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

            
offsetExists() public method

public void offsetExists ( $offset )
$offset

                #[\ReturnTypeWillChange]
public function offsetExists($offset)
{
    return $this->has($offset);
}

            
offsetGet() public method

public void offsetGet ( $offset )
$offset

                #[\ReturnTypeWillChange]
public function offsetGet($offset)
{
    return $this->get($offset);
}

            
offsetSet() public method

public void offsetSet ( $offset, $value )
$offset
$value

                #[\ReturnTypeWillChange]
public function offsetSet($offset, $value)
{
    $this->set($offset, $value);
}

            
offsetUnset() public method

public void offsetUnset ( $offset )
$offset

                #[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
    $this->remove($offset);
}

            
remove() public method

Remove an element from the user settings data array.

public boolean remove ( $key )
$key string

                public function remove($key)
{
    $lastArray = [];
    if ($this->has($key)) {
        $array = &$this->data;
        foreach (explode(self::SEPERATOR, $key) as $item) {
            if (array_key_exists($item, $array)) {
                $lastArray = &$array;
                $array = &$array[$item];
            }
        }
        unset($lastArray[$item]);
        if (empty($lastArray)) {
            unset($lastArray);
        }
        $this->save();
        return true;
    }
    return false;
}

            
set() public method

Add a new element to the user settings array.

public boolean set ( $key, $value )
$key string
$value array|string|boolean

                public function set($key, $value)
{
    $array = &$this->data;
    $keys = explode(self::SEPERATOR, $key);
    $i = 1;
    foreach ($keys as $item) {
        if (is_array($array) && array_key_exists($item, $array) && !is_array($array[$item]) && $i !== count($keys)) {
            return false;
        }
        $array = &$array[$item];
        $i++;
    }
    $array = $value;
    $this->save();
    return true;
}