PHP Interface LdapTools\Ldif\Entry\LdifEntryInterface

Author: Chad Sikorra ([email protected])
Exibir arquivo Open project: ldaptools/ldaptools Interface Usage Examples

Public Methods

Method Description
addComment ( $comments ) Add a comment to the entry.
addControl ( LdapControl $control ) Add a control to the entry.
getComments ( ) : string[] Get the comments for the entry.
getControls ( ) : LdapControl[] Get the controls for the entry.
getDn ( ) : string Get the DN for the entry.
getLineEnding ( ) : string Get the line ending that will be used.
getLineFolding ( ) : boolean Get whether line folding should be used (lines exceeding $maxLineLength will be continued on the next line).
getMaxLineLength ( ) : integer Get the max length of a line when line folding is in use.
getType ( ) : string | null Get the LDAP object type this entry represents. See 'setType()' for more information.
setDn ( string $dn ) Set the DN for the entry.
setLineEnding ( string $lineEnding ) Set the line ending to be used. See the Ldif::LINE_ENDING constant for values.
setLineFolding ( boolean $lineFolding ) Set whether line folding should be used (lines exceeding $maxLineLength will be continued on the next line).
setMaxLineLength ( integer $maxLineLength ) Set the max length of a line when line folding is in use.
setType ( string $type ) Set the LDAP object type this entry should represent. This is a string from the schema for the domain, such as 'user', 'group', 'contact', etc. If this is not null then the schema definition is used when transforming the entry to a string/operation.
toOperation ( ) : LdapTools\Operation\LdapOperationInterface Get the LDAP operation represented by this LDIF entry.
toString ( ) : string Get the string representation of the LDIF entry.

Method Details

addComment() public method

Add a comment to the entry.
public addComment ( $comments )
$comments

addControl() public method

Add a control to the entry.
public addControl ( LdapControl $control )
$control LdapTools\Connection\LdapControl

getComments() public method

Get the comments for the entry.
public getComments ( ) : string[]
return string[]

getControls() public method

Get the controls for the entry.
public getControls ( ) : LdapControl[]
return LdapTools\Connection\LdapControl[]

getDn() public method

Get the DN for the entry.
public getDn ( ) : string
return string

getLineEnding() public method

Get the line ending that will be used.
public getLineEnding ( ) : string
return string

getLineFolding() public method

Get whether line folding should be used (lines exceeding $maxLineLength will be continued on the next line).
public getLineFolding ( ) : boolean
return boolean

getMaxLineLength() public method

Get the max length of a line when line folding is in use.
public getMaxLineLength ( ) : integer
return integer

getType() public method

Get the LDAP object type this entry represents. See 'setType()' for more information.
public getType ( ) : string | null
return string | null

setDn() public method

Set the DN for the entry.
public setDn ( string $dn )
$dn string

setLineEnding() public method

Set the line ending to be used. See the Ldif::LINE_ENDING constant for values.
public setLineEnding ( string $lineEnding )
$lineEnding string

setLineFolding() public method

Set whether line folding should be used (lines exceeding $maxLineLength will be continued on the next line).
public setLineFolding ( boolean $lineFolding )
$lineFolding boolean

setMaxLineLength() public method

Set the max length of a line when line folding is in use.
public setMaxLineLength ( integer $maxLineLength )
$maxLineLength integer

setType() public method

Set the LDAP object type this entry should represent. This is a string from the schema for the domain, such as 'user', 'group', 'contact', etc. If this is not null then the schema definition is used when transforming the entry to a string/operation.
public setType ( string $type )
$type string

toOperation() public method

Get the LDAP operation represented by this LDIF entry.
public toOperation ( ) : LdapTools\Operation\LdapOperationInterface
return LdapTools\Operation\LdapOperationInterface

toString() public method

Get the string representation of the LDIF entry.
public toString ( ) : string
return string