PHP Class LdapTools\Log\LogOperation

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

Protected Properties

Property Type Description
$domain The domain name that the log operation pertains to.
$error The error/exception message if issues were encountered during the operation.
$operation The operation type.
$start The start of the operation.
$stop The end of the operation.

Public Methods

Method Description
__construct ( LdapTools\Operation\LdapOperationInterface $operation )
getDomain ( ) : string Get the domain that this log operation pertains to.
getError ( ) : null | string The error/exception message if the operation encountered issues.
getOperation ( ) : LdapTools\Operation\LdapOperationInterface Get the LDAP operation represented for this log.
getStartTime ( ) : integer Get the time that the operation started.
getStopTime ( ) : integer Get the time that the operation stopped.
setDomain ( string $domain ) Set the domain name that this log operation pertains to.
setError ( string $error ) Set the error/exception message if issues were encountered during the LDAP operation.
setOperation ( LdapTools\Operation\LdapOperationInterface $operation ) Set the LDAP operation represented for this log.
start ( ) Signifies that the operation has started.
stop ( ) Signifies that the operation is over.

Method Details

__construct() public method

public __construct ( LdapTools\Operation\LdapOperationInterface $operation )
$operation LdapTools\Operation\LdapOperationInterface

getDomain() public method

Get the domain that this log operation pertains to.
public getDomain ( ) : string
return string

getError() public method

The error/exception message if the operation encountered issues.
public getError ( ) : null | string
return null | string

getOperation() public method

Get the LDAP operation represented for this log.
public getOperation ( ) : LdapTools\Operation\LdapOperationInterface
return LdapTools\Operation\LdapOperationInterface

getStartTime() public method

Get the time that the operation started.
public getStartTime ( ) : integer
return integer

getStopTime() public method

Get the time that the operation stopped.
public getStopTime ( ) : integer
return integer

setDomain() public method

Set the domain name that this log operation pertains to.
public setDomain ( string $domain )
$domain string

setError() public method

Set the error/exception message if issues were encountered during the LDAP operation.
public setError ( string $error )
$error string

setOperation() public method

Set the LDAP operation represented for this log.
public setOperation ( LdapTools\Operation\LdapOperationInterface $operation )
$operation LdapTools\Operation\LdapOperationInterface

start() public method

Signifies that the operation has started.
public start ( )

stop() public method

Signifies that the operation is over.
public stop ( )

Property Details

$domain protected property

The domain name that the log operation pertains to.
protected $domain

$error protected property

The error/exception message if issues were encountered during the operation.
protected $error

$operation protected property

The operation type.
protected $operation

$start protected property

The start of the operation.
protected $start

$stop protected property

The end of the operation.
protected $stop