array categoryInfo(
int
$catID
)
|
|
Get Information on a Category
Parameters:
|
int |
$catID: |
Unique ID of the category |
API Tags:
| Return: | Information of category categoryid |
| Access: | public |
Information Tags:
List categories.
API Tags:
| Return: | Board's Categories |
| Access: | public |
Information Tags:
long create(
string
$forumName, string
$forumDesc,
$catID,
$perms, perms
$forumID
)
|
|
Creates a forum in the specified category
Parameters:
|
string |
$forumName: |
Forum's name |
|
string |
$forumDesc: |
Forum's description |
|
perms |
$forumID: |
Forum's permissions as array - int $perms[startperms]: Group IDs for Start posts permission
- int $perms[replyperms]: Group IDs for Reply-To posts permission
- int $perms[readperms]: Group IDs for Read posts permission
- int $perms[uploadperms]: Group IDs for Fileupload permission
- int $perms[showperms]: Group IDs for Show permission
|
|
|
$catID: |
|
|
|
$perms: |
|
API Tags:
| Return: | new forum's ID or false |
| Access: | public |
Information Tags:
| Author: | Matthias Reuter |
| Since: | 2.0 |
| Sample: | $ipbwi->forum->create('Forumname','Forum Description',2,array('show' => '*','read' => '*','start' => '*','reply' => '*','upload' => '*','download' => '*'));
|
bool delete(
int
$forumID
)
|
|
Deletes the forum with delivered forum_id including all subforums, topics, polls and posts.
Parameters:
API Tags:
| Return: | true or false |
| Access: | public |
Information Tags:
| Author: | Matthias Reuter |
| Since: | 2.0 |
| Sample: |
|
mixed getAllSubs(
mixed
$forums, [string
$outputType = 'array'], [string
$indentString = '—'], [
$indent = false], [
$selectedID = false]
)
|
|
Returns all subforums of the delivered forums.
Parameters:
|
mixed |
$forums: |
Forum IDs as int or array |
|
string |
$outputType: |
The following output types are supported:
'html_form' to get a list of <option>-tags
'array' (default) for an array-list
'array_ids_only' for an array-list with forum IDs only
'name_id_with_indent' for an array list of names with indent according to the forum structure |
|
string |
$indentString: |
The string for indent, default is '-' |
|
|
$indent: |
|
|
|
$selectedID: |
|
API Tags:
| Return: | List of all subforums |
| Access: | public |
Information Tags:
| Author: | Matthias Reuter |
| Since: | 2.0 |
| Sample: |
|
Returns forums postable in by the current member.
API Tags:
| Return: | Postable Forum Details |
| Access: | public |
Information Tags:
Returns forums readable by the current member.
API Tags:
| Return: | Readable Forum Details |
| Access: | public |
Information Tags:
Returns forums in which the current member can start new topics in.
API Tags:
| Return: | Startable Forum Details |
| Access: | public |
Information Tags:
array info(
int
$forumID
)
|
|
Returns information on a forum.
Parameters:
API Tags:
| Return: | Forum's Information. |
| Access: | public |
Information Tags:
Redefinition of:
- ipbwi::info()
- informations about the current IPBWI and PHP installation
bool isPostable(
int
$forumID
)
|
|
Returns whether a forum can be posted in by the current member.
Parameters:
API Tags:
| Return: | Forum is postable in |
| Access: | public |
Information Tags:
bool isReadable(
int
$forumID
)
|
|
Returns whether a forum can be read by the current member.
Parameters:
API Tags:
| Return: | Forum is readable |
| Access: | public |
Information Tags:
bool isStartable(
int
$forumID
)
|
|
Returns whether a forum can start topics in.
Parameters:
API Tags:
| Return: | Forum is startable in. |
| Access: | public |
Information Tags:
int name2id(
string
$name
)
|
|
Converts forum name to forum-ids
Parameters:
|
string |
$name: |
Forum's Name |
API Tags:
| Return: | Forum's ID |
| Access: | public |
Information Tags:
| Author: | Matthias Reuter |
| Since: | 2.0 |
| Sample: |
|
