HumHub Documentation (unofficial)

SettingsManager extends BaseSettingsManager
in package

Application

SettingsManager application component

Properties

$behaviors : array<string|int, Behavior>
$modelClass : string
$moduleId : string
$_loaded : array<string|int, mixed>|null
$contentContainers : array<string|int, ContentContainerSettingsManager>
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
contentContainer() : ContentContainerSettingsManager: Returns content container
delete() : mixed: Deletes setting
deleteAll() : mixed: Deletes all stored settings
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
flushContentContainer() : mixed: Clears runtime cached content container settings
get() : string|mixed|null: Returns value of setting
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getFixed() : mixed: Get the fixed setting value from configuration file.
getSerialized() : mixed|string|null: Receives a value which was saved as serialized value.
getUncached() : string: Returns the value of setting without any caching
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
isDatabaseInstalled() : bool: Checks if settings table exists or application is not installed yet
isFixed() : bool: Indicates this setting is fixed in configuration file and cannot be changed at runtime.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
reload() : mixed: Reloads all values from database
set() : void: Sets a settings value
setSerialized() : mixed: Can be used to set object/arrays as a serialized values.
space() : ContentContainerSettingsManager: Returns ContentContainerSettingsManager for the given $space or current controller space
trigger() : mixed: Triggers an event.
user() : ContentContainerSettingsManager|null: Returns ContentContainerSettingsManager for the given $user or current logged-in user
createRecord() : mixed: Returns settings active record instance
find() : ActiveQuery: Returns ActiveQuery to find settings
getCacheKey() : string: Returns settings managers cache key
invalidateCache() : mixed: Invalidates settings cache
loadValues() : mixed: Loads values from database
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$modelClass


    public
        string
    $modelClass
     = 'humhub\models\Setting'

settings model class name

$moduleId


    public
        string
    $moduleId

module id this settings manager belongs to.

$_loaded


    protected
        array<string|int, mixed>|null
    $_loaded
     = null

of loaded settings

$contentContainers


    protected
        array<string|int, ContentContainerSettingsManager>
    $contentContainers
     = []

already loaded content container settings managers

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

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.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

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.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

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

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

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


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

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

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

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

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

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

Parameters

$name : string: the property name

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read 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);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written 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);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

contentContainer()

Returns content container


    public
                    contentContainer(ContentContainerActiveRecord $container) : ContentContainerSettingsManager

Parameters

$container : ContentContainerActiveRecord

Return values

ContentContainerSettingsManager

delete()

Deletes setting


    public
                    delete(string $name) : mixed

Parameters

$name : string

deleteAll()

Deletes all stored settings


    public
                    deleteAll([string|array<string|int, mixed>|Stringable|null $prefix = null ]) : mixed

Parameters

$prefix : string|array<string|int, mixed>|Stringable|null = null: if set, only delete settings with given name prefix (e.g. "theme.") Versions before 1.15 used the $prefix parameter as a full wildcard ('%pattern%') and not actually as a prefix. Use $prefix = '%pattern%' to get the old behaviour. Or use $parameter = '%suffix' if you want to match against the end of the names.

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

flushContentContainer()

Clears runtime cached content container settings


    public
                    flushContentContainer([ContentContainerActiveRecord|null $container = null ]) : mixed

Parameters

$container : ContentContainerActiveRecord|null = null: if null all content containers will be flushed

get()

Returns value of setting


    public
                    get(string $name[, mixed $default = null ]) : string|mixed|null

Parameters

$name : string: the name of setting
$default : mixed = null

Return values

string|mixed|null —

the setting value or null when not exists

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getFixed()

Get the fixed setting value from configuration file.


    public
                    getFixed(string $name) : mixed

Parameters

$name : string

getSerialized()

Receives a value which was saved as serialized value.


    public
                    getSerialized(string $name[, mixed $default = null ][, bool $asArray = true ][, bool $throwException = false ]) : mixed|string|null

Parameters

$name : string
$default : mixed = null: the setting value or null when not exists
$asArray : bool = true: whether to return objects in terms of associative arrays.
$throwException : bool = false: if true then throw an exception upon error, rather than returning the serialized string

Return values

mixed|string|null

getUncached()

Returns the value of setting without any caching


    public
                    getUncached(string $name[, mixed $default = null ]) : string

Parameters

$name : string: the name of setting
$default : mixed = null

Return values

string —

the setting value or null when not exists

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

isDatabaseInstalled()

Checks if settings table exists or application is not installed yet


    public
            static        isDatabaseInstalled() : bool

Return values

bool

isFixed()

Indicates this setting is fixed in configuration file and cannot be changed at runtime.


    public
                    isFixed(string $name) : bool

Parameters

$name : string

Return values

bool

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

reload()

Reloads all values from database


    public
                    reload() : mixed

set()

Sets a settings value


    public
                    set(string $name, string|int|bool $value) : void

Parameters

$name : string
$value : string|int|bool

setSerialized()

Can be used to set object/arrays as a serialized values.


    public
                    setSerialized(string $name, mixed $value) : mixed

Parameters

$name : string
$value : mixed: array or object

space()

Returns ContentContainerSettingsManager for the given $space or current controller space


    public
                    space([Space|null $space = null ]) : ContentContainerSettingsManager

Parameters

$space : Space|null = null

Return values

ContentContainerSettingsManager

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

user()

Returns ContentContainerSettingsManager for the given $user or current logged-in user


    public
                    user([User|null $user = null ]) : ContentContainerSettingsManager|null

Parameters

$user : User|null = null

Return values

ContentContainerSettingsManager|null

createRecord()

Returns settings active record instance


    protected
                    createRecord() : mixed

find()

Returns ActiveQuery to find settings


    protected
                    find() : ActiveQuery

Return values

ActiveQuery

getCacheKey()

Returns settings managers cache key


    protected
                    getCacheKey() : string

Return values

string —

the cache key

invalidateCache()

Invalidates settings cache


    protected
                    invalidateCache() : mixed

loadValues()

Loads values from database


    protected
                    loadValues() : mixed

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

SettingsManager extends BaseSettingsManager in package Application

Tags

Table of Contents

Properties

Methods

Properties

$behaviors read-only

$modelClass

$moduleId

$_loaded

$contentContainers

$_behaviors

$_events

$_eventWildcards

Tags

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

contentContainer()

Parameters

Return values

delete()

Parameters

deleteAll()

Parameters

detachBehavior()

Parameters

Return values

detachBehaviors()

ensureBehaviors()

flushContentContainer()

Parameters

Tags

get()

SettingsManager extends BaseSettingsManager
in package

Application