## Full index

### Package indexes

- PhorumAPI

b
top

base.php
  base.php in base.php

c
top

custom_profile_fields.php
  custom_profile_fields.php in custom_profile_fields.php

f
top

file_storage.php
  file_storage.php in file_storage.php

h
top

http_get.php
  http_get.php in http_get.php

i
top

image.php
  image.php in image.php

m
top

modules.php
  modules.php in modules.php
module_sort
  module_sort() in modules.php
  A small utility function which can be used to sort modules by name using the uasort() command.

p
top

PHORUM_ACCESS_ANY
  PHORUM_ACCESS_ANY in user.php
  Function call parameter, which tells phorum_api_user_check_access() and phorum_api_user_check_group_access() to check if the user is granted access for respectively any forum or group.
PHORUM_ACCESS_LIST
  PHORUM_ACCESS_LIST in user.php
  Function call parameter, which tells phorum_api_user_check_access() and phorum_api_user_check_group_access() to return an array of respectively forums or groups for which a user is granted access.
PHORUM_ADMIN_SESSION
  PHORUM_ADMIN_SESSION in user.php
  Function call parameter, which tells various functions that an admin back end session has to be handled.
phorum_api_custom_profile_field_byname
  phorum_api_custom_profile_field_byname() in custom_profile_fields.php
  Retrieve the information for a custom profile field by its name.
phorum_api_custom_profile_field_checkconfig
  phorum_api_custom_profile_field_checkconfig() in custom_profile_fields.php
  Check and fix the custom profile field configuration.
phorum_api_custom_profile_field_configure
  phorum_api_custom_profile_field_configure() in custom_profile_fields.php
  Create or update the configuration for a custom profile field.
phorum_api_custom_profile_field_delete
  phorum_api_custom_profile_field_delete() in custom_profile_fields.php
  Delete a custom profile field.
phorum_api_custom_profile_field_restore
  phorum_api_custom_profile_field_restore() in custom_profile_fields.php
  Restore a previously deleted custom profile field.
phorum_api_errno
  phorum_api_errno() in base.php
  Retrieve the error code for the last Phorum API function that was called.
phorum_api_error_set
  phorum_api_error_set() in base.php
  Set a Phorum API error.
phorum_api_file_check_delete_access
  phorum_api_file_check_delete_access() in file_storage.php
  Check if the active user has permission to delete a file.
phorum_api_file_check_read_access
  phorum_api_file_check_read_access() in file_storage.php
  Check if a file exists and if the active user has permission to read it.
phorum_api_file_check_write_access
  phorum_api_file_check_write_access() in file_storage.php
  Check if the active user has permissions to store a personal file or a message attachment.
phorum_api_file_delete
  phorum_api_file_delete() in file_storage.php
  Delete a Phorum file.
phorum_api_file_exists
  phorum_api_file_exists() in file_storage.php
  Check if a Phorum file exists.
phorum_api_file_get
  phorum_api_file_get() in file_storage.php
  Retrieve and return a Phorum file.
phorum_api_file_get_mimetype
  phorum_api_file_get_mimetype() in file_storage.php
  Lookup the MIME type for a given filename.
phorum_api_file_list
  phorum_api_file_list() in file_storage.php
  Retrieve a list of files.
phorum_api_file_purge_stale
  phorum_api_file_purge_stale() in file_storage.php
  This function is used for purging stale files from the Phorum system.
phorum_api_file_retrieve
  phorum_api_file_retrieve() in file_storage.php
  Retrieve a Phorum file.
phorum_api_file_send
  phorum_api_file_send() in file_storage.php
  Send a file to the browser.
phorum_api_file_store
  phorum_api_file_store() in file_storage.php
  Store or update a file.
phorum_api_http_get
  phorum_api_http_get() in http_get.php
  This function can be used to retrieve data from a URL using an HTTP GET request.
phorum_api_http_get_analyze
  phorum_api_http_get_analyze() in http_get.php
  A helper function for phorum_api_http_get() to determine what to do with a no "200 OK" response from the web server.
phorum_api_image_thumbnail
  phorum_api_image_thumbnail() in image.php
  Create an image thumbnail.
phorum_api_modules_check_updated_info
  phorum_api_modules_check_updated_info() in modules.php
  Check if there are modules for which the module information is updated.
