Skip to content

Class: Users

Saqib Razzaq edited this page Mar 22, 2019 · 4 revisions

Users class is used for handling all signups, logins, permission validations and other authentications.

initialize

Parameters
Returns
Examples

column

Detect if a given value is user id or username

Parameters
Returns
Examples

userId

Get logged in user's ID

Parameters
Returns
Examples

username

Get logged in user's username

Parameters
Returns
Examples

level

Get logged in user's level

Parameters
Returns
Examples

ownsEmail

Check if a given user owns a given email

Parameters
Returns
Examples

exists

Check if a value exists against given columns

Parameters
Returns
Examples

useridExists

Check if given id exists

Parameters
Returns
Examples

usernameExists

Check if given username exists

Parameters
Returns
Examples

emailExists

Check if given email exists

Parameters
Returns
Examples

userExists

Check if given string matches against id, email or username of existing user

Parameters
Returns
Examples

get

Get a single user

Parameters
Returns
Examples

getField

Get a single field for a single user

Parameters
Returns
Examples

getFields

Get a multiple fields for a single user

Parameters
Returns
Examples

setField

date a single field of single user

Parameters
Returns
Examples

setFieldBulk

update a single field of multiple users

Parameters
Returns
Examples

setFields

update multiple fields of single user

Parameters
Returns
Examples

setFieldsBulk

update multiple columns of multiple users

Parameters
Returns
Examples

getById

Get all fields of user by id

Parameters
Returns
Examples

getByUsername

Get all fields of user by username

Parameters
Returns
Examples

getByEmail

Get all fields of user by email

Parameters
Returns
Examples

getId

Get ID of user

Parameters
Returns
Examples

getUsername

Get username of user

Parameters
Returns
Examples

getEmail

Get email of user

Parameters
Returns
Examples

getLevel

Get level of user

Parameters
Returns
Examples

getDate

Get signup date of user

Parameters
Returns
Examples

getStatus

Get status of user

Parameters
Returns
Examples

getDob

Get date of birth of user

Parameters
Returns
Examples

getBio

Get bio of user

Parameters
Returns
Examples

getAvatar

Get Avatar of user

Parameters
Returns
Examples

getCover

Get Cover of user

Parameters
Returns
Examples

list

List users matching several dynamic parameters

Parameters
Returns
Examples

listFresh

List most recent users

Parameters
Returns
Examples

listByState

List most users by specific state

Parameters
Returns
Examples

listActive

List users by active state

Parameters
Returns
Examples

listInactive

List users by inactive state

Parameters
Returns
Examples

count

Count total users matching parameters

Parameters
Returns
Examples

countActive

Count total active users

Parameters
Returns
Examples

countInactive

Count total inactive users

Parameters
Returns
Examples

validate

Validate fields before creating user

Parameters
Returns
Examples

validateUpdate

Validate fields before updating user

Parameters
Returns
Examples

activate

Set user state to activve

Parameters
Returns
Examples

bulkActivate

Set user state to active for multiple users

Parameters
Returns
Examples

deactivate

Set user state to inactive

Parameters
Returns
Examples

bulkDeactivate

Set user state to inactive for multiple users

Parameters
Returns
Examples

delete

Delete a user

Parameters
Returns
Examples

create

Insert a user into database

Parameters
Returns
Examples

update

Update a user's fields

Parameters
Returns
Examples

authenticate

Authenticate user credentials

Parameters
Returns
Examples

securePassword

Create hashed password for database

Parameters
Returns
Examples

login

Login a user

Parameters
Returns
Examples

authenticated

Check if a user is logged in

Parameters
Returns
Examples

isAdmin

Check if a user is admin

Parameters
Returns
Examples

uploadAvatar

Upload user avatar

Parameters
Returns
Examples

uploadCover

Upload user channel cover

Parameters
Returns
Examples
Clone this wiki locally