PHP Трейт LdapTools\Ldif\LdifStringBuilderTrait

Автор: Chad Sikorra ([email protected])
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$comments Any comments associated with the entry.
$lineEnding The line ending to use.
$lineFolding Whether or not a value should be folded (continued on the next line) if it goes past $maxLineLength
$maxLineLength The max length for a line before it is folded (if line folding is enabled).

Открытые методы

Метод Описание
addComment ( $comments ) Add a comment to be associated with this entry.
getComments ( ) : string[] Get the comments for this entry.
getLineEnding ( ) : string Get the line ending that will be used.
getLineFolding ( ) : boolean Get whether or not lines exceeding a certain length should be folded (continued on the next line)
getMaxLineLength ( ) : integer Get the max length for a line before the value is folded (continued on the next line).
setLineEnding ( string $lineEnding ) Set the line ending to be used. See the Ldif::LINE_ENDING constant for values.
setLineFolding ( boolean $lineFolding ) Set whether or not lines exceeding a certain length should be folded (continued on the next line)
setMaxLineLength ( integer $length ) Set the max length for a line before the value is folded (continued on the next line).

Защищенные методы

Метод Описание
addCommentsToString ( string $ldif ) : string Add any specified comments to the generated LDIF.
getLdifLine ( string $directive, string $value ) : string Construct a single line of the LDIF for a given directive and value.
getValueForLine ( $value ) : string Gets the value for the line while taking into account any line folding set.

Описание методов

addComment() публичный метод

Add a comment to be associated with this entry.
public addComment ( $comments )
$comments

addCommentsToString() защищенный метод

Add any specified comments to the generated LDIF.
protected addCommentsToString ( string $ldif ) : string
$ldif string
Результат string

getComments() публичный метод

Get the comments for this entry.
public getComments ( ) : string[]
Результат string[]

getLdifLine() защищенный метод

Construct a single line of the LDIF for a given directive and value.
protected getLdifLine ( string $directive, string $value ) : string
$directive string
$value string
Результат string

getLineEnding() публичный метод

Get the line ending that will be used.
public getLineEnding ( ) : string
Результат string

getLineFolding() публичный метод

Get whether or not lines exceeding a certain length should be folded (continued on the next line)
public getLineFolding ( ) : boolean
Результат boolean

getMaxLineLength() публичный метод

Get the max length for a line before the value is folded (continued on the next line).
public getMaxLineLength ( ) : integer
Результат integer

getValueForLine() защищенный метод

Gets the value for the line while taking into account any line folding set.
protected getValueForLine ( $value ) : string
$value
Результат string

setLineEnding() публичный метод

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

setLineFolding() публичный метод

Set whether or not lines exceeding a certain length should be folded (continued on the next line)
public setLineFolding ( boolean $lineFolding )
$lineFolding boolean

setMaxLineLength() публичный метод

Set the max length for a line before the value is folded (continued on the next line).
public setMaxLineLength ( integer $length )
$length integer

Описание свойств

$comments защищенное свойство

Any comments associated with the entry.
protected $comments

$lineEnding защищенное свойство

The line ending to use.
protected $lineEnding

$lineFolding защищенное свойство

Whether or not a value should be folded (continued on the next line) if it goes past $maxLineLength
protected $lineFolding

$maxLineLength защищенное свойство

The max length for a line before it is folded (if line folding is enabled).
protected $maxLineLength