phorum_api_modules_disable
  phorum_api_modules_disable() in modules.php
  Flag a module as disabled.
phorum_api_modules_enable
  phorum_api_modules_enable() in modules.php
  Flag a module as enabled.
phorum_api_modules_list
  phorum_api_modules_list() in modules.php
  Retrieve a list of all available modules.
phorum_api_modules_save
  phorum_api_modules_save() in modules.php
  Store the module information in the database.
phorum_api_strerror
  phorum_api_strerror() in base.php
  Retrieve the error message for the last Phorum API function that was called.
phorum_api_user_authenticate
  phorum_api_user_authenticate() in user.php
  Check the authentication credentials for a user.
phorum_api_user_check_access
  phorum_api_user_check_access() in user.php
  Check if a user has certain access right for forum(s).
phorum_api_user_check_group_access
  phorum_api_user_check_group_access() in user.php
phorum_api_user_delete
  phorum_api_user_delete() in user.php
  Delete a Phorum user.
phorum_api_user_get
  phorum_api_user_get() in user.php
  Retrieve data for Phorum users.
phorum_api_user_get_display_name
  phorum_api_user_get_display_name() in user.php
  Retrieve the display name to use for one or more users.
phorum_api_user_get_setting
  phorum_api_user_get_setting() in user.php
  This function can be used to retrieve the value for a user setting that was stored by the phorum_api_user_save_settings() function for the active Phorum user.
phorum_api_user_get_subscription
  phorum_api_user_get_subscription() in user.php
  Retrieve the type of a single subscription.
phorum_api_user_increment_posts
  phorum_api_user_increment_posts() in user.php
  Increment the posts counter for a user.
phorum_api_user_list
  phorum_api_user_list() in user.php
  Retrieve a list of Phorum users.
phorum_api_user_list_moderators
  phorum_api_user_list_moderators() in user.php
  Retrieve a list of moderators.
phorum_api_user_list_subscribers
  phorum_api_user_list_subscribers() in user.php
  Retrieve the email addresses of the users that are subscribed to a forum/thread, grouped by the preferred language for these users.
phorum_api_user_list_subscriptions
  phorum_api_user_list_subscriptions() in user.php
  Retrieve a list of threads to which a user is subscribed. The list can be limited to those threads which did receive contributions recently.
phorum_api_user_save
  phorum_api_user_save() in user.php
  Create or update Phorum users.
phorum_api_user_save_groups
  phorum_api_user_save_groups() in user.php
  Save the groups and group permissions for a user.
phorum_api_user_save_raw
  phorum_api_user_save_raw() in user.php
  This function quickly updates the Phorum users table, using all fields in the user data as real user table fields.
phorum_api_user_save_settings
  phorum_api_user_save_settings() in user.php
  Create or update user settings for the active Phorum user.
phorum_api_user_search
  phorum_api_user_search() in user.php
  Search for users, based on simple search conditions, which act on fields in the user table.
phorum_api_user_search_custom_profile_field
  phorum_api_user_search_custom_profile_field() in user.php
  Search for users, based on a simple search condition, which can be used to search on custom profile fields.
phorum_api_user_session_create
  phorum_api_user_session_create() in user.php
  Create a Phorum user session.
phorum_api_user_session_destroy
  phorum_api_user_session_destroy() in user.php
  Destroy a Phorum user session.
phorum_api_user_session_restore
  phorum_api_user_session_restore() in user.php
  Restore a Phorum user session.
phorum_api_user_set_active_user
  phorum_api_user_set_active_user() in user.php
  Set the active Phorum user.
phorum_api_user_subscribe
  phorum_api_user_subscribe() in user.php
  Subscribe a user to a thread.
phorum_api_user_unsubscribe
  phorum_api_user_unsubscribe() in user.php
  Unsubscribe a user from a thread.
phorum_api_write_file
  phorum_api_write_file() in write_file.php
  This function can be used to safely write a file to disk.
PHORUM_ERRNO_ERROR
  PHORUM_ERRNO_ERROR in base.php
  A general purpose errno value, mostly used for returning a generic errno with a specific error message.
PHORUM_ERRNO_INTEGRITY
  PHORUM_ERRNO_INTEGRITY in base.php
  An errno value, which indicates a database integrity problem.
