Class: group

Source Location: /lib/group.inc.php

Class group

Class Overview

ipbwi
   |
   --group

Author(s):

Matthias Reuter ($LastChangedBy: matthias $)

Information Tags:

Version:	$LastChangedDate: 2008-11-08 17:17:52 +0000 (Sa, 08 Nov 2008) $
Copyright:	2007-2008 IPBWI development team
Link:	http://ipbwi.com/examples/group.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

bool	change()	Changes Member group to delivered group-id.
array	info()	Returns information on a group.
mixed	isInGroup()	Returns whether a member is in the specified group(s).

[ Top ]

Properties

Methods

change [line 70]

bool change(
int
$group, [int
$member = false], [array
$extra = false] 
)

Changes Member group to delivered group-id.

Parameters:

int	$group:	Group ID
int	$member:	Member ID. If no Member-ID is delivered, the currently logged in member will moved.
array	$extra:	secondary Group-IDs

API Tags:

Return:	true on success, otherwise false
Access:	public

Information Tags:

Author:	Matthias Reuter
Since:	2.0
Sample:	$ipbwi->group->change(5); $ipbwi->group->change(7,12,array(1,2,3,4));

[ Top ]

info [line 36]

array info(
[int
$group = false] 
)

Returns information on a group.

Parameters:

int

$group:

Group ID. If $group is ommited, the last known group (of the last member) is used.

API Tags:

Return:	Group Information
Access:	public

Information Tags:

Author:	CTiga <crouchintiga@comcast.net>
Author:	Matthias Reuter
Author:	Pita <peter@randomnity.com>
Since:	2.0
Sample:	$ipbwi->group->info(5);

Redefinition of:

ipbwi::info(): informations about the current IPBWI and PHP installation

[ Top ]

isInGroup [line 100]

mixed isInGroup(
int
$group, [int
$member = false], [bool
$extra = true] 
)

Returns whether a member is in the specified group(s).

Parameters:

int	$group:	Group ID or array of groups-ids separated with comma: 2,5,7
int	$member:	Member ID to find
bool	$extra:	Include secondary groups to test against?

API Tags:

Return:

Whether member is in group(s)

Information Tags:

Author:	Matthias Reuter
Author:	DigitalisAkujin
Author:	Pita
Author:	Cow
Since:	2.0
Sample:	$ipbwi->group->isInGroup(5); $ipbwi->group->isInGroup(7,12,true);

[ Top ]

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

	group

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