PHPBoost Framework A.P.I.

UserAccountsConfig

Package: PHPBoost\Config Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Benoit SAUTEL ben.popeye@phpboost.com Version: PHPBoost 5.2 - last update: 2016 01 13 Since: PHPBoost 3.0 - 2009 10 28 Contributor: Julien BRISWALTER j1.seth@phpboost.com Located at: phpboost/config/UserAccountsConfig.class.php

This class contains all the data related to the user accounts configuration.

AbstractConfigData implements ConfigData

UserAccountsConfig

Methods summary
`public integer`	# `get_member_accounts_validation_method( )` Tells how the member accounts are activated 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.
`public`	# `set_member_accounts_validation_method( integer $method )` Sets the method used to validate the member accounts Sets the method used to validate the member accounts Parameters `$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.
`public string`	# `get_welcome_message( )` Returns the welcome message Returns the welcome message Returns string the message
`public`	# `set_welcome_message( string $message )` Sets the welcome message displayed on the member profile main page. Sets the welcome message displayed on the member profile main page. Parameters `$message` The welcome message
`public boolean`	# `is_registration_enabled( )` Tells whether the member registration is enabled Tells whether the member registration is enabled Returns boolean true if it is, false otherwise.
`public`	# `set_registration_enabled( boolean $enabled )` Sets the boolean indicating if the registration is enabled Sets the boolean indicating if the registration is enabled Parameters `$enabled` true if enabled, false otherwise
`public`	# `enable_registration( )` Enables the member registration Enables the member registration
`public`	# `disable_registration( )` Disables the member registration Disables the member registration
`public unknown_type`	# `get_registration_agreement( )` Gets the agreement that users must accept to register Gets the agreement that users must accept to register Returns unknown_type
`public`	# `set_registration_agreement( $agreement )` Sets the agreement that users mut accept to register Sets the agreement that users mut accept to register Parameters `$agreement` agreement
`public boolean`	# `is_avatar_upload_enabled( )` Tells whether users can upload their avatar Tells whether users can upload their avatar Returns boolean true if they can, false otherwise
`public`	# `set_avatar_upload_enabled( boolean $enabled )` Sets the boolean indicating if avatars can be uploaded on the server Sets the boolean indicating if avatars can be uploaded on the server Parameters `$enabled` true if enabled, false otherwise
`public boolean`	# `is_avatar_auto_resizing_enabled( )` Tells whether the scaling is enabled avatars Tells whether the scaling is enabled avatars Returns boolean true if they can, false otherwise
`public`	# `set_avatar_auto_resizing_enabled( boolean $enabled )` Sets the boolean value indicating whether the avatars should be resized automatically Sets the boolean value indicating whether the avatars should be resized automatically Parameters `$enabled` true if enabled, false otherwise
`public`	# `enable_avatar_upload( )` Lets users upload their avatar Lets users upload their avatar
`public`	# `disable_avatar_upload( )` Forbid users to upload their avatar Forbid users to upload their avatar
`public integer`	# `get_unactivated_accounts_timeout( )` Returns the time after which the member accounts which haven't been activated are removed Returns the time after which the member accounts which haven't been activated are removed Returns integer The time (in days)
`public`	# `set_unactivated_accounts_timeout( integer $duration )` Sets the duration of the unactivated accounts timeout Sets the duration of the unactivated accounts timeout Parameters `$duration` The duration (in days)
`public boolean`	# `is_default_avatar_enabled( )` Tells whether the default avatar is enabled Tells whether the default avatar is enabled Returns boolean true if it's enabled, false otherwise
`public`	# `set_default_avatar_name_enabled( true $enabled )` Sets the boolean indicating if the default avatar is enabled when a user hasn't its own one. Sets the boolean indicating if the default avatar is enabled when a user hasn't its own one. Parameters `$enabled` true if enabled, false otherwise
`public`	# `enable_default_avatar( )` Enables the default avatar for users who don't have their own one Enables the default avatar for users who don't have their own one
`public`	# `disable_default_avatar( )` Disables the default avatar for users who don't have their own one Disables the default avatar for users who don't have their own one
`public string`	# `get_default_avatar_name( )` Returns the default avatar URL Returns the default avatar URL Returns string sThe URL
`public`	# `set_default_avatar_name( tring $url )` Sets the default avatar URL Sets the default avatar URL Parameters `$url` The URL of the default avatar
`public integer`	# `get_max_avatar_width( )` Returns the max width of avatars Returns the max width of avatars Returns integer The width in pixels
`public`	# `set_max_avatar_width( integer $width )` Sets the max width of avatars Sets the max width of avatars Parameters `$width` The width in pixels
`public integer`	# `get_max_avatar_height( )` Returns the max height of avatars Returns the max height of avatars Returns integer The height in pixels
`public`	# `set_max_avatar_height( integer $height )` Sets the max height of avatars Sets the max height of avatars Parameters `$height` The height in pixels
`public integer`	# `get_max_avatar_weight( )` Returns the max weight of avatars Returns the max weight of avatars Returns integer The weight in kilobytes
`public`	# `set_max_avatar_weight( integer $weight )` Sets the max weight of avatars Sets the max weight of avatars Parameters `$weight` $height The weight in kilobytes
`public array`	# `get_auth_read_members( )` Returns the authorization to read members all Returns the authorization to read members all Returns array The array of authorizations.
`public`	# `set_auth_read_members( array $auth )` Sets the authorization to read members all Sets the authorization to read members all Parameters `$auth` array of authorizations.
`public`	# `get_default_lang( )`
`public`	# `set_default_lang( $lang )`
`public`	# `get_default_theme( )`
`public`	# `set_default_theme( $theme )`
`public`	# `get_max_private_messages_number( )`
`public`	# `set_max_private_messages_number( $number )`
`public`	# `are_users_allowed_to_change_display_name( )`
`public`	# `set_allow_users_to_change_display_name( $enabled )`
`public`	# `are_users_allowed_to_change_email( )`
`public`	# `set_allow_users_to_change_email( $enabled )`
`public string[mixed]`	# `get_default_values( )` Returns a map associating to each property name the corresponding default value Returns a map associating to each property name the corresponding default value Returns string[mixed]
`public static UserAccountsConfig`	# `load( )` Returns the configuration. Returns the configuration. Returns `UserAccountsConfig`
`public static`	# `save( )` Saves the configuration in the database. Has it become persistent. Saves the configuration in the database. Has it become persistent.