PHORUM_ERRNO_INVALIDINPUT
  PHORUM_ERRNO_INVALIDINPUT in base.php
  An errno value, which indicates invalid input data.
PHORUM_ERRNO_NOACCESS
  PHORUM_ERRNO_NOACCESS in base.php
  An errno value, which indicates a permission problem.
PHORUM_ERRNO_NOTFOUND
  PHORUM_ERRNO_NOTFOUND in base.php
  An errno value, which indicates that something was not found.
PHORUM_FLAG_FORCE_DOWNLOAD
  PHORUM_FLAG_FORCE_DOWNLOAD in file_storage.php
  Function call flag, which tells phorum_api_file_retrieve() to force a download by the browser by sending an application/octet-stream Content-Type header. This flag will only have effect if the PHORUM_FLAG_SEND flag is set as well.
PHORUM_FLAG_GET
  PHORUM_FLAG_GET in file_storage.php
  Function call flag, which tells phorum_api_file_retrieve() that the retrieved Phorum file data has to be returned to the caller.
PHORUM_FLAG_HTML
  PHORUM_FLAG_HTML in user.php
  Function call flag, which tells phorum_api_user_get_display_name() that the returned display names have to be HTML formatted, so they can be used for showing the name in HTML pages.
PHORUM_FLAG_IGNORE_PERMS
  PHORUM_FLAG_IGNORE_PERMS in file_storage.php
  Function call flag, which tells the function to skip any permission checks.
PHORUM_FLAG_PLAINTEXT
  PHORUM_FLAG_PLAINTEXT in user.php
  Function call flag, which tells phorum_api_user_get_display_name() that the returned display names should be stripped down to plain text format, so they can be used for showing the name in things like mail messages and message quoting.
PHORUM_FLAG_RAW_PASSWORD
  PHORUM_FLAG_RAW_PASSWORD in user.php
  Function call flag, which tells phorum_api_user_save() that the password field should be stored as is.
PHORUM_FLAG_SEND
  PHORUM_FLAG_SEND in file_storage.php
  Function call flag, which tells phorum_api_file_retrieve() that the retrieved Phorum file can be sent to the browser directly.
PHORUM_FLAG_SESSION_ST
  PHORUM_FLAG_SESSION_ST in user.php
  Function call flag, which tells phorum_api_user_set_active_user() that the short term forum session has to be activated.
PHORUM_FORUM_SESSION
  PHORUM_FORUM_SESSION in user.php
  Function call parameter, which tells various functions that a front end forum session has to be handled.
PHORUM_GET_ACTIVE
  PHORUM_GET_ACTIVE in user.php
  Function call parameter, which tells phorum_api_user_get_list() that all active users have to be returned.
PHORUM_GET_ALL
  PHORUM_GET_ALL in user.php
  Function call parameter, which tells phorum_api_user_get_list() that all users have to be returned.
PHORUM_GET_INACTIVE
  PHORUM_GET_INACTIVE in user.php
  Function call parameter, which tells phorum_api_user_get_list() that all inactive users have to be returned.
PHORUM_MAX_CPLENGTH
  PHORUM_MAX_CPLENGTH in custom_profile_fields.php
  The maximum size that can be used for storing data for a single custom profile field.
PHORUM_ORIGINAL_USER_CODE
  PHORUM_ORIGINAL_USER_CODE in user.php
  If a user API is written as a replacement for the standard Phorum user API, where the replacement API is incompatible with the standard API, then this define should be set to FALSE. That will disable the user management functions in the admin interface.
PHORUM_SESSID_RESET_ALL
  PHORUM_SESSID_RESET_ALL in user.php
  Function call parameter, which tells phorum_api_user_session_create() that all session ids have to be reset to new values. This is for example appropriate after a user changed the password (so active sessions on other computers or browsers will be ended).
PHORUM_SESSID_RESET_LOGIN
  PHORUM_SESSID_RESET_LOGIN in user.php
  Function call parameter, which tells phorum_api_user_session_create() that session ids have to be reset to new values as far as that is sensible for a newly logged in user.
PHORUM_SESSION_ADMIN
  PHORUM_SESSION_ADMIN in user.php
  Used for identifying admin sessions. The value is used as the name for the session cookie for admin sessions.
PHORUM_SESSION_LONG_TERM
  PHORUM_SESSION_LONG_TERM in user.php
  Used for identifying long term sessions. The value is used as the name for the session cookie for long term sessions.
