FIELDTYPE_TEXT
FIELDTYPE_TEXT
Constant to indentify a text property.
The FrontEndUsers module, besides being a module to provide authentication services to the frontend of a CMSMS website also has a complete and flexible API.
AddGroup(string $name, string $description) : array
Add a new group
| string | $name | The group name |
| string | $description | The group description |
Array containing two elements. The first element is the return status of the function (boolean), the second element is either a message in the case of an error, or the group id (integer) on success.
AddGroupPropertyRelation(int $grpid, string $propname, int $sortkey, boolean $lostun, int $required) : array
Add a new group property relation.
| int | $grpid | The group id |
| string | $propname | The property name |
| int | $sortkey | The sorting order for this relationship |
| boolean | $lostun | Wether this relationship should be used for the lostun stuff (deprecated) |
| int | $required | The required flag for this relationship. 0==off 1==optional, 2==required |
First element of the array is the return status, second element is the error message, if any.
AddPropertyDefn(string $name, string $prompt, int $type, int $length, int $maxlength, string $attribs, bool $force_unique, bool $encrypt)
Add a new property definition
| string | $name | The property name |
| string | $prompt | The property prompt for use in various views |
| int | $type | The field type |
| int | $length | The default length for rendering the property |
| int | $maxlength | The maximum length for rendering the property |
| string | $attribs | A serialized array of attributes for the property |
| bool | $force_unique | Whether or not the value for this property should be unique across all users. |
| bool | $encrypt | Whether or not this data should be encrypted in the database. |
AddUser(string $name, string $password, int $expires) : array
Add a user to the syetem
| string | $name | The new username |
| string | $password | The plain text password |
| int | $expires | the Unix timestamp of the expiry date |
The first element of the array is a boolean indicating success or failure, the second element is an error message, or the new UID.
DeleteUserFull(int $uid) : array
Completely delete a user from the database. Including all properties, group memberships, etc.
| int | $uid | The user identifier to delete. |
The first element of the array is a boolean status, the second element (if any) is an error message.
GetMemberGroupsArray(int $userid) : null|array
Get a list of the specified users groups (if any)
| int | $userid | The user identifier |
If the user is a member of any groups the resulting array will contail the userid, and the groupid in each element of the returned array.
GetUserProperty(string $title, mixed $defaultvalue) : string
Get a property value for the currently logged in user.
| string | $title | The property name |
| mixed | $defaultvalue | An optional default value if the property is not set for the user. Note, an empty string may be a valid property value. |
(All properties are stored as strings in the database)
GetUserPropertyFull(string $title, int $userid, mixed $defaultvalue) : string
Get a property value for the specified user id
| string | $title | the property name |
| int | $userid | The user identifier |
| mixed | $defaultvalue | An optional default value if the property is not set for the user. Note, an empty string may be a valid property value. |
(All properties are stored as strings in the database)
GetUserHistory(int $uid, string $action, int $count) : array
Get user history records, by descending date.
Warning: This could potentially return a very large array.
| int | $uid | |
| string | $action | An optional action filter (such as login or logout) |
| int | $count | An optional limit |
GetSelectOptions(string $name, int $dim)
Return select options for a property as a simple, or a 2 dimensional array
| string | $name | The property name |
| int | $dim | If 1, return a simple associative array. If 2, return a multi-dimensional array with properties option_name, option_text and control_name |
IsValidEmailAddress(string $email, int $uid, $check_existing) : boolean
Test if the email specified is valid, and optionally not used.
| string | The email address to test |
|
| int | $uid | If speciied, this value will be used to ensure that the email addresss is stored in the database and not associated with any other users. |
| $check_existing |
indicating wether this email address can be used within the system.
IsValidUsername(string $username, boolean $check, int $uid) : boolean
Test wether the specified username is valid for the system.
| string | $username | |
| boolean | $check | Optionally test whether this username is in current use. |
| int | $uid | If $check is true, indicate an optional uid to exclude from the check |
CheckPassword(string $username, string $password, string $groups) : boolean
Validate the user password.
This is is not a login operation, but does perform the validation of the password.
| string | $username | The user name |
| string | $password | The plain text password. |
| string | $groups | An optional comma separated list of group names. If specified, the user must also belong to one of these groups. |
Login(string $username, string $password, string $groups, boolean $ignored, $force_logout) : array
Log the user into the system.
| string | $username | |
| string | $password | The plain text password |
| string | $groups | An optional comma separated list of group names. If specified, the user must also belong to one of these groups. |
| boolean | $ignored | No longer used |
| $force_logout |
The first element of the array is either the uid or FALSE. If false, the second element is an error string.
SetGroup(int $gid, string $name, string $desc) : array
Update a group definition.
| int | $gid | |
| string | $name | The group name |
| string | $desc | An optional group description |
The first element of the array is a boolean status. If false, the second element is an error string.