Docs for page forums.php

## /forums.php

Description

This script implements the Phorum forum admin API.

This API is used for managing Phorum forums and folders. It can be used to retrieve information about the available forums and folders and takes care of creating and editing them.

This API combines forums and folders into one API script, because at the data level, they are the same kind of entity. Folders are also forums, only they act differently based on the "folder_flag" field. Therefore, folders are also identified by a forum_id.

- license: Phorum
- copyright: 2007, Phorum Development Team

Functions
phorum_api_admin_forums_by_folder (line 79)

Retrieve a list of all available forums within a certain folder.

- return: An array of forums, index by the their forum_id and sorted by their display order.

array phorum_api_admin_forums_by_folder ([mixed $folder_id = 0], integer $folder_id )

- integer $folder_id : The forum_id of the folder for which to retrieve the forums.

phorum_api_admin_forums_change_order (line 109)

Change the displaying order for forums and folders in a certain folder.

void phorum_api_admin_forums_change_order (mixed $folder_id, mixed $forum_id, mixed $movement, [mixed $value = NULL], integer $folder_id , integer $forum_id , string $movement , mixed $value )

- integer $folder_id : The forum_id of the folder in which to change the display order.
- integer $forum_id : The id of the forum or folder to move.
- string $movement : This field determines the type of movement to apply to the forum or folder. This can be one of:
  - "up": Move the forum or folder $value positions up
  - "down": Move the forum or folder $value permissions down
  - "pos": Move the forum or folder to position $value
  - "start": Move the forum or folder to the start of the list
  - "end": Move the forum or folder to the end of the list
- mixed $value : This field specifies a value for the requested type of movement. An integer value is only needed for movements "up", "down" and "pos". For other movements, this parameter can be omitted.

phorum_api_admin_forums_get (line 55)

Retrieve the data for one or more forums and/or folders.

- return: If the $forum_id parameter is a single forum_id, then either an array containing forum data is returned or NULL if the forum was not found. If the $forum_id parameter is an array of forum_ids, then an array of forum data arrays is returned, indexed by the forum_id and sorted by their display order. For forum_ids that are not found, no entry will be available in the returned array.

mixed phorum_api_admin_forums_get (mixed $forum_id, mixed $forum_id )

- mixed $forum_id : Either a single forum_id or an array of forum_ids.

Documentation generated on Wed, 21 Nov 2007 08:45:29 -0600 by phpDocumentor 1.3.0RC5