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

Class: ipbwi_group

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

Class Overview

ipbwi
   |
   --ipbwi_group



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

Inherited Variables

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/group.php
since:  2.0
license:  GNU General Public License


[ Top ]


Class Methods


method change [line 68]

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

Changes Member group to delivered group-id.



Tags:

return:  true on success, otherwise false
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->group->change(5);
  2.  $ipbwi->group->change(7,12,array(1,2,3,4));
access:  public


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

[ Top ]

method info [line 34]

array info( [int $group = false])

Returns information on a group.



Tags:

return:  Group Information
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->group->info(5);
access:  public


Parameters:

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

[ Top ]

method isInGroup [line 101]

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

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



Tags:

return:  Whether member is in group(s)
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->group->isInGroup(5);
  2.  $ipbwi->group->isInGroup(7,12,true);


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?

[ Top ]


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