Go to the source code of this file.
| claro_get_uid_of_platform_admin | ( | ) |
Definition at line 273 of file user.lib.php.
| claro_get_uid_of_platform_contact | ( | ) |
Definition at line 317 of file user.lib.php.
| claro_get_uid_of_request_admin | ( | ) |
Definition at line 292 of file user.lib.php.
| claro_get_uid_of_system_notification_recipient | ( | ) |
Definition at line 342 of file user.lib.php.
| claro_get_user_course_list | ( | $ | user_id = null |
) |
Definition at line 1629 of file user.lib.php.
| claro_set_uid_of_platform_contact | ( | $ | user_id, | |
| $ | state = true | |||
| ) |
Definition at line 376 of file user.lib.php.
| claro_set_uid_recipient_of_request_admin | ( | $ | user_id, | |
| $ | state = true | |||
| ) |
Definition at line 393 of file user.lib.php.
| claro_set_uid_recipient_of_system_notification | ( | $ | user_id, | |
| $ | state = true | |||
| ) |
Definition at line 359 of file user.lib.php.
| delete_userInfoExtraDefinition | ( | $ | propertyId, | |
| $ | contextScope | |||
| ) |
Set or redefine an extended data for users.
| integer | $propertyId | |
| string | $contextScope |
Definition at line 1617 of file user.lib.php.
| generate_passwd | ( | $ | nb = 8 |
) |
Generates randomly password
Definition at line 578 of file user.lib.php.
| get_user_property | ( | $ | userId, | |
| $ | propertyId, | |||
| $ | force = false | |||
| ) |
Return a property of a user.
| interger | $userId | |
| string | $propertyId |
Definition at line 1528 of file user.lib.php.
Extended properties some info can be added for each user without change structure of user table. To do that , add a description Get all properties for a user
| int | $userId | |
| boolean | $force reload data from database. Use it if data can change between two call in same script | |
| boolean | $getUndefinedProperties. if false, function return only field where data overwrite the default value (NULL) |
Definition at line 1484 of file user.lib.php.
| get_userInfoExtraDefinitionList | ( | ) |
get the list of extraProperties for user accounts
Definition at line 1562 of file user.lib.php.
| is_official_code_available | ( | $ | official_code, | |
| $ | userId = null | |||
| ) |
Check if the official code is available
| string | official code | |
| integer | user_id |
Definition at line 870 of file user.lib.php.
| is_password_secure_enough | ( | $ | requestedPassword, | |
| $ | forbiddenValueList | |||
| ) |
Check if the password chosen by the user is not too much easy to find
| string | requested password | |
| array | list of other values of the form we wnt to check the password |
Definition at line 813 of file user.lib.php.
| is_username_available | ( | $ | username, | |
| $ | userId = null | |||
| ) |
Check if the username is available
| string | username | |
| integer | user_id |
Definition at line 847 of file user.lib.php.
| is_well_formed_email_address | ( | $ | address | ) |
Check an email
| string | $email email to check |
Definition at line 633 of file user.lib.php.
| profile_send_request_course_creator_status | ( | $ | explanation | ) |
Current logged user send a mail to ask course creator status
| string | explanation message |
Definition at line 486 of file user.lib.php.
| profile_send_request_revoquation | ( | $ | explanation, | |
| $ | login, | |||
| $ | password | |||
| ) |
Current logged user send a mail to ask course creator status
| string | explanation message |
Definition at line 530 of file user.lib.php.
| set_user_property | ( | $ | userId, | |
| $ | propertyId, | |||
| $ | propertyValue, | |||
| $ | scope = '' | |||
| ) |
Definition at line 1543 of file user.lib.php.
| update_userInfoExtraDefinition | ( | $ | propertyId, | |
| $ | label, | |||
| $ | type, | |||
| $ | defaultValue, | |||
| $ | contextScope, | |||
| $ | rank, | |||
| $ | required | |||
| ) |
Set or redefine an extended data for users.
| integer | $propertyId | |
| string | $label | |
| string | $type | |
| mixed | $defaultValue | |
| string | $contextScope | |
| integer | $rank | |
| boolean | $required |
Definition at line 1591 of file user.lib.php.
| user_check_authentication | ( | $ | password, | |
| $ | login | |||
| ) |
Check if the authentication fassword for the given user
| string | $password | |
| string | $login |
Definition at line 782 of file user.lib.php.
| user_create | ( | $ | settingList, | |
| $ | creatorId = null | |||
| ) |
Add a new user
| $settingList | array to fill the form | |
| $creatorId | id of account creator (null means created by owner) default null |
Definition at line 94 of file user.lib.php.
| user_delete | ( | $ | userId | ) |
Delete user form claroline platform
| int | $userId |
Definition at line 216 of file user.lib.php.
| user_display_preferred_language_select_box | ( | ) |
Get html select box for a user language preference
Definition at line 1450 of file user.lib.php.
| user_get_extra_data | ( | $ | userId | ) |
$extraInfo['user_id']['label'] = get_lang('User id'); $extraInfo['user_id']['value'] = $userId;
Definition at line 1701 of file user.lib.php.
| user_get_picture_path | ( | $ | userData | ) |
Definition at line 1673 of file user.lib.php.
| user_get_picture_url | ( | $ | userData | ) |
Definition at line 1687 of file user.lib.php.
| user_get_private_folder_path | ( | $ | userId | ) |
Definition at line 1659 of file user.lib.php.
| user_get_private_folder_url | ( | $ | userId | ) |
Definition at line 1666 of file user.lib.php.
| user_get_properties | ( | $ | userId | ) |
Get common user data on the platform
| integer | $userId id of user to fetch properties |
Definition at line 57 of file user.lib.php.
| user_html_form | ( | $ | data, | |
| $ | form_type = 'registration' | |||
| ) |
Display form to edit or add user to the platform
| $data | array to fill the form |
Definition at line 949 of file user.lib.php.
| user_html_form_add_new_user | ( | $ | data | ) |
Display user form registration
| $data | array to fill the form |
Definition at line 916 of file user.lib.php.
| user_html_form_admin_add_new_user | ( | $ | data | ) |
Display user admin form registration
| $data | array to fill the form |
Definition at line 927 of file user.lib.php.
| user_html_form_admin_user_profile | ( | $ | data | ) |
Display user admin form registration
| $data | array to fill the form |
Definition at line 938 of file user.lib.php.
| user_html_form_profile | ( | $ | data | ) |
Display user form profile
| $data | array to fill the form |
Definition at line 901 of file user.lib.php.
| user_html_form_registration | ( | $ | data | ) |
Display user form registration
| $data | array to fill the form |
Definition at line 890 of file user.lib.php.
| user_html_search_form | ( | $ | data | ) |
Display form to search already registered users to add to course Used when course managers can only add already registered users to their courses
| $data | array to fill the form |
Definition at line 1305 of file user.lib.php.
| user_initialise | ( | ) |
| user_is_admin | ( | $ | userId | ) |
Return true, if user is admin on the platform
| $userId |
Definition at line 417 of file user.lib.php.
| user_search | ( | $ | criterionList = array(), |
|
| $ | courseId = null, |
|||
| $ | allCriterion = true, |
|||
| $ | strictCompare = false, |
|||
| $ | ignoreDisabledAccounts = false | |||
| ) |
| array | $criterionList - Allowed keys are 'name', 'firstname', 'email', 'officialCode','username' | |
| string | $courseId (optional) permit check if user are already enrolled in the concerned cours | |
| boolean | $allCriterion (optional) define if all submited criterion has to be set. | |
| boolean | $strictCompare (optional) define if criterion comparison use wildcard or not | |
| boolean | $ignoreDisabledAccounts (optional) define disabled accounts are ignored or not (default : ignored) |
Definition at line 1377 of file user.lib.php.
| user_send_registration_mail | ( | $ | userId, | |
| $ | data | |||
| ) |
Send registration succeded email to user
| integer | $userId | |
| mixed | $data array of user data or null to keep data following $userId param. |
Definition at line 446 of file user.lib.php.
| user_set_platform_admin | ( | $ | status, | |
| $ | userId | |||
| ) |
Set or unset platform administrator status to a specific user
| boolean | $status | |
| int | $userId |
Definition at line 432 of file user.lib.php.
| user_set_properties | ( | $ | userId, | |
| $ | propertyList | |||
| ) |
Update user data
| $user_id | integer | |
| $propertyList | array |
Definition at line 151 of file user.lib.php.
| user_validate_form | ( | $ | formMode, | |
| $ | data, | |||
| $ | userId = null | |||
| ) |
validate user form
| string | $mode 'registration' or 'profile' or 'admin_user_profile' | |
| array | $data to fill the form | |
| int | $userId (optional) id of the user account currently edited |
Definition at line 687 of file user.lib.php.
| user_validate_form_admin_user_profile | ( | $ | data, | |
| $ | userId | |||
| ) |
validate form profile from user administration
| array | $data to fill the form | |
| int | $userId id of the user account currently edited |
Definition at line 673 of file user.lib.php.
| user_validate_form_profile | ( | $ | data, | |
| $ | userId | |||
| ) |
validate form profile
| array | $data to fill the form | |
| int | $userId id of the user account currently edited |
Definition at line 661 of file user.lib.php.
| user_validate_form_registration | ( | $ | data | ) |
validate form registration
| array | $data from the form |
Definition at line 648 of file user.lib.php.
1.6.3