/sources/ocf_topics_action.php

Description
Functions
ocf_make_topic (line 40)

Add a topic.

  • return: The ID of the newly created topic.
AUTO_LINK ocf_make_topic (?AUTO_LINK $forum_id, [SHORT_TEXT $description = ''], [SHORT_TEXT $emoticon = ''], [?BINARY $validated = NULL], [BINARY $open = 1], [BINARY $pinned = 0], [BINARY $sunk = 0], [BINARY $cascading = 0], [?MEMBER $pt_from = NULL], [?MEMBER $pt_to = NULL], [boolean $check_perms = true], [integer $num_views = 0], [?AUTO_LINK $id = NULL], [SHORT_TEXT $description_link = ''])
  • ?AUTO_LINK $forum_id: The ID of the forum the topic will be in (NULL: personal topic).
  • SHORT_TEXT $description: Description of the topic.
  • SHORT_TEXT $emoticon: The image code of the emoticon for the topic.
  • ?BINARY $validated: Whether the topic is validated (NULL: detect whether it should be).
  • BINARY $open: Whether the topic is open.
  • BINARY $pinned: Whether the topic is pinned.
  • BINARY $sunk: Whether the topic is sunk.
  • BINARY $cascading: Whether the topic is cascading.
  • ?MEMBER $pt_from: If it is a personal topic, who is it 'from' (NULL: not a personal topic).
  • ?MEMBER $pt_to: If it is a personal topic, who is it 'to' (NULL: not a personal topic).
  • boolean $check_perms: Whether to check the poster has permissions for the given topic settings.
  • integer $num_views: The number of times the topic has been viewed.
  • ?AUTO_LINK $id: Force an ID (NULL: don't force an ID)
  • SHORT_TEXT $description_link: Link related to the topic (e.g. link to view a ticket).

Documentation generated on Sun, 02 Jan 2011 23:20:16 +0000 by phpDocumentor 1.4.3