-
phorum_api_errno
-
Retrieve the error code for the last Phorum API function that was called.
-
phorum_api_error_set
-
Set a Phorum API error.
-
phorum_api_strerror
-
Retrieve the error message for the last Phorum API function that was called.
-
PHORUM_ERRNO_ERROR
-
A general purpose errno value, mostly used for returning a generic errno with a specific error message.
-
PHORUM_ERRNO_INTEGRITY
-
An errno value, which indicates a database integrity problem.
-
PHORUM_ERRNO_INVALIDINPUT
-
An errno value, which indicates invalid input data.
-
PHORUM_ERRNO_NOACCESS
-
An errno value, which indicates a permission problem.
-
PHORUM_ERRNO_NOTFOUND
-
An errno value, which indicates that something was not found.
-
phorum_api_custom_profile_field_byname
-
Retrieve the information for a custom profile field by its name.
-
phorum_api_custom_profile_field_checkconfig
-
Check and fix the custom profile field configuration.
-
phorum_api_custom_profile_field_configure
-
Create or update the configuration for a custom profile field.
-
phorum_api_custom_profile_field_delete
-
Delete a custom profile field.
-
phorum_api_custom_profile_field_restore
-
Restore a previously deleted custom profile field.
-
PHORUM_MAX_CPLENGTH
-
The maximum size that can be used for storing data for a single custom profile field.
-
phorum_api_file_check_delete_access
-
Check if the active user has permission to delete a file.
-
phorum_api_file_check_read_access
-
Check if a file exists and if the active user has permission to read it.
-
phorum_api_file_check_write_access
-
Check if the active user has permissions to store a personal file or a message attachment.
-
phorum_api_file_delete
-
Delete a Phorum file.
-
phorum_api_file_exists
-
Check if a Phorum file exists.
-
phorum_api_file_get
-
Retrieve and return a Phorum file.
-
phorum_api_file_get_mimetype
-
Lookup the MIME type for a given filename.
-
phorum_api_file_list
-
Retrieve a list of files.
-
phorum_api_file_purge_stale
-
This function is used for purging stale files from the Phorum system.
-
phorum_api_file_retrieve
-
Retrieve a Phorum file.
-
phorum_api_file_safe_to_view
-
Check if the file is safe to view in the browser.
-
phorum_api_file_send
-
Send a file to the browser.
-
phorum_api_file_store
-
Store or update a file.
-
PHORUM_FLAG_FORCE_DOWNLOAD
-
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_IGNORE_PERMS
-
Function call flag, which tells the function to skip any permission checks.
-
PHORUM_FLAG_SEND
-
-
phorum_api_modules_check_updated_info
-
Check if there are modules for which the module information is updated.
-
phorum_api_modules_disable
-
Flag a module as disabled.
-
phorum_api_modules_enable
-
Flag a module as enabled.
-
phorum_api_modules_list
-
Retrieve a list of all available modules.
-
phorum_api_modules_save
-
Store the module information in the database.
-
phorum_api_http_get
-
This function can be used to retrieve data from a URL using an HTTP GET request.
-
phorum_api_http_get_analyze
-
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_http_get_supported
-
Check if platform support is available for retrieving files via HTTP using phorum_api_http_get().
-
phorum_api_image_supported
-
Check if platform support is available for scaling images.
-
phorum_api_image_thumbnail
-
Create an image thumbnail.
-
phorum_api_write_file
-
This function can be used to safely write a file to disk.
-
PHORUM_ACCESS_ANY
-
-
PHORUM_ACCESS_LIST
-
-
PHORUM_ADMIN_SESSION
-
Function call parameter, which tells various functions that an admin back end session has to be handled.
-
phorum_api_user_authenticate
-
Check the authentication credentials for a user.
-
phorum_api_user_check_access
-
Check if a user has certain access right for forum(s).
-
phorum_api_user_check_group_access
-
-
phorum_api_user_delete
-
Delete a Phorum user.
-
phorum_api_user_format
-
-
phorum_api_user_get
-
Retrieve data for Phorum users.
-
phorum_api_user_get_active_user
-
Retrieve the active Phorum user.
-
phorum_api_user_get_display_name
-
Retrieve the display name to use for one or more users.
-
phorum_api_user_get_groups
-
Retrieve the groups and their subscription statuses for a user.
-
phorum_api_user_get_setting
-
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
-
Retrieve the type of a single subscription.
-
phorum_api_user_increment_posts
-
Increment the posts counter for a user.
-
phorum_api_user_list
-
Retrieve a list of Phorum users.
-
phorum_api_user_list_moderators
-
Retrieve a list of moderators.
-
phorum_api_user_list_subscribers
-
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
-
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
-
Create or update Phorum users.
-
phorum_api_user_save_groups
-
Save the groups and group permissions for a user.
-
phorum_api_user_save_raw
-
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
-
Create or update user settings for the active Phorum user.
-
phorum_api_user_search
-
Search for users, based on simple search conditions, which act on fields in the user table.
-
phorum_api_user_search_custom_profile_field
-
Search for users, based on a simple search condition, which can be used to search on custom profile fields.
-
phorum_api_user_session_create
-
Create a Phorum user session.
-
phorum_api_user_session_destroy
-
Destroy a Phorum user session.
-
phorum_api_user_session_restore
-
Restore a Phorum user session.
-
phorum_api_user_set_active_user
-
Set the active Phorum user.
-
phorum_api_user_subscribe
-
Subscribe a user to a thread.
-
phorum_api_user_unsubscribe
-
Unsubscribe a user from a thread.
-
PHORUM_FLAG_HTML
-
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_PLAINTEXT
-
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_SESSION_ST
-
-
PHORUM_FORUM_SESSION
-
Function call parameter, which tells various functions that a front end forum session has to be handled.
-
PHORUM_GET_ACTIVE
-
Function call parameter, which tells phorum_api_user_get_list() that all active users have to be returned.
-
PHORUM_GET_ALL
-
Function call parameter, which tells phorum_api_user_get_list() that all users have to be returned.
-
PHORUM_GET_INACTIVE
-
Function call parameter, which tells phorum_api_user_get_list() that all inactive users have to be returned.
-
PHORUM_ORIGINAL_USER_CODE
-
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
-
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
-
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
-
Used for identifying admin sessions. The value is used as the name for the session cookie for admin sessions.
-
PHORUM_SESSION_LONG_TERM
-
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
-
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
-
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
-
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
-
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
-
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
-
User status, indicating that the registration has been completed and that the user can access the forums.
-
PHORUM_USER_ALLOW_ATTACH
-
Permission flag which allows users to attach files to their forum messages.
-
PHORUM_USER_ALLOW_EDIT
-
Permission flag which allows users to edit their own forum messages.
-
PHORUM_USER_ALLOW_MODERATE_MESSAGES
-
Permission flag which allows users to edit other users' messages.
-
PHORUM_USER_ALLOW_MODERATE_USERS
-
Permission flag which allows users to moderate user signup requests within the vroot.
-
PHORUM_USER_ALLOW_NEW_TOPIC
-
Permission flag which allows users to start new forum topics.
-
PHORUM_USER_ALLOW_READ
-
Permission flag which allows users to read forum messages.
-
PHORUM_USER_ALLOW_REPLY
-
Permission flag which allows users to reply to forum messages.
-
PHORUM_USER_GROUP_APPROVED
-
Group permission flag for users which are active approved group members.
-
PHORUM_USER_GROUP_MODERATOR
-
Group permission flag for users which are group moderator.
-
PHORUM_USER_GROUP_SUSPENDED
-
Group permission flag for users which are suspended by a group moderator.
-
PHORUM_USER_GROUP_UNAPPROVED
-
Group permission flag for users which are not yet approved by a group moderator.
-
PHORUM_USER_INACTIVE
-
User status, indicating that the user has been deactivated.
-
PHORUM_USER_PENDING_BOTH
-
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
-
User status, indicating that the user has not yet confirmed the registration by email.
-
PHORUM_USER_PENDING_MOD
-
User status, indicating that the registration has not yet been approved by a user moderator.