Documentation

USERS
in package

Class USERS

Table of Contents

activateUserByMobile()  : bool
addShop()  : bool|mixed|null
addUserAction()  : bool
adminSecutiry()  : mixed
crudInstance()  : bool|mixed
editShopInfo()  : bool|mixed|null
editUserInfo()  : bool|mixed|null
forgotPassword()  : mixed
getPageSecurityID()  : mixed|null
getPageSecurityInfo()  : mixed|null
getShopID()  : mixed|null
getShopInfo()  : mixed|null
getUserInfo()  : bool|mixed
getUserPageItemPermission()  : mixed
getUserPagePermissions()  : mixed
getUserPermissionsFromDB()  : array<string|int, mixed>
ID()  : bool|mixed
ipAccess()  : mixed|null
isAdminLoggedIn()  : bool
IsSeller()  : bool|mixed
isUserLoggedIn()  : bool
login()  : bool|mixed|null
LoginByAdmin()  : bool|mixed|null
LoginUserWithID()  : bool|mixed|null
logout()  : mixed
newPinForLogin()  : bool|string
register()  : bool
reloadSessionFromDB()  : bool|mixed|null
sendActivateCode()  : bool
UserLogin()  : bool|mixed|null
validateUserCellphone()  : mixed|null
validateUserInfo()  : mixed|null

Methods

activateUserByMobile()

public static activateUserByMobile( $pin) : bool
Parameters
$pin :
Return values
bool

addShop()

public static addShop( $username,  $password,  $cellphone[, null $firstname = NULL ][, null $lastname = NULL ][, null $email = NULL ][, null $city_id = NULL ][, null $logo = NULL ][, null $banner = NULL ][, null $address = NULL ]) : bool|mixed|null
Parameters
$username :
$password :
$cellphone :
$firstname : null = NULL
$lastname : null = NULL
$email : null = NULL
$city_id : null = NULL
$logo : null = NULL
$banner : null = NULL
$address : null = NULL
Return values
bool|mixed|null

addUserAction()

public static addUserAction( $actionID) : bool
Parameters
$actionID :
Return values
bool

adminSecutiry()

public static adminSecutiry([string $return = '' ]) : mixed
Parameters
$return : string = ''
Return values
mixed

crudInstance()

public static crudInstance( $pageID) : bool|mixed
Parameters
$pageID :
Return values
bool|mixed

editShopInfo()

public static editShopInfo( $shopID,  $field,  $value) : bool|mixed|null
Parameters
$shopID :
$field :
$value :
Return values
bool|mixed|null

editUserInfo()

public static editUserInfo( $userID,  $field,  $value) : bool|mixed|null
Parameters
$userID :
$field :
$value :
Return values
bool|mixed|null

forgotPassword()

public static forgotPassword() : mixed
Return values
mixed

getPageSecurityID()

public static getPageSecurityID( $filename, int $param) : mixed|null
Parameters
$filename :
$param : int
Return values
mixed|null

getPageSecurityInfo()

public static getPageSecurityInfo( $filename, int $param) : mixed|null
Parameters
$filename :
$param : int
Return values
mixed|null

getShopID()

public static getShopID() : mixed|null
Return values
mixed|null

getShopInfo()

public static getShopInfo([bool $field = false ]) : mixed|null
Parameters
$field : bool = false
Return values
mixed|null

getUserInfo()

public static getUserInfo([null $param = null ]) : bool|mixed
Parameters
$param : null = null
Return values
bool|mixed

getUserPageItemPermission()

public static getUserPageItemPermission( $pageID,  $permission) : mixed
Parameters
$pageID :
$permission :
Return values
mixed

getUserPagePermissions()

public static getUserPagePermissions( $pageID) : mixed
Parameters
$pageID :
Return values
mixed

getUserPermissionsFromDB()

public static getUserPermissionsFromDB( $roleID) : array<string|int, mixed>
Parameters
$roleID :
Return values
array<string|int, mixed>

ID()

public static ID() : bool|mixed
Return values
bool|mixed

ipAccess()

public static ipAccess( $ip) : mixed|null
Parameters
$ip :
Return values
mixed|null

isAdminLoggedIn()

public static isAdminLoggedIn() : bool
Return values
bool

IsSeller()

public static IsSeller() : bool|mixed
Return values
bool|mixed

isUserLoggedIn()

public static isUserLoggedIn() : bool
Return values
bool

login()

public static login( $mobile,  $pass) : bool|mixed|null
Parameters
$mobile :
$pass :
Return values
bool|mixed|null

LoginByAdmin()

public static LoginByAdmin( $cellphone) : bool|mixed|null
Parameters
$cellphone :
Return values
bool|mixed|null

LoginUserWithID()

public static LoginUserWithID( $userID) : bool|mixed|null
Parameters
$userID :
Return values
bool|mixed|null

logout()

public static logout() : mixed
Return values
mixed

newPinForLogin()

public static newPinForLogin( $mobile) : bool|string
Parameters
$mobile :
Return values
bool|string

register()

public static register( $username,  $password,  $cellphone,  $sex,  $is_seller[, string $firstname = '' ][, string $lastname = '' ][, string $email = '' ][, string $province_id = '' ][, string $city_id = '' ][, string $national_code = '' ][, string $birthday = '' ]) : bool
Parameters
$username :
$password :
$cellphone :
$sex :
$is_seller :
$firstname : string = ''
$lastname : string = ''
$email : string = ''
$province_id : string = ''
$city_id : string = ''
$national_code : string = ''
$birthday : string = ''
Return values
bool

reloadSessionFromDB()

public static reloadSessionFromDB() : bool|mixed|null
Return values
bool|mixed|null

sendActivateCode()

public static sendActivateCode() : bool
Return values
bool

UserLogin()

public static UserLogin( $login,  $pass) : bool|mixed|null
Parameters
$login :
$pass :
Return values
bool|mixed|null

validateUserCellphone()

public static validateUserCellphone( $cellphone) : mixed|null
Parameters
$cellphone :
Return values
mixed|null

validateUserInfo()

public static validateUserInfo( $key,  $value) : mixed|null
Parameters
$key :
$value :
Return values
mixed|null

Search results