PHP Class LdapTools\Utilities\GPOLink

Author: Chad Sikorra ([email protected])
Show file Open project: ldaptools/ldaptools Class Usage Examples

Protected Properties

Property Type Description
$gpo The GPO (name, DN, SID, or GUID)
$options The GPO options bit flags

Public Methods

Method Description
__construct ( string | LdapObject $gpo, integer $options )
__toString ( ) : string
getGpo ( ) : string | LdapObject Get the GPO for the link.
getIsEnabled ( ) : boolean Get whether the GPO link is enabled.
getIsEnforced ( ) : boolean Get whether the GPO is enforced.
getOptionsFlag ( ) : integer Get the GPO options bit flags.
setGpo ( string | LdapObject $gpo ) Set the GPO for the link.
setIsEnabled ( boolean $isEnabled ) : GPOLink Set whether the GPO link is enabled.
setIsEnforced ( boolean $isEnforced ) : GPOLink Set whether the GPO is enforced.
setOptionsFlag ( integer $options ) Set the GPO options bit flags.

Protected Methods

Method Description
isOptionFlagSet ( integer $flag ) : boolean A quick check to determine if an option flag is already set.
modifyOptions ( boolean $action, integer $int ) Modifies a specific bit in the options flag. Ignores it if it is already set to the desired action.

Method Details

__construct() public method

public __construct ( string | LdapObject $gpo, integer $options )
$gpo string | LdapTools\Object\LdapObject The GPO (name, DN, SID, GUID, or LdapObject)
$options integer The GPO options bit flags

__toString() public method

public __toString ( ) : string
return string

getGpo() public method

Get the GPO for the link.
public getGpo ( ) : string | LdapObject
return string | LdapTools\Object\LdapObject

getIsEnabled() public method

Get whether the GPO link is enabled.
public getIsEnabled ( ) : boolean
return boolean

getIsEnforced() public method

Get whether the GPO is enforced.
public getIsEnforced ( ) : boolean
return boolean

getOptionsFlag() public method

Get the GPO options bit flags.
public getOptionsFlag ( ) : integer
return integer

isOptionFlagSet() protected method

A quick check to determine if an option flag is already set.
protected isOptionFlagSet ( integer $flag ) : boolean
$flag integer
return boolean

modifyOptions() protected method

Modifies a specific bit in the options flag. Ignores it if it is already set to the desired action.
protected modifyOptions ( boolean $action, integer $int )
$action boolean
$int integer

setGpo() public method

Set the GPO for the link.
public setGpo ( string | LdapObject $gpo )
$gpo string | LdapTools\Object\LdapObject

setIsEnabled() public method

Set whether the GPO link is enabled.
public setIsEnabled ( boolean $isEnabled ) : GPOLink
$isEnabled boolean
return GPOLink

setIsEnforced() public method

Set whether the GPO is enforced.
public setIsEnforced ( boolean $isEnforced ) : GPOLink
$isEnforced boolean
return GPOLink

setOptionsFlag() public method

Set the GPO options bit flags.
public setOptionsFlag ( integer $options )
$options integer

Property Details

$gpo protected property

The GPO (name, DN, SID, or GUID)
protected $gpo

$options protected property

The GPO options bit flags
protected $options