App\Users
Inherited from cmsApplication_ManyToMany
Protected Attributes
| protected | $field_password | = 'password' |
| protected | $field_username | = 'username' |
| protected | $field_groupname | = 'groupname' |
| protected | $minimum_password_length | = 7 |
| protected | $data_directories | = array( 'avatar_original' => '/data/user/avatars/original', 'avatar_small' => '/data/user/avatars/small', 'avatar_medium' => '/data/user/avatars/medium', 'avatar_large' => '/data/user/avatars/large', 'user_public_images' => '/data/user/public/images', 'user_public_files' => '/data/user/public/files', ) |
Public Attributes
| public | $currentUserID |
Protected Methods
| protected | _internalCreateUser($datavalues, $creategroup=true) |
| protected | recordUserActivity($user_id, $description) |
| protected | getUserRealEmailAddress($email) Verify the user email address
|
| protected string | modifyDataValuesBeforeSaveItem(array $datavalues) @global \App\cmsLogger $SystemLog
|
| protected | markPasswordResetRequestComplete($id) |
| protected | getValidatedGroupIDs($group_ids) |
| protected | hook_modifyDataValuesBeforeSaveObject(\SCHLIX\cmsApplication_List $obj, array $datavalues) Hook - before save item
|
| protected | setUserSessionInformation(array $user, bool $rememberpassword) Set user information in the database @global \SCHLIX\cmsDatabase $SystemDB
|
| protected array | getUserHistoryByID(int $user_id) Returns all history for a specific user ID. It is assumed that the user ID is valid @global \SCHLIX\cmsDatabase $SystemDB
|
Public Methods
| public | __construct() |
| public | isBackendMode() |
| public | determineBackendMode() |
| public string | getFieldUsername() Returns the username field name in the item table
|
| public string | getFieldGroupName() Returns the groupname field name in the category table
|
| public type | getRegisteredUsersCount() Returns total user count
|
| public string | createFriendlyURL(string $str) create SEO friendly URL. Format is action={...}¶m1={....}¶m2={...}
|
| public | getPasswordFieldName() |
| public | getUsernameFieldName() |
| public string | getFieldItemTitle() Returns the title field name from $this->table_items (usually just title)
|
| public | getItemsByCategoryID($id, $fields=' *', $extra_criteria='', $start, $end, $sortby='', $sortdirection='ASC', $from_cache=false) |
| public array|boolean | getUserByUsernameAndPassword(string $input_username, string $input_password, array $input_groups=null) Validate username & password and returns an array of the user info if authentication is successful, otherwise returns false @global \SCHLIX\cmsDatabase $SystemDB
|
| public | recordCurrentUserActivity($description) |
| public array | verifyUserNamePassword(string $input_username, string $input_password) Verify username and password and returns the user info @global \SCHLIX\cmsConfigRegistry $SystemConfig
|
| public | userNameExists($input_username) |
| public | getAllUserGroupNames($guest_included=true) |
| public | getFailedLoginAttemptCount($input_username) |
| public | recordFailedLoginAttempt($input_username) |
| public | getUserNameByID($id, $from_cache=false) |
| public | getUserByID($id, $from_cache=false) |
| public | getUserInfoByID($id, $from_cache=false) |
| public | getUserInfoByUserName($username) |
| public | getUserByUserName($username) |
| public | getUserByEmailAddress($input_email) |
| public boolean | getCurrentUserInfo() Return an array containing the current user ID
|
| public int | getCurrentUserID() Return the current user ID
|
| public | getCurrentUserGroups() |
| public | getCurrentUserGroupNames() |
| public | getUserGroupNames($user_id) |
| public | isUserMemberOfGroupName($user_id, $groupname) |
| public | isCurrentUserMemberOfGroupName($groupname) |
| public | getCurrentUserGroupIDs() |
| public | getCurrentUserName() |
| public | displayUserInfoByID($user_id) |
| public | getGroupIDByGroupName($catname) |
| public | getGroupNameByGroupID($id) |
| public | validateUserNameString($str) |
| public | validateEmailAddressString($str) |
| public | resetSession() |
| public | debugSession() |
| public | logout() |
| public | adminAuthenticated() |
| public | authenticated() |
| public | generateRandomPasswordSalt($hash_type, $work_factor=9) |
| public type | generateNewSaltAndHashedPassword(string $password, string $salt='') Deprecated - generate password with salt. Use password_hash directly Deprecatedsince version 2.1.9-2
since version 2.1.9-2
|
| public string | convertIntoValidUserName(string $str) Converts a string to an alphanumeric one (dash and underscores allowed)
|
| public bool|array String array | getValidationErrorListBeforeSaveItem(array $datavalues) Validates save item. If there's an error, it will return an array with one or more error string, otherwise it will return a boolean true @global \App\Users $CurrentUser
|
| public | findDuplicateUsers($data) |
| public | validateNewUserRegistration() |
| public | sendRegistrationEmailToUserByID($user_id, $email_template_name, $vars=[]) |
| public | verifyActivationRequest($userid, $token, $activate_immediately=true) |
| public | getItemOrCategoryToViewFromFullVirtualFilename($url, $enable_redirect_no_trailingslash_folder=false) |
| public | generatePassword($length=6, $strength) |
| public boolean | changePassword(int $id, string $newpassword) Change a user's password
|
| public array | checkPasswordQuality(string $password, string $password_verify) Check password and return an array of error list
|
| public | getExistingPasswordResetRequestByIDAndHash($id, $hash, $days_difference=1) |
| public | getExistingPasswordResetRequestByUserID($id, $days_difference=1) |
| public | sendPasswordResetRequest($id) |
| public int | createPasswordResetRequest(array $user) Create a password reset request @global \SCHLIX\cmsDatabase $SystemDB
|
| public | restrictFunctionToAuthenticatedUser() Restrict function to authenticated user only
|
| public | restrictFunctionToAnonymousUser() Restrict function to be available only for anonymous user If the user is logged in, the URL will be forwarded to members welcome page
|
| public | setLoginRedirectURL($url) |
| public | getLoginRedirectURL() |
| public | validateEditProfile() |
| public | getItemByVirtualFilename($input_filename, $category_id=-1) |
| public array | getItemsByVirtualFilename(string $input_filename, int $category_id=-1) Returns one or more item with the same virtual filename. Used in later classes. There's a parameter $category_id that's not supposed to be in this class but it's there for compatibility with inherited classes @global \SCHLIX\cmsDatabase $SystemDB
|
| public array | getCategoriesByVirtualFilename(string $input_filename, int $parent_id=-1) Return multiple categories given a possible virtual filename @global \SCHLIX\cmsDatabase $SystemDB
|
| public | hasAdministrationPermission() |
| public | hasPermission($permission_str) |
| public | hasReadPermission($permission_str) |
| public | hasWritePermission($permission_str) |
| public | hook_modifyDataValuesBeforeSaveItem(\SCHLIX\cmsApplication_List $obj, array $datavalues) Hook - before save item
|
| public | hook_modifyDataValuesBeforeSaveCategory(\SCHLIX\cmsApplication_List $obj, array $datavalues) Hook - before save item
|
| public | getGroupIDArrayForPermission() |
| public | getGroupIDArrayForBackendAccessPermission() |
| public | displayAuthenticatedUserMainByApp(string $app_name) Display welcome page for authenticated users
|
| public | getListofFrontendApplicationsWithUserMainPage($from_cache=true, $cache_time_in_minutes=5) |
| public | updateLogHostnames() |
| public string | getUserAvatarURLByID(int $id, string $size='small') Returns a user's avatar URL. Valid size: small, medium, large.
|
| public string | getUserAvatarURLByExistingUserInfo(array $user, string $size='small') Returns a user's avatar URL. $he User parmaeter is an array containing user data that has been previously loaded. Valid size: small, medium, large.
|
| public array | performAuthentication(string $username, string $password, bool $rememberpassword) Perform username/password authentication and set user session information. This function returns an array ['status' => (int), 'message' => (array] Use the verifyUserNamePassword method if you don't want to set the session information
|
| public array | getUserByUserCookies() Get uid(username)/cvx (session name) from $_cookie, validate it, and return the user @global \SCHLIX\cmsDatabase $SystemDB
|
| public boolean | verifyCurrentSession() Verify the current user information @global \SCHLIX\cmsDatabase $SystemDB @global \App\cmsLogger $SystemLog
|
| public | loadDefaultStaticAssetFiles() Load default JS and CSS required for frontend @global \SCHLIX\cmsHTMLPageHeader $HTMLHeader
|
| public | viewLoginPage() View Login page
|
| public | viewUserRegistrationPage() View - new user registration page
|
| public | viewPasswordChangePage() View - Password change page for authenticated user
|
| public | viewEditMyProfilePage() Edit user profile @global \SCHLIX\cmsDatabase $SystemDB @global \App\Users $CurrentUser
|
| public | viewPasswordResetPage(string $id, string $hash) View Password reset page
|
| public boolean | viewActivationRequest(string $userid, string $token) View - user activation
|
| public | viewForgotPasswordPage() View user forgot password page
|
| public | viewAuthenticatedUserMainPage() View - Members welcome page
|
| public | viewMainPage() View - Main page
|
| public array | ajxp_NewRegistration(array $command) AJAX reply - new user registration
|
| public array | ajxp_UserUpdateProfile(array $command) AJAX - Update user profile
|
| public array | ajxp_UserLogin(array $command, $custom_redirect_url='') AJAX - Login
|
| public array | ajxp_UserChangePassword(array $command) AJAX - change user password
|
| public boolean | ajxp_UserActivation($command) View - user activation @global \SCHLIX\cmsHTMLPageHeader $HTMLHeader
|
| public | ajxp_UserForgotPassword($command) |
| public array | ajxp_UserForgotPasswordReset($command) AJAX - reset password for non-authenticated user
|
| public array | getPersonalDataByUserID(int $user_id) GDPR - returns an array of personal data by email
|
| public array | getPersonalDataByEmail($email_address) GDPR - returns an array of personal data by email
|
| public | removePersonalDataByUserID(int $user_id, $request_guid) GDPR - remove personal data by user ID
|
| public | removePersonalDataByEmail($email_address, $request_guid) GDPR - remove personal data by email
|
| public boolean | Run(array $command) Run Command for routing. Main command is in $command['action']
|
Public Static Methods
| public static | processRunDeleteExpiredSessions() For CRON TODO - fix for +2.2.0 since there was no date_last_seen and date_created @global \SCHLIX\cmsDatabase $SystemDB
|
| public static | processRunResolveUserHistoryHostnames() CRON Scheduler Method - resolve hostnames in log @global cmsLogger $SystemLog
|