Class

UserAccountsConfig

Package: phpboost Author: Benoit Sautel <ben.popeye@phpboost.com> Desc: This class contains all the data related to the user accounts configuration. Located at phpboost/config/UserAccountsConfig.class.php
AbstractConfigData implements ConfigData
Extended by UserAccountsConfig
Methods summary
public integer
# get_member_accounts_validation_method( )

Tells how the member accounts are activated

public
# set_member_accounts_validation_method( integer $method )

Sets the method used to validate the member accounts

public string
# get_welcome_message( )

Returns the welcome message

public
# set_welcome_message( string $message )

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

public boolean
# is_registration_enabled( )

Tells whether the member registration is enabled

public
# set_registration_enabled( boolean $enabled )

Sets the boolean indicating if the registration is enabled

public
# enable_registration( )

Enables the member registration

public
# disable_registration( )

Disables the member registration

public unknown_type
# get_registration_agreement( )

Gets the agreement that users must accept to register

public
# set_registration_agreement( mixed $agreement )

Sets the agreement that users mut accept to register

public boolean
# is_avatar_upload_enabled( )

Tells whether users can upload their avatar

public
# set_avatar_upload_enabled( boolean $enabled )

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

public boolean
# is_avatar_auto_resizing_enabled( )

Tells whether the scaling is enabled avatars

public
# set_avatar_auto_resizing_enabled( boolean $enabled )

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

public
# enable_avatar_upload( )

Lets users upload their avatar

public
# disable_avatar_upload( )

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

public
# set_unactivated_accounts_timeout( integer $duration )

Sets the duration of the unactivated accounts timeout

public boolean
# is_default_avatar_enabled( )

Tells whether the default avatar is enabled

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.

public
# enable_default_avatar( )

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

public string
# get_default_avatar_name( )

Returns the default avatar URL

public
# set_default_avatar_name( tring $url )

Sets the default avatar URL

public integer
# get_max_avatar_width( )

Returns the max width of avatars

public
# set_max_avatar_width( integer $width )

Sets the max width of avatars

public integer
# get_max_avatar_height( )

Returns the max height of avatars

public
# set_max_avatar_height( integer $height )

Sets the max height of avatars

public integer
# get_max_avatar_weight( )

Returns the max weight of avatars

public
# set_max_avatar_weight( integer $weight )

Sets the max weight of avatars

public array
# get_auth_read_members( )

Returns the authorization to read members all

public
# set_auth_read_members( array $auth )

Sets the authorization to read members all

public
public
# set_default_lang( mixed $lang )
public
public
# set_default_theme( mixed $theme )
public
public
public
public
public
public
public string[mixed]
# get_default_values( )
public static UserAccountsConfig
# load( )

Returns the configuration.

public static
# save( )

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 'member_accounts_validation_method'
#

Name of the property indicating if member accounts have to be validated and how.

string WELCOME_MESSAGE_PROPERTY 'welcome_message'
#

Name of the property containing the welcome message visible at the entry of the member zone

string REGISTRATION_ENABLED_PROPERTY 'registration_enabled'
#

Name of the property indicating if guests can register

string REGISTRATION_AGREEMENT_PROPERTY 'registration_agreement'
#

Name of the property containing the registration agreement that user must accept to register on the site

string UNACTIVATED_ACCOUNTS_TIMEOUT_PROPERTY 'unactivated_accounts_timeout'
#

Name of the property containing the time (in days) after which a member account which hasn't been activated will be automatically removed.

string ENABLE_AVATAR_UPLOAD_PROPERTY 'enable_avatar_upload'
#

Name of the property indicating if users can upload on the server their avatar

string ENABLE_AVATAR_AUTO_RESIZING 'enable_avatar_auto_resizing'
#

Name of the property indicating whether avatars' automatic resizing is enabled or not

string DEFAULT_AVATAR_ENABLED_PROPERTY 'default_avatar_enabled'
#

Name of the property indicating if the default avatar is enable (users who don't have a specific avatar will have the default one).

string DEFAULT_AVATAR_URL_PROPERTY 'default_avatar_url'
#

Name of the property indicating the URL of the default avatar

string MAX_AVATAR_WIDTH_PROPERTY 'max_avatar_width'
#

Name of the property indicating the maximum avatar width (in pixels).

string MAX_AVATAR_HEIGHT_PROPERTY 'max_avatar_height'
#

Name of the property indicating the maximum avatar height (in pixels).

string MAX_AVATAR_WEIGHT_PROPERTY 'max_avatar_weight'
#

Name of the property containing the max size of avatars

string AUTH_READ_MEMBERS 'auth_read_members'
#

Name of the property containing the authorization read member all

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'
#