MockPrincipal
extends Node
in package
implements
IPrincipal
Node class.
This is a helper class, that should aid in getting nodes setup.
Interfaces, Classes and Traits
- IPrincipal
- IPrincipal interface.
Table of Contents
- $groupMemberSet : mixed
- $groupMembership : mixed
- $name : mixed
- $principalUrl : mixed
- __construct() : mixed
- delete() : mixed
- Deletes the current node.
- getAlternateUriSet() : array<string|int, mixed>
- Returns a list of alternative urls for a principal.
- getDisplayName() : string
- Returns the displayname.
- getGroupMemberSet() : array<string|int, mixed>
- Returns the list of group members.
- getGroupMemberShip() : mixed
- getLastModified() : int
- Returns the last modification time as a unix timestamp.
- getName() : mixed
- getPrincipalUrl() : string
- Returns the full principal url.
- setGroupMemberSet() : mixed
- Sets a list of group members.
- setName() : mixed
- Renames the node.
Properties
$groupMemberSet
public
mixed
$groupMemberSet
= []
$groupMembership
public
mixed
$groupMembership
= []
$name
public
mixed
$name
$principalUrl
public
mixed
$principalUrl
Methods
__construct()
public
__construct(mixed $name, mixed $principalUrl[, array<string|int, mixed> $groupMembership = [] ][, array<string|int, mixed> $groupMemberSet = [] ]) : mixed
Parameters
- $name : mixed
- $principalUrl : mixed
- $groupMembership : array<string|int, mixed> = []
- $groupMemberSet : array<string|int, mixed> = []
Return values
mixed —delete()
Deletes the current node.
public
delete() : mixed
Tags
Return values
mixed —getAlternateUriSet()
Returns a list of alternative urls for a principal.
public
getAlternateUriSet() : array<string|int, mixed>
This can for example be an email address, or ldap url.
Return values
array<string|int, mixed> —getDisplayName()
Returns the displayname.
public
getDisplayName() : string
This should be a human readable name for the principal. If none is available, return the nodename.
Return values
string —getGroupMemberSet()
Returns the list of group members.
public
getGroupMemberSet() : array<string|int, mixed>
If this principal is a group, this function should return all member principal uri's for the group.
Return values
array<string|int, mixed> —getGroupMemberShip()
public
getGroupMemberShip() : mixed
Return values
mixed —getLastModified()
Returns the last modification time as a unix timestamp.
public
getLastModified() : int
If the information is not available, return null.
Return values
int —getName()
public
getName() : mixed
Return values
mixed —getPrincipalUrl()
Returns the full principal url.
public
getPrincipalUrl() : string
Return values
string —setGroupMemberSet()
Sets a list of group members.
public
setGroupMemberSet(array<string|int, mixed> $groupMemberSet) : mixed
If this principal is a group, this method sets all the group members. The list of members is always overwritten, never appended to.
This method should throw an exception if the members could not be set.
Parameters
- $groupMemberSet : array<string|int, mixed>
Return values
mixed —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name