Class UserAccountsConfig

__construct()

__construct() 

Constructs a AbstractConfigData object

• Inherited from \AbstractConfigData

Tags

None found

synchronize()

synchronize() 

This method is not used in the configuration context.

{@inheritdoc}

final

• Inherited from \AbstractConfigData

Tags

None found

set_default_values()

set_default_values() 

Redefine this method if you want to avoid getting errors while asking values.

If some entries doesn't exist, they can be created here.

• Inherited from \AbstractConfigData

Tags

None found

get_property()

get_property(string $name) : string

Reads a property's value.

Parameters

string

$name

Name of the property to read

Returns

string —

the read value

• Inherited from \AbstractConfigData

Tags

None found

set_property()

set_property(string $name, string $value) 

Sets a property value. If the property exists, it overrides its value, otherwise, it creates an entry for this property.

Parameters

string	$name	Name of the property
string	$value	Value of the property

• Inherited from \AbstractConfigData

Tags

None found

get_default_values()

get_default_values() : \string[mixed]

Returns a map associating to each property name the corresponding default value

Returns

\string[mixed]

• Inherited from \UserAccountsConfig

Tags

None found

get_member_accounts_validation_method()

get_member_accounts_validation_method() : integer

Tells how the member accounts are activated

Returns

integer —

0 if there is no activation, 1 if the member activates its account thanks to the mail it receives, 2 if the administrator has to approbate it.

• Inherited from \UserAccountsConfig

Tags

None found

set_member_accounts_validation_method()

set_member_accounts_validation_method(integer $method) 

Sets the method used to validate the member accounts

Parameters

integer

$method

0 if there is no activation, 1 if the member activates its account thanks to the mail it receives, 2 if the administrator has to approbate it.

• Inherited from \UserAccountsConfig

Tags

None found

get_welcome_message()

get_welcome_message() : string

Returns the welcome message

Returns

string —

the message

• Inherited from \UserAccountsConfig

Tags

None found

set_welcome_message()

set_welcome_message(string $message) 

Sets the welcome message displayed on the member profile main page.

Parameters

string

$message

The welcome message

• Inherited from \UserAccountsConfig

Tags

None found

is_registration_enabled()

is_registration_enabled() : boolean

Tells whether the member registration is enabled

Returns

boolean —

true if it is, false otherwise.

• Inherited from \UserAccountsConfig

Tags

None found

set_registration_enabled()

set_registration_enabled(boolean $enabled) 

Sets the boolean indicating if the registration is enabled

Parameters

boolean

$enabled

true if enabled, false otherwise

• Inherited from \UserAccountsConfig

Tags

None found

enable_registration()

enable_registration() 

Enables the member registration

• Inherited from \UserAccountsConfig

Tags

None found

disable_registration()

disable_registration() 

Disables the member registration

• Inherited from \UserAccountsConfig

Tags

None found

get_registration_agreement()

get_registration_agreement() : \unknown_type

Gets the agreement that users must accept to register

Returns

\unknown_type

• Inherited from \UserAccountsConfig

Tags

None found

set_registration_agreement()

set_registration_agreement( $agreement) 

Sets the agreement that users mut accept to register

Parameters

$agreement

The agreement

• Inherited from \UserAccountsConfig

Tags

None found

is_avatar_upload_enabled()

is_avatar_upload_enabled() : boolean

Tells whether users can upload their avatar

Returns

boolean —

true if they can, false otherwise

• Inherited from \UserAccountsConfig

Tags

None found

set_avatar_upload_enabled()

set_avatar_upload_enabled(boolean $enabled) 

Sets the boolean indicating if avatars can be uploaded on the server

Parameters

boolean

$enabled

true if enabled, false otherwise

• Inherited from \UserAccountsConfig

Tags

None found

is_avatar_auto_resizing_enabled()

is_avatar_auto_resizing_enabled() : boolean

Tells whether the scaling is enabled avatars

Returns

boolean —

true if they can, false otherwise

• Inherited from \UserAccountsConfig

Tags

None found

set_avatar_auto_resizing_enabled()

set_avatar_auto_resizing_enabled(boolean $enabled) 

Sets the boolean value indicating whether the avatars should be resized automatically

Parameters

boolean

$enabled

true if enabled, false otherwise

• Inherited from \UserAccountsConfig

Tags

None found

enable_avatar_upload()

enable_avatar_upload() 

Lets users upload their avatar

• Inherited from \UserAccountsConfig

Tags

None found

disable_avatar_upload()

disable_avatar_upload() 

Forbid users to upload their avatar

• Inherited from \UserAccountsConfig

Tags

None found

get_unactivated_accounts_timeout()

get_unactivated_accounts_timeout() : integer

Returns the time after which the member accounts which haven't been activated are removed

Returns

integer —

The time (in days)

• Inherited from \UserAccountsConfig

Tags

None found

set_unactivated_accounts_timeout()

set_unactivated_accounts_timeout(integer $duration) 

Sets the duration of the unactivated accounts timeout

Parameters

integer

$duration

The duration (in days)

• Inherited from \UserAccountsConfig

Tags

None found

get_default_avatar_name()

get_default_avatar_name() : string

Returns the default avatar URL

Returns

string —

The URL

• Inherited from \UserAccountsConfig

Tags

None found

set_default_avatar_name()

set_default_avatar_name(string $url) 

Sets the default avatar URL

Parameters

string

$url

The URL of the default avatar

• Inherited from \UserAccountsConfig

Tags

None found

is_default_avatar_enabled()

is_default_avatar_enabled() : boolean

Tells whether the default avatar is set or not

Returns

boolean —

true if it is, false otherwise

• Inherited from \UserAccountsConfig

Tags

None found

get_default_avatar()

get_default_avatar() : string

Returns the default avatar proper URL adapted to user template if exists

Returns

string —

The URL

• Inherited from \UserAccountsConfig

Tags

None found

get_max_avatar_width()

get_max_avatar_width() : integer

Returns the max width of avatars

Returns

integer —

The width in pixels

• Inherited from \UserAccountsConfig

Tags

None found

set_max_avatar_width()

set_max_avatar_width(integer $width) 

Sets the max width of avatars

Parameters

integer

$width

The width in pixels

• Inherited from \UserAccountsConfig

Tags

None found

get_max_avatar_height()

get_max_avatar_height() : integer

Returns the max height of avatars

Returns

integer —

The height in pixels

• Inherited from \UserAccountsConfig

Tags

None found

set_max_avatar_height()

set_max_avatar_height(integer $height) 

Sets the max height of avatars

Parameters

integer

$height

The height in pixels

• Inherited from \UserAccountsConfig

Tags

None found

get_max_avatar_weight()

get_max_avatar_weight() : integer

Returns the max weight of avatars

Returns

integer —

The weight in kilobytes

• Inherited from \UserAccountsConfig

Tags

None found

set_max_avatar_weight()

set_max_avatar_weight( $weight) 

Sets the max weight of avatars

Parameters

$weight

• Inherited from \UserAccountsConfig

Tags

None found

get_auth_read_members()

get_auth_read_members() : array

Returns the authorization to read members all

Returns

array —

The array of authorizations.

• Inherited from \UserAccountsConfig

Tags

None found

set_auth_read_members()

set_auth_read_members( $auth) 

Sets the authorization to read members all

Parameters

$auth

• Inherited from \UserAccountsConfig

Tags

None found

get_default_lang()

get_default_lang() 

• Inherited from \UserAccountsConfig

Tags

None found

set_default_lang()

set_default_lang( $lang) 

Parameters

$lang

• Inherited from \UserAccountsConfig

Tags

None found

get_default_theme()

get_default_theme() 

• Inherited from \UserAccountsConfig

Tags

None found

set_default_theme()

set_default_theme( $theme) 

Parameters

$theme

• Inherited from \UserAccountsConfig

Tags

None found

get_max_private_messages_number()

get_max_private_messages_number() 

• Inherited from \UserAccountsConfig

Tags

None found

set_max_private_messages_number()

set_max_private_messages_number( $number) 

Parameters

$number

• Inherited from \UserAccountsConfig

Tags

None found

are_users_allowed_to_change_display_name()

are_users_allowed_to_change_display_name() 

• Inherited from \UserAccountsConfig

Tags

None found

set_allow_users_to_change_display_name()

set_allow_users_to_change_display_name( $enabled) 

Parameters

$enabled

• Inherited from \UserAccountsConfig

Tags

None found

are_users_allowed_to_change_email()

are_users_allowed_to_change_email() 

• Inherited from \UserAccountsConfig

Tags

None found

set_allow_users_to_change_email()

set_allow_users_to_change_email( $enabled) 

Parameters

$enabled

• Inherited from \UserAccountsConfig

Tags

None found

load()

load() : \UserAccountsConfig

Returns the configuration.

Returns

\UserAccountsConfig

static

• Inherited from \UserAccountsConfig

Tags

None found

save()

save() 

Saves the configuration in the database. Has it become persistent.

static

• Inherited from \UserAccountsConfig

Tags

None found

get_default_value()

get_default_value( $property) 

Parameters

$property

• Inherited from \AbstractConfigData

Tags

None found