|
|
|
File: c:/web/jpeto2/jpeto/jpeto_usergroup.php
JPETo - James's Publishing & Editing Tool - jpeto_objects
jpeto_usergroup
jpeto_usergroup
This class provides the usergroup object
|
private class jpeto_usergroup
This class provides the usergroup object
|
| |
|
|
|
|
|
Private Field Summary |
| string |
$JpetoTypeType of current element |
| string |
$InterfaceName of the (Admin-) interface file |
| string |
$j_UserIDcurrent UserID |
| string |
$j_GroupIDcurrent GroupID |
| string |
$j_RoleIDcurrent RoleID (should be combined with jpeto_role - to be done later) |
| boolean |
$j_isEnabledUser in this Group enabled / disabled |
| array |
$Recordsetresultset of the query |
| integer |
$Pointerpointer in $Recordset |
|
|
|
Public Method Details |
jpeto_usergroup |
|
public void jpeto_usergroup( )
|
| |
Constructor for jpeto_usergroup
|
| Returns |
void |
|
isMember |
|
public boolean isMember( string $UserID, string $GroupID )
|
| |
returns true if the specified User is member of the specified Group
|
| Parameter |
|
|
|
|
| Returns |
boolean $isMember |
|
disable |
|
public boolean disable( string $UserID, string $GroupID )
|
| |
disables a user membership
|
| Parameter |
|
|
|
|
| Returns |
boolean $success |
|
enable |
|
public boolean enable( string $UserID, string $GroupID )
|
| |
enables a user membership
|
| Parameter |
|
|
|
|
| Returns |
boolean $success |
|
delete |
|
public boolean delete( string $GroupID )
|
| |
deletes a usergroup
|
| Parameter |
|
|
| Returns |
boolean $success |
|
store |
|
public boolean store( )
|
| |
stores the current usergroup
|
| Returns |
boolean $success |
|
|
Private Method Details |
get_next_enabled_user_object |
|
private string get_next_enabled_user_object( )
|
| |
returns the next enabled user in the current group as object
|
| Returns |
string $Object returns the object (as an object, not as a string... phpdoc....) |
|
get_next_user_object |
|
private string get_next_user_object( )
|
| |
returns the next user in the current group as object
|
| Returns |
string $Object returns the object (as an object, not as a string... phpdoc....) |
|
mapFields |
|
private void mapFields( array $Recordset )
|
| |
Maps the fields of the given recordset to the
class variables
|
| Parameter |
|
| array |
$Recordset |
|
|
the Recordset given to map to the variables |
|
| Returns |
void |
|
getDefaultValues |
|
private void getDefaultValues( )
|
| |
gets default Values for (not set) parameters
|
| Returns |
void |
|
debug |
|
private void debug( )
|
| |
returns the elements of the object as a html table
overwrite function debugObject in extending class
|
| Returns |
void |
|
get_next_jpeto_usergroup |
|
private void get_next_jpeto_usergroup( )
|
| |
Warning: documentation is missing.
|
| Returns |
void |
|
|
Private Field Details |
$JpetoType |
|
private string $JpetoType
>>"jpeto_usergroup"<<
Type of current element
|
|
$Interface |
|
private string $Interface
>>"jpeto_usergroup.php"<<
Name of the (Admin-) interface file
|
|
$j_UserID |
|
private string $j_UserID
>>""<<
current UserID
|
|
$j_GroupID |
|
private string $j_GroupID
>>""<<
current GroupID
|
|
$j_RoleID |
|
private string $j_RoleID
>>""<<
current RoleID (should be combined with jpeto_role - to be done later)
|
|
$j_isEnabled |
|
private boolean $j_isEnabled
>>false<<
User in this Group enabled / disabled
|
|
$Recordset |
|
private array $Recordset
>>array()<<
resultset of the query
|
|
$Pointer |
|
private integer $Pointer
>>
pointer in $Recordset
|
|
|
|
|
|
|
|
| PHPDoc 1.0beta |