Methods inherited from AbstractConfigData
`__construct(), get_property(), set_default_values(), set_property(), synchronize()`

Constants summary
`string`	`MEMBER_ACCOUNTS_VALIDATION_METHOD_PROPERTY` Name of the property indicating if member accounts have to be validated and how. Name of the property indicating if member accounts have to be validated and how.	# `'member_accounts_validation_method'`
`string`	`WELCOME_MESSAGE_PROPERTY` Name of the property containing the welcome message visible at the entry of the member zone Name of the property containing the welcome message visible at the entry of the member zone	# `'welcome_message'`
`string`	`REGISTRATION_ENABLED_PROPERTY` Name of the property indicating if guests can register Name of the property indicating if guests can register	# `'registration_enabled'`
`string`	`REGISTRATION_AGREEMENT_PROPERTY` Name of the property containing the registration agreement that user must accept to register on the site Name of the property containing the registration agreement that user must accept to register on the site	# `'registration_agreement'`
`string`	`UNACTIVATED_ACCOUNTS_TIMEOUT_PROPERTY` Name of the property containing the time (in days) after which a member account which hasn't been activated will be automatically removed. Name of the property containing the time (in days) after which a member account which hasn't been activated will be automatically removed.	# `'unactivated_accounts_timeout'`
`string`	`ENABLE_AVATAR_UPLOAD_PROPERTY` Name of the property indicating if users can upload on the server their avatar Name of the property indicating if users can upload on the server their avatar	# `'enable_avatar_upload'`
`string`	`ENABLE_AVATAR_AUTO_RESIZING` Name of the property indicating whether avatars' automatic resizing is enabled or not Name of the property indicating whether avatars' automatic resizing is enabled or not	# `'enable_avatar_auto_resizing'`
`string`	`DEFAULT_AVATAR_ENABLED_PROPERTY` Name of the property indicating if the default avatar is enable (users who don't have a specific avatar will have the default one). Name of the property indicating if the default avatar is enable (users who don't have a specific avatar will have the default one).	# `'default_avatar_enabled'`
`string`	`DEFAULT_AVATAR_URL_PROPERTY` Name of the property indicating the URL of the default avatar Name of the property indicating the URL of the default avatar	# `'default_avatar_url'`
`string`	`MAX_AVATAR_WIDTH_PROPERTY` Name of the property indicating the maximum avatar width (in pixels). Name of the property indicating the maximum avatar width (in pixels).	# `'max_avatar_width'`
`string`	`MAX_AVATAR_HEIGHT_PROPERTY` Name of the property indicating the maximum avatar height (in pixels). Name of the property indicating the maximum avatar height (in pixels).	# `'max_avatar_height'`
`string`	`MAX_AVATAR_WEIGHT_PROPERTY` Name of the property containing the max size of avatars Name of the property containing the max size of avatars	# `'max_avatar_weight'`
`string`	`AUTH_READ_MEMBERS` Name of the property containing the authorization read member all Name of the property containing the authorization read member all	# `'auth_read_members'`
`integer`	`AUTH_READ_MEMBERS_BIT`	# `1`
`string`	`DEFAULT_LANG`	# `'default_lang'`
`string`	`DEFAULT_THEME`	# `'default_theme'`
`string`	`MAX_PRIVATE_MESSAGES_NUMBER`	# `'max_pm_number'`
`string`	`ALLOW_USERS_TO_CHANGE_DISPLAY_NAME`	# `'allow_users_to_change_display_name'`
`string`	`ALLOW_USERS_TO_CHANGE_EMAIL`	# `'allow_users_to_change_email'`
`string`	`AUTOMATIC_USER_ACCOUNTS_VALIDATION`	# `'1'`
`string`	`MAIL_USER_ACCOUNTS_VALIDATION`	# `'2'`
`string`	`ADMINISTRATOR_USER_ACCOUNTS_VALIDATION`	# `'3'`

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns