Class forum_driver_vb22

Description
Description | Vars | Methods (details)

Located in /sources/forum/vb22.php (line 23) 

forum_driver_base
   |
   --forum_driver_vb_shared
      |
      --forum_driver_vb22
Method Summary
Description | Vars | Methods (details)
array forum_authorise_login (?SHORT_TEXT $username, MEMBER $userid, MD5 $password_hashed, string $password_raw, [boolean $cookie_login = false])
array install_get_path_search_list ()
array install_specifics ()
boolean install_test_load_from (PATH $path)
boolean is_banned (MEMBER $member)
boolean is_hashed ()
TIME pnamelast_visit (array $r)
array _get_members_groups (MEMBER $member)
array _get_moderator_groups ()
array _get_super_admin_groups ()
array _get_usergroup_list ()
boolean _is_staff (MEMBER $member)
boolean _is_super_admin (MEMBER $member)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from forum_driver_base

forum_driver_base::$connection
 forum_driver_base::$MEMBER_ROWS_CACHED
Methods
Description | Vars Methods (details)
forum_authorise_login (line 225)

Find if the given member id and password is valid. If username is NULL, then the member id is used instead.

All authorisation, cookies, and form-logins, are passed through this function. Some forums do cookie logins differently, so a Boolean is passed in to indicate whether it is a cookie login.

  • return: A map of 'id' and 'error'. If 'id' is NULL, an error occured and 'error' is set
array forum_authorise_login (?SHORT_TEXT $username, MEMBER $userid, MD5 $password_hashed, string $password_raw, [boolean $cookie_login = false])
  • ?SHORT_TEXT $username: The member username (NULL: don't use this in the authentication - but look it up using the ID if needed)
  • MEMBER $userid: The member id
  • MD5 $password_hashed: The md5-hashed password
  • string $password_raw: The raw password
  • boolean $cookie_login: Whether this is a cookie login
install_get_path_search_list (line 89)

Get an array of paths to search for config at.

  • return: The paths in which to search for the forum config
array install_get_path_search_list ()
install_specifics (line 47)

Get an array of attributes to take in from the installer. Almost all forums require a table prefix, which the requirement there-of is defined through this function.

The attributes have 4 values in an array

  • name, the name of the attribute for info.php
  • default, the default value (perhaps obtained through autodetection from forum config)
  • description, a textual description of the attributes
  • title, a textual title of the attribute

  • return: The attributes for the forum
array install_specifics ()
install_test_load_from (line 64)

Searches for forum auto-config at this path.

  • return: Whether the forum auto-config could be found
boolean install_test_load_from (PATH $path)
  • PATH $path: The path in which to search
is_banned (line 129)

Find out if the given member id is banned.

  • return: Whether the member is banned
boolean is_banned (MEMBER $member)
  • MEMBER $member: The member id
is_hashed (line 32)

Find if login cookie is md5-hashed.

  • return: Whether the login cookie is md5-hashed
boolean is_hashed ()
pnamelast_visit (line 118)

From a member profile-row, get the member's last visit date.

  • return: The last visit date
TIME pnamelast_visit (array $r)
  • array $r: The profile-row
_get_members_groups (line 205)

Get the forum usergroup relating to the specified member id.

  • return: The array of forum usergroups
array _get_members_groups (MEMBER $member)
  • MEMBER $member: The member id
_get_moderator_groups (line 184)

Get the ids of the moderator usergroups.

It should not be assumed that a member only has one usergroup - this depends upon the forum the driver works for. It also does not take the staff site filter into account.

  • return: The moderator usergroup ids
array _get_moderator_groups ()
_get_super_admin_groups (line 173)

Get the ids of the admin usergroups.

  • return: The admin usergroup ids
array _get_super_admin_groups ()
_get_usergroup_list (line 194)

Get the forum usergroup list.

  • return: The usergroup list
array _get_usergroup_list ()
_is_staff (line 148)

Find if the specified member id is marked as staff or not.

  • return: Whether the member is staff
boolean _is_staff (MEMBER $member)
  • MEMBER $member: The member id
_is_super_admin (line 161)

Find if the specified member id is marked as a super admin or not.

  • return: Whether the member is a super admin
boolean _is_super_admin (MEMBER $member)
  • MEMBER $member: The member id

Inherited Methods

Inherited From forum_driver_vb_shared

forum_driver_vb_shared::check_db()
forum_driver_vb_shared::find_emoticons()
forum_driver_vb_shared::forum_get_lang()
forum_driver_vb_shared::forum_id_from_name()
forum_driver_vb_shared::get_custom_fields()
forum_driver_vb_shared::get_drivered_table_prefix()
forum_driver_vb_shared::get_emoticon_chooser()
forum_driver_vb_shared::get_emo_dir()
forum_driver_vb_shared::get_forum_topic_posts()
forum_driver_vb_shared::get_guest_id()
forum_driver_vb_shared::get_matching_members()
forum_driver_vb_shared::get_members()
forum_driver_vb_shared::get_member_avatar_url()
forum_driver_vb_shared::get_member_email_allowed()
forum_driver_vb_shared::get_member_from_username()
forum_driver_vb_shared::get_member_ip()
forum_driver_vb_shared::get_member_join_timestamp()
forum_driver_vb_shared::get_member_photo_url()
forum_driver_vb_shared::get_member_row()
forum_driver_vb_shared::get_member_row_field()
forum_driver_vb_shared::get_next_member()
forum_driver_vb_shared::get_num_forum_posts()
forum_driver_vb_shared::get_num_users_forums()
forum_driver_vb_shared::get_post_count()
forum_driver_vb_shared::get_previous_member()
forum_driver_vb_shared::get_skin_list()
forum_driver_vb_shared::get_tid_from_topic()
forum_driver_vb_shared::get_topics()
forum_driver_vb_shared::get_topic_count()
forum_driver_vb_shared::get_top_posters()
forum_driver_vb_shared::install_create_custom_field()
forum_driver_vb_shared::is_cookie_login_name()
forum_driver_vb_shared::make_post_forum_topic()
forum_driver_vb_shared::member_group_query()
forum_driver_vb_shared::member_home_link()
forum_driver_vb_shared::pget_row()
forum_driver_vb_shared::pin_topic()
forum_driver_vb_shared::pname_email()
forum_driver_vb_shared::pname_group()
forum_driver_vb_shared::pname_id()
forum_driver_vb_shared::pname_name()
forum_driver_vb_shared::post_link()
forum_driver_vb_shared::probe_ip()
forum_driver_vb_shared::set_custom_field()
forum_driver_vb_shared::show_forum_topics()
forum_driver_vb_shared::topic_link()
forum_driver_vb_shared::_forum_link()
forum_driver_vb_shared::_get_member_email_address()
forum_driver_vb_shared::_get_num_new_forum_posts()
forum_driver_vb_shared::_get_theme()
forum_driver_vb_shared::_get_username()
forum_driver_vb_shared::_join_link()
forum_driver_vb_shared::_member_pm_link()
forum_driver_vb_shared::_member_profile_link()
forum_driver_vb_shared::_online_link()

Inherited From forum_driver_base

forum_driver_base::disable_staff_filter()
forum_driver_base::forum_link()
forum_driver_base::get_guest_group()
forum_driver_base::get_members_groups()
forum_driver_base::get_member_email_address()
forum_driver_base::get_moderator_groups()
forum_driver_base::get_num_new_forum_posts()
forum_driver_base::get_super_admin_groups()
forum_driver_base::get_theme()
forum_driver_base::get_usergroup_list()
forum_driver_base::get_username()
forum_driver_base::is_staff()
forum_driver_base::is_super_admin()
forum_driver_base::join_link()
forum_driver_base::member_pm_link()
forum_driver_base::member_profile_hyperlink()
forum_driver_base::member_profile_link()
forum_driver_base::online_link()

Documentation generated on Sun, 02 Jan 2011 23:28:27 +0000 by phpDocumentor 1.4.3