PHP Class Adldap\Models\Group

Inheritance: extends Entry, use trait Adldap\Models\Traits\HasDescriptionTrait, use trait Adldap\Models\Traits\HasMemberOfTrait
Show file Open project: adldap2/adldap2 Class Usage Examples

Public Methods

Method Description
addMember ( string | Entry $entry ) : boolean Adds an entry to the current group.
getGroupType ( ) : string Returns the group type integer.
getMemberNames ( ) : array Returns the group's member names only.
getMembers ( ) : Collection Returns all users apart of the current group.
removeMember ( string | Entry $entry ) : boolean Removes an entry from the current group.
removeMembers ( ) : boolean Removes all members from the current group.
setMembers ( array $entries ) Sets the groups members using an array of user DNs.

Protected Methods

Method Description
getMembersFromAttribute ( $attribute ) : array Retrieves group members by the specified model attribute using their distinguished name.
getPaginatedMembers ( ) : array Retrieves members that are contained in a member range.

Method Details

addMember() public method

Adds an entry to the current group.
public addMember ( string | Entry $entry ) : boolean
$entry string | Entry
return boolean

getGroupType() public method

https://msdn.microsoft.com/en-us/library/ms675935(v=vs.85).aspx
public getGroupType ( ) : string
return string

getMemberNames() public method

Returns the group's member names only.
public getMemberNames ( ) : array
return array

getMembers() public method

https://msdn.microsoft.com/en-us/library/ms677097(v=vs.85).aspx
public getMembers ( ) : Collection
return Illuminate\Support\Collection

getMembersFromAttribute() protected method

Retrieves group members by the specified model attribute using their distinguished name.
protected getMembersFromAttribute ( $attribute ) : array
$attribute
return array

getPaginatedMembers() protected method

Retrieves members that are contained in a member range.
protected getPaginatedMembers ( ) : array
return array

removeMember() public method

Removes an entry from the current group.
public removeMember ( string | Entry $entry ) : boolean
$entry string | Entry
return boolean

removeMembers() public method

Removes all members from the current group.
public removeMembers ( ) : boolean
return boolean

setMembers() public method

Sets the groups members using an array of user DNs.
public setMembers ( array $entries )
$entries array