Docs for page base.php

Description

This script implements basic API functionality.

The functionality of this script is shared between all other API scripts. If you include any of the other API scripts in your code, then this script should be included as well.

copyright: 2007, Phorum Development Team
license: Phorum

Constants

PHORUM_ERRNO_ERROR = 1 (line 47)

A general purpose errno value, mostly used for returning a generic errno with a specific error message.

PHORUM_ERRNO_INTEGRITY = 4 (line 62)

An errno value, which indicates a database integrity problem.

PHORUM_ERRNO_INVALIDINPUT = 5 (line 67)

An errno value, which indicates invalid input data.

PHORUM_ERRNO_NOACCESS = 2 (line 52)

An errno value, which indicates a permission problem.

PHORUM_ERRNO_NOTFOUND = 3 (line 57)

An errno value, which indicates that something was not found.

Functions

phorum_api_errno (line 124)

Retrieve the error code for the last Phorum API function that was called.

return: The error code or NULL if no error was set.

mixed phorum_api_errno ()

phorum_api_error_set (line 100)

Set a Phorum API error.

return: This function will always return FALSE as its return value, so a construction like "return phorum_api_error_set(...)" can be used for setting an error and returning FALSE at the same time.

bool phorum_api_error_set (integer $errno, [string $error = NULL])

integer $errno: The errno value for the error that occurred. There are several specific errno values available, but for a generic error message that does not need a specific errno, PHORUM_ERRNO_ERROR can be used.
string $error: This is the error message, describing the error that occurred. if this parameter is omitted or NULL, then the message will be set to a generic message for the $errno that was used.

phorum_api_strerror (line 141)

Retrieve the error message for the last Phorum API function that was called.

return: The error message or NULL if no error was set.

mixed phorum_api_strerror ()

/base.php