forum
[ class tree: forum ] [ index: forum ] [ all elements ]
Packages:
IPBWI
antispam
attachment
bbcode
blog
forum
gallery
group
Languages
liveExample
member
mimetypes
permissions
pm
poll
post
search
skin
stats
tagCloud
topic


Files:
forum.inc.php

Classes:
ipbwi_forum

Class: ipbwi_forum

Source Location: /ipbwi/lib/forum.inc.php

Class Overview

ipbwi
   |
   --ipbwi_forum



Author(s):

  • Matthias Reuter ($LastChangedBy: matthias $)

Version:

  • $LastChangedDate: 2009-08-26 19:19:41 +0200 (Mi, 26 Aug 2009) $

Copyright:

  • 2007-2010 IPBWI development team

Methods

Inherited Constants

Class: ipbwi

ipbwi::DEV_TEAM
ipbwi::DOCS
ipbwi::PROJECT_LEADER
ipbwi::TITLE
ipbwi::VERSION
ipbwi::WEBSITE

Inherited Variables

Class: ipbwi

ipbwi::$board
ipbwi::$common
ipbwi::$DBlog
ipbwi::$ips

Inherited Methods

Class: ipbwi

ipbwi::addSystemMessage()
adds a system message
ipbwi::date()
Returns textual/timestamp offsetted date by board and by member offset and DST setting.
ipbwi::getBoardVar()
gets the requested board-var
ipbwi::getLibLang()
gets the language-var from actual requested native language-bit
ipbwi::makeSafe()
filtering html-strings, e.g. for db-queries
ipbwi::printSystemMessages()
prints system messages
ipbwi::properXHTML()
filtering HTML strings
ipbwi::setLang()
Set's current SDK language
ipbwi::sysInfo()
informations about the current IPBWI and PHP installation
ipbwi::__destruct()

Class Details

[line 11]


Tags:

author:  Matthias Reuter ($LastChangedBy: matthias $)
version:  $LastChangedDate: 2009-08-26 19:19:41 +0200 (Mi, 26 Aug 2009) $
copyright:  2007-2010 IPBWI development team
link:  http://ipbwi.com/examples/forum.php
since:  2.0
license:  GNU General Public License


[ Top ]

Class Methods

method categoryInfo [line 672]

array categoryInfo( int $catID)

Get Information on a Category



Tags:

return:  Information of category categoryid
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->categoryInfo(5);
access:  public


Parameters:

int   $catID   Unique ID of the category

[ Top ]

method catList [line 642]

array catList( )

List categories.



Tags:

return:  Board's Categories
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->catList();
access:  public


[ Top ]

method create [line 456]

long create( string $forumName, string $forumDesc, $catID, $perms, perms $forumID)

Creates a forum in the specified category



Tags:

return:  new forum's ID or false
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->create('Forumname','Forum Description',2,array('show' => '*','read' => '*','start' => '*','reply' => '*','upload' => '*','download' => '*'));
access:  public


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  

[ Top ]

method delete [line 403]

bool delete( int $forumID)

Deletes the forum with delivered forum_id including all subforums, topics, polls and posts.



Tags:

return:  true or false
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->delete(55);
access:  public


Parameters:

int   $forumID   Forum's ID

[ Top ]

method getAllSubs [line 313]

mixed getAllSubs( mixed $forums, [string $outputType = 'array'], [string $indentString = '—'], [ $indent = false], [ $selectedID = false])

Returns all subforums of the delivered forums.



Tags:

return:  List of all subforums
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->getAllSubs(array(55,22,77),'html_form');
access:  public


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  

[ Top ]

method getDownloadable [line 287]

array getDownloadable( )

Returns forums in which the current member can download in topics.



Tags:

return:  Downloadable Forum Details
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->getDownloadable();
access:  public


[ Top ]

method getPostable [line 173]

array getPostable( )

Returns forums postable in by the current member.



Tags:

return:  Postable Forum Details
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->getPostable();
access:  public


[ Top ]

method getReadable [line 135]

array getReadable( )

Returns forums readable by the current member.



Tags:

return:  Readable Forum Details
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->getReadable();
access:  public


[ Top ]

method getStartable [line 211]

array getStartable( )

Returns forums in which the current member can start new topics in.



Tags:

return:  Startable Forum Details
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->getStartable();
access:  public


[ Top ]

method getUploadable [line 249]

array getUploadable( )

Returns forums in which the current member can upload in topics.



Tags:

return:  Uploadable Forum Details
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->getUploadable();
access:  public


[ Top ]

method info [line 58]

array info( int $forumID)

Returns information on a forum.



Tags:

return:  Forum's Information.
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->info(55);
access:  public


Parameters:

int   $forumID   Forum's ID

[ Top ]

method isDownloadable [line 269]

bool isDownloadable( int $forumID)

Returns whether a forum can have downloads in topics



Tags:

return:  Forum allows downloads.
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->isDownloadable(55);
access:  public


Parameters:

int   $forumID   Forum's ID

[ Top ]

method isPostable [line 155]

bool isPostable( int $forumID)

Returns whether a forum can be posted in by the current member.



Tags:

return:  Forum is postable in
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->isPostable(55);
access:  public


Parameters:

int   $forumID   Forum's ID

[ Top ]

method isReadable [line 117]

bool isReadable( int $forumID)

Returns whether a forum can be read by the current member.



Tags:

return:  Forum is readable
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->isReadable(55);
access:  public


Parameters:

int   $forumID   Forum's ID

[ Top ]

method isStartable [line 193]

bool isStartable( int $forumID)

Returns whether a forum can start topics in.



Tags:

return:  Forum is startable in.
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->isStartable(55);
access:  public


Parameters:

int   $forumID   Forum's ID

[ Top ]

method isUploadable [line 231]

bool isUploadable( int $forumID)

Returns whether a forum can have uploads in topics



Tags:

return:  Forum allows uploads.
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->isUploadable(55);
access:  public


Parameters:

int   $forumID   Forum's ID

[ Top ]

method name2id [line 34]

int name2id( string $name)

Converts forum name to forum-ids



Tags:

return:  Forum's ID
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->forum->name2id('forumname');
access:  public


Parameters:

string   $name   Forum's Name

[ Top ]

Documentation generated on Sat, 23 Oct 2010 23:35:49 +0200 by phpDocumentor 1.4.3