StudIPUser Class Reference
Collaboration diagram for StudIPUser:
Public Member Functions | |
| __construct ($id=NULL) | |
| setUserid ($id) | |
| getSurname () | |
| getGivenname () | |
| getUserid () | |
| getPermission () | |
| getUsername () | |
| isSameUser (StudIPUser $otheruser) | |
| getAssignedRoles ($withimplicit=false) | |
| isAssignedRole ($assignedrole='') | |
Data Fields | |
| $userid | |
| $username | |
| $permission | |
| $surname | |
| $givenname | |
| $assignedroles | |
Detailed Description
User-Object which should be used in plugins
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | $id = NULL | ) |
Initialize a user object for the current user or the given user id.
Here is the call graph for this function:
Member Function Documentation
◆ getAssignedRoles()
| getAssignedRoles | ( | $withimplicit = false | ) |
Enter description here...
- Parameters
-
boolean $withimplicit
- Returns
- array
Here is the call graph for this function:
◆ getGivenname()
| getGivenname | ( | ) |
Enter description here...
- Returns
- string
◆ getPermission()
| getPermission | ( | ) |
Enter description here...
- Returns
- permission-object
◆ getSurname()
| getSurname | ( | ) |
Enter description here...
- Returns
- string
◆ getUserid()
| getUserid | ( | ) |
Enter description here...
- Returns
- string (md5)
Here is the caller graph for this function:
◆ getUsername()
| getUsername | ( | ) |
Enter description here...
- Returns
- string
◆ isAssignedRole()
| isAssignedRole | ( | $assignedrole = '' | ) |
Enter description here...
- Parameters
-
string $assignedrole
- Returns
- boolean
Here is the call graph for this function:
◆ isSameUser()
| isSameUser | ( | StudIPUser | $otheruser | ) |
checks, if this user is identical to the otheruser
- Parameters
-
StudIPUser $otheruser
- Returns
- boolean same user or not
Here is the call graph for this function:
◆ setUserid()
| setUserid | ( | $id | ) |
TODO: (mlunzena) what a bad design, the whole idea of filling a user by setting an ID smells
- Parameters
-
int $id
Here is the call graph for this function:
Here is the caller graph for this function:
Field Documentation
◆ $assignedroles
| $assignedroles |
◆ $givenname
| $givenname |
◆ $permission
| $permission |
◆ $surname
| $surname |
◆ $userid
| $userid |
◆ $username
The documentation for this class was generated from the following file:
- lib/plugins/core/StudIPUser.class.php