PHORUM_SESSION_SHORT_TERM
  PHORUM_SESSION_SHORT_TERM in user.php
  Used for identifying short term sessions. The value is used as the name for the session cookie for short term sessions (this is used by the tighter authentication scheme).
PHORUM_SUBSCRIPTION_BOOKMARK
  PHORUM_SUBSCRIPTION_BOOKMARK in user.php
  Subscription type, which tells Phorum to make the forums or threads that a user is subscribed to accessible from the followed threads interface in the control center. No mail is sent for new messages, but the user can check for new messages using that interface.
PHORUM_SUBSCRIPTION_DIGEST
  PHORUM_SUBSCRIPTION_DIGEST in user.php
  Subscription type, which tells Phorum to periodially send a mail message, containing a list of new messages in forums or threads that a user is subscribed to. There is currently no support for this type of subscription in the Phorum core code.
PHORUM_SUBSCRIPTION_MESSAGE
  PHORUM_SUBSCRIPTION_MESSAGE in user.php
  Subscription type, which tells Phorum to send out a mail message for every new forum or thread that a user is subscribed to.
PHORUM_SUBSCRIPTION_NONE
  PHORUM_SUBSCRIPTION_NONE in user.php
  Subscription type, which tells Phorum explicitly that the user does not have a subscription of any kind for the forum or thread.
PHORUM_USER_ACTIVE
  PHORUM_USER_ACTIVE in user.php
  User status, indicating that the registration has been completed and that the user can access the forums.
PHORUM_USER_ALLOW_ATTACH
  PHORUM_USER_ALLOW_ATTACH in user.php
  Permission flag which allows users to attach files to their forum messages.
PHORUM_USER_ALLOW_EDIT
  PHORUM_USER_ALLOW_EDIT in user.php
  Permission flag which allows users to edit their own forum messages.
PHORUM_USER_ALLOW_MODERATE_MESSAGES
  PHORUM_USER_ALLOW_MODERATE_MESSAGES in user.php
  Permission flag which allows users to edit other users' messages.
PHORUM_USER_ALLOW_MODERATE_USERS
  PHORUM_USER_ALLOW_MODERATE_USERS in user.php
  Permission flag which allows users to moderate user signup requests within the vroot.
PHORUM_USER_ALLOW_NEW_TOPIC
  PHORUM_USER_ALLOW_NEW_TOPIC in user.php
  Permission flag which allows users to start new forum topics.
PHORUM_USER_ALLOW_READ
  PHORUM_USER_ALLOW_READ in user.php
  Permission flag which allows users to read forum messages.
PHORUM_USER_ALLOW_REPLY
  PHORUM_USER_ALLOW_REPLY in user.php
  Permission flag which allows users to reply to forum messages.
PHORUM_USER_GROUP_APPROVED
  PHORUM_USER_GROUP_APPROVED in user.php
  Group permission flag for users which are active approved group members.
PHORUM_USER_GROUP_MODERATOR
  PHORUM_USER_GROUP_MODERATOR in user.php
  Group permission flag for users which are group moderator.
PHORUM_USER_GROUP_SUSPENDED
  PHORUM_USER_GROUP_SUSPENDED in user.php
  Group permission flag for users which are suspended by a group moderator.
PHORUM_USER_GROUP_UNAPPROVED
  PHORUM_USER_GROUP_UNAPPROVED in user.php
  Group permission flag for users which are not yet approved by a group moderator.
PHORUM_USER_INACTIVE
  PHORUM_USER_INACTIVE in user.php
  User status, indicating that the user has been deactivated.
PHORUM_USER_PENDING_BOTH
  PHORUM_USER_PENDING_BOTH in user.php
  User status, indicating that the user has not yet confirmed the registration by email and that a user moderator will have to approve the registration as well.
PHORUM_USER_PENDING_EMAIL
  PHORUM_USER_PENDING_EMAIL in user.php
  User status, indicating that the user has not yet confirmed the registration by email.
PHORUM_USER_PENDING_MOD
  PHORUM_USER_PENDING_MOD in user.php
  User status, indicating that the registration has not yet been approved by a user moderator.

u
top

user.php
  user.php in user.php

w
top

write_file.php
  write_file.php in write_file.php