Skip to content

icms_member_user_Object

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_member_user_Object

Class for users

  • Class name: icms_member_user_Object
  • Namespace:
  • Parent class: icms_ipf_Object

Properties

$_isAdmin

private bool $_isAdmin = array()
  • Visibility: private
  • This property is static.

$_groups

private array $_groups = array()

Array of groups that user belongs to

  • Visibility: private

$_rank

private string $_rank = \null
  • Visibility: private

$_isOnline

private bool $_isOnline = \null
  • Visibility: private

uid

public int uid

User ID

  • Visibility: public

name

public string name

Name

  • Visibility: public

uname

public string uname

Username

  • Visibility: public

email

public string email

Email

  • Visibility: public

url

public string url

Homepage URL

  • Visibility: public

user_avatar

public array user_avatar

Avatar

  • Visibility: public

user_regdate

public int user_regdate

Registration date

  • Visibility: public

user_from

public string user_from

From

  • Visibility: public

user_sig

public string user_sig

Signature

  • Visibility: public

user_viewemail

public bool user_viewemail

Can others view email?

  • Visibility: public

actkey

public string actkey

Activation key

  • Visibility: public

pass

public string pass

Encoded password

  • Visibility: public

posts

public int posts

Post count written by this user

  • Visibility: public

attachsig

public bool attachsig

Attach signature?

  • Visibility: public

rank

public int rank

Rank

  • Visibility: public

level

public float level

Level

  • Visibility: public

theme

public string theme

Selected theme

  • Visibility: public

timezone_offset

public float timezone_offset

Timezone offset

  • Visibility: public

last_login

public int last_login

Last login time

  • Visibility: public

umode

public int umode

Comments display mode

  • Visibility: public

uorder

public int uorder

Comments order mode

  • Visibility: public

notify_method

public int notify_method

Notification method

  • Visibility: public

notify_mode

public int notify_mode

Notification mode

  • Visibility: public

user_occ

public string user_occ

Occupation

  • Visibility: public

bio

public string bio

BIO

  • Visibility: public

user_intrest

public string user_intrest

Interests

  • Visibility: public

user_mailok

public int user_mailok

Are sending mails ok?

  • Visibility: public

language

public string language

Language

  • Visibility: public

pass_expired

public bool pass_expired

Is password expired?

  • Visibility: public

login_name

public string login_name

Login name

  • Visibility: public

Methods

__construct

mixed icms_member_user_Object::__construct(mixed handler, array data)

constructor

  • Visibility: public

Arguments

  • handler mixed
  • data array - <p>Data to load into this object</p>

getUnameFromId

string icms_member_user_Object::getUnameFromId(int userid, int usereal)

Updated by Catzwolf 11 Jan 2004 find the username for a given ID

  • Visibility: public
  • This method is static.

Arguments

  • userid int - <p>ID of the user to find</p>
  • usereal int - <p>switch for usename or realname</p>

isGuest

bool icms_member_user_Object::isGuest()

check if the user is a guest user

  • Visibility: public

getForm

mixed icms_member_user_Object::getForm(mixed form_caption, mixed form_name, mixed form_action, mixed submit_button_caption, mixed cancel_js_action, mixed captcha)
  • Visibility: public

Arguments

  • form_caption mixed
  • form_name mixed
  • form_action mixed
  • submit_button_caption mixed
  • cancel_js_action mixed
  • captcha mixed

sendWelcomeMessage

mixed icms_member_user_Object::sendWelcomeMessage()

sends a welcome message to the user which account has just been activated

return TRUE if success, FALSE if not

  • Visibility: public

newUserNotifyAdmin

mixed icms_member_user_Object::newUserNotifyAdmin()

sends a notification to admins to inform them that a new user registered

This method first checks in the preferences if we need to send a notification to admins upon new user registration. If so, it sends the mail.

return TRUE if success, FALSE if not

  • Visibility: public

isAdmin

bool icms_member_user_Object::isAdmin(int module_id)

Is the user admin ?

This method will return true if this user has admin rights for the specified module.

  • If you don't specify any module ID, the current module will be checked.
  • If you set the module_id to -1, it will return true if the user has admin rights for at least one module
  • Visibility: public

Arguments

  • module_id int - <p>check if user is admin of this module</p>

getGroups

array icms_member_user_Object::getGroups()

get the groups that the user belongs to

  • Visibility: public

setGroups

mixed icms_member_user_Object::setGroups(array groupsArr)

set the groups for the user

  • Visibility: public

Arguments

  • groupsArr array - <p>Array of groups that user belongs to</p>

isActive

bool icms_member_user_Object::isActive()

is the user activated?

  • Visibility: public

isOnline

bool icms_member_user_Object::isOnline()

is the user currently logged in?

  • Visibility: public

gravatar

string icms_member_user_Object::gravatar(string rating, int size, string default, string border, mixed overwrite)

Gravatar plugin for ImpressCMS

  • Visibility: public

Arguments

  • rating string
  • size int - <p>(size in pixels of the image. Accept values between 1 to 80. Default 80)</p>
  • default string - <p>(url of default avatar. Will be used if no gravatar are found)</p>
  • border string - <p>(hexadecimal color)</p>
  • overwrite mixed

uid

int icms_member_user_Object::uid()

Returns uid of user

  • Visibility: public

login

mixed icms_member_user_Object::login()

Logs in current user

  • Visibility: public

setVar

mixed icms_member_user_Object::setVar(mixed name, mixed value, mixed options)
  • Visibility: public

Arguments

  • name mixed
  • value mixed
  • options mixed

isSameAsLoggedInUser

bool icms_member_user_Object::isSameAsLoggedInUser()

Checks if this user is same as logged in user

  • Visibility: public

rank

array icms_member_user_Object::rank()

get the user's rank

  • Visibility: public

logout

bool icms_member_user_Object::logout()

Logs out current user

  • Visibility: public
Clone this wiki locally