phpDocumentor bbcode
[ class tree: bbcode ] [ index: bbcode ] [ all elements ]

Class: bbcode

Source Location: /lib/bbcode.inc.php

Class bbcode

Class Overview

Located in /lib/bbcode.inc.php [line 11]

ipbwi
   |
   --bbcode
Author(s):
  • Matthias Reuter ($LastChangedBy: matthias $)
Information Tags:
Version:  $LastChangedDate: 2008-10-30 23:45:42 +0000 (Do, 30 Okt 2008) $
Copyright:  2007-2008 IPBWI development team
Link:  http://ipbwi.com/examples/bbcode.php
Since:  2.0
License:  GNU General Public License

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ipbwi

ipbwi::$DB
ipbwi::$ips

Inherited From 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::info()
informations about the current IPBWI and PHP installation
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::updateSession()
Update Member Session Informations

Inherited From ipbwi

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

[ Top ]
Method Summary
string   bbcode2html()   converts BBCode to HTML using IPB's native parser.
string   html2bbcode()   converts HTML to BBCode using IPB's native parser.
array   listEmoticons()   List emoticons, optional limit the result to clickable emoticons only.

[ Top ]
Methods
bbcode2html  [line 37]

  string bbcode2html( string $input, [bool $smilies = true]  )

converts BBCode to HTML using IPB's native parser.

Parameters:
string   $input:  bbcode-formatted string
bool   $smilies:  set to true to parse smilies, otherwise false

API Tags:
Return:  HTML version of input
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $ipbwi->bbcode->bbcode2html('[b]test[/b]',true);

[ Top ]
html2bbcode  [line 64]

  string html2bbcode( string $input  )

converts HTML to BBCode using IPB's native parser.

Parameters:
string   $input:  html-formatted string

API Tags:
Return:  BBCode version of input
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $ipbwi->bbcode->html2bbcode('<b>test</b>');

[ Top ]
listEmoticons  [line 87]

  array listEmoticons( [bool $clickable = false]  )

List emoticons, optional limit the result to clickable emoticons only.

Parameters:
bool   $clickable:  set to true to list clickable emoticons only, otherwise set to false

API Tags:
Return:  Assoc array with Emoticons, keys 'typed', 'image'
Access:  public

Information Tags:
Author:  Foxrer
Author:  Pita <peter@randomnity.com>
Author:  Matthias Reuter
Author:  Cow <khlo@global-centre.com>
Since:  2.0
Sample:  
  1.  $ipbwi->bbcode->listEmoticons(true);

[ Top ]

Documentation generated on Mon, 02 Mar 2009 23:50:32 +0100 by phpDocumentor 1.4.0