Class: ipbwi

Source Location: /ipbwi.inc.php

Class ipbwi

Class Overview

Located in /ipbwi.inc.php [line 15]

Properties

$DB
$ips

Methods

[ Top ]

Descendants

Child Class	Description
antispam
attachment
bbcode
blog
forum
gallery
group
member
permissions
pm
poll
post
search
skin
stats
tagCloud
topic

[ Top ]

Constant Summary

DEV_TEAM
PROJECT_LEADER
TITLE
VERSION
WEBSITE

[ Top ]

Property Summary

static mixed	$ips
mixed	$DB

[ Top ]

Method Summary

static bool	addSystemMessage()	adds a system message
static true	setLang()	Set's current SDK language
static void	updateSession()	Update Member Session Informations
string	date()	Returns textual/timestamp offsetted date by board and by member offset and DST setting.
board-var-value,	getBoardVar()	gets the requested board-var
native	getLibLang()	gets the language-var from actual requested native language-bit
string	info()	informations about the current IPBWI and PHP installation
proper	makeSafe()	filtering html-strings, e.g. for db-queries
true	printSystemMessages()	prints system messages
proper	properXHTML()	filtering HTML strings

[ Top ]

Properties

static mixed $ips = null [line 23]

API Tags:

Access:

protected

[ Top ]

mixed $DB = null [line 26]

API Tags:

Access:

public

[ Top ]

Methods

static method addSystemMessage [line 269]

static bool addSystemMessage(
string
$level, string
$message, [
$location = false] 
)

adds a system message

Parameters:

string	$level:	Message-Level, common levels: Notice, Error, Hidden
string	$message:	Message-Content
	$location:

API Tags:

Return:	this function always returns true
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

[ Top ]

static method setLang [line 162]

static true setLang(
string
$lang 
)

Set's current SDK language

Parameters:

string

$lang:

language-name

API Tags:

Return:	if language was loaded, otherwise false
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

[ Top ]

static method updateSession [line 469]

static void updateSession(
)

Update Member Session Informations

API Tags:

Access:

protected

Information Tags:

Author:	Matthias Reuter
Since:	2.01

[ Top ]

date [line 429]

string date(
[int
$timeStamp = false], [string
$dateFormat = '%A, %d. %B %Y @ %T'], [int
$noBoard = false], [int
$noMember = false] 
)

Returns textual/timestamp offsetted date by board and by member offset and DST setting.

Parameters:

int	$timeStamp:	Numeric representation of the time beeing formatted
string	$dateFormat:	strftime() compliant format (see PHP manual)
int	$noBoard:	true = Offset with Board Time firstly, default = false
int	$noMember:	true = Bypass member's time offset and DST, default = false

API Tags:

Return:	formatted, localized date
Access:	public

Information Tags:

Author:	Cow <khlo@global-centre.com>
Author:	Matthias Reuter
Since:	2.0

[ Top ]

getBoardVar [line 206]

board-var-value, getBoardVar(
string
$var 
)

gets the requested board-var

Parameters:

string

$var:

board-var-name

API Tags:

Return:	returns false if not exists
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

[ Top ]

getLibLang [line 188]

native getLibLang(
[string
$var = false] 
)

gets the language-var from actual requested native language-bit

Parameters:

string

$var:

language-var-name

API Tags:

Return:	language bit or error msg
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

[ Top ]

info [line 219]

string info(
)

informations about the current IPBWI and PHP installation

API Tags:

Return:	HTML-code including the informations
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

Redefined in descendants as:

attachment::info() : get's all available informations about attachments
forum::info() : Returns information on a forum.
gallery::info()
group::info() : Returns information on a group.
member::info() : Grabs detailed information of a member.
pm::info() : Returns information on a Personal Message.
poll::info() : Returns information on a poll.
post::info() : Returns information on a post.
skin::info() : Gets information on a skin.
topic::info() : get's topic informations

[ Top ]

makeSafe [line 353]

proper makeSafe(
string
$var 
)

filtering html-strings, e.g. for db-queries

Parameters:

string

$var:

html-string

API Tags:

Return:	and safe string
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

[ Top ]

printSystemMessages [line 283]

true printSystemMessages(
[string
$level = false], [
$simple = false] 
)

prints system messages

Parameters:

string	$level:	Message-Level, common levels: Notice, Error, Hidden
	$simple:

API Tags:

Return:	HTML-Code containing requested messages
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

[ Top ]

properXHTML [line 390]

proper properXHTML(
string
$var 
)

filtering HTML strings

Parameters:

string

$var:

html-string

API Tags:

Return:	XHTML string
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0

[ Top ]

Constants

DEV_TEAM = 'Matthias Reuter, Jan Ecker' [line 19]

[ Top ]

PROJECT_LEADER = 'Matthias Reuter' [line 18]

[ Top ]

TITLE = 'IPBWI' [line 17]

[ Top ]

VERSION = '2.05' [line 16]

[ Top ]

WEBSITE = 'http://ipbwi.com/' [line 20]

[ Top ]

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

	IPBWI

[ class tree: IPBWI ] [ index: IPBWI ] [ all elements ]