PHP 클래스 LdapTools\Query\Operator\BaseOperator

저자: Chad Sikorra ([email protected])
파일 보기 프로젝트 열기: ldaptools/ldaptools 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$alias The alias this operator is associated with, if any.
$attribute The attribute name.
$convertedAliasValue The attribute value for specific aliases that were used.
$convertedValue The attribute name after any possible schema has been applied.
$converterAliasUsed Whether or not an attribute converter was used for a specific alias.
$converterUsed Whether or not an Attribute Converter was used.
$operatorSymbol The operator symbol (ie. &, |, =, <=, >=, etc)
$shouldUseConverter Whether or not a converter, if present, will be used against this operator.
$translatedAliasAttribute The attribute name for a specific alias after its schema has been applied.
$translatedAttribute The attribute name after any possible schema has been applied.
$validOperators The valid operator symbols that can be set.
$value The value for the attribute without any possible converters.

공개 메소드들

메소드 설명
getAlias ( ) : string | null Get the alias this operator is associated with. If none is assigned this will be null.
getAttribute ( ) : string | null Get the attribute.
getConvertedValue ( string | null $alias = null ) : mixed Get the converted value.
getLdapFilter ( null $alias = null ) : string
getOperatorSymbol ( ) : string Get the operator symbol in use.
getTranslatedAttribute ( string | null $alias = null ) : string | null Get the translated attribute (the attribute after the schema conversion).
getUseConverter ( ) : boolean Get whether a converter should be used or not.
getValue ( ) : mixed Get the attribute value.
getWasConverterUsed ( string | null $alias = null ) : boolean Get whether a converter was used or not.
setAlias ( $alias ) Set the alias this operator is associated with. To assign no alias set it to null.
setAttribute ( string $attribute ) Set the attribute.
setConvertedValue ( mixed $value, string | null $alias = null ) Set the converted value.
setOperatorSymbol ( $symbol ) Set the operator symbol in use.
setTranslatedAttribute ( $attribute, string | null $alias = null ) Set the translated attribute (the attribute after the schema conversion).
setUseConverter ( boolean $value ) Set whether a converter should be used or not.
setValue ( mixed $value ) Set the attribute value.
setWasConverterUsed ( boolean $value, string | null $alias = null ) Set whether a converter was used or not.
toLdapFilter ( string | null $alias = null ) : string Returns the operator translated to its LDAP filter string value.

보호된 메소드들

메소드 설명
getAttributeToQuery ( null | string $alias ) : string This will get the translated attribute or just the attribute if no schema translation was done.
getValueForQuery ( null | string $alias ) : mixed Depending on whether a converter was used, get the value that should be used for the query.
skipFilterForAlias ( string | null $alias ) : boolean Determine whether the operator should actually produce a filter (only if alias is null or matches the current one)

메소드 상세

getAlias() 공개 메소드

Get the alias this operator is associated with. If none is assigned this will be null.
public getAlias ( ) : string | null
리턴 string | null

getAttribute() 공개 메소드

Get the attribute.
public getAttribute ( ) : string | null
리턴 string | null

getAttributeToQuery() 보호된 메소드

This will get the translated attribute or just the attribute if no schema translation was done.
protected getAttributeToQuery ( null | string $alias ) : string
$alias null | string
리턴 string

getConvertedValue() 공개 메소드

Get the converted value.
public getConvertedValue ( string | null $alias = null ) : mixed
$alias string | null
리턴 mixed

getLdapFilter() 공개 메소드

사용 중단: Use the 'toLdapFilter()' method instead.
public getLdapFilter ( null $alias = null ) : string
$alias null
리턴 string

getOperatorSymbol() 공개 메소드

Get the operator symbol in use.
public getOperatorSymbol ( ) : string
리턴 string

getTranslatedAttribute() 공개 메소드

Get the translated attribute (the attribute after the schema conversion).
public getTranslatedAttribute ( string | null $alias = null ) : string | null
$alias string | null
리턴 string | null

getUseConverter() 공개 메소드

Get whether a converter should be used or not.
public getUseConverter ( ) : boolean
리턴 boolean

getValue() 공개 메소드

Get the attribute value.
public getValue ( ) : mixed
리턴 mixed

getValueForQuery() 보호된 메소드

Depending on whether a converter was used, get the value that should be used for the query.
protected getValueForQuery ( null | string $alias ) : mixed
$alias null | string
리턴 mixed

getWasConverterUsed() 공개 메소드

Get whether a converter was used or not.
public getWasConverterUsed ( string | null $alias = null ) : boolean
$alias string | null
리턴 boolean

setAlias() 공개 메소드

Set the alias this operator is associated with. To assign no alias set it to null.
public setAlias ( $alias )

setAttribute() 공개 메소드

Set the attribute.
public setAttribute ( string $attribute )
$attribute string

setConvertedValue() 공개 메소드

Set the converted value.
public setConvertedValue ( mixed $value, string | null $alias = null )
$value mixed
$alias string | null

setOperatorSymbol() 공개 메소드

Set the operator symbol in use.
public setOperatorSymbol ( $symbol )
$symbol

setTranslatedAttribute() 공개 메소드

Set the translated attribute (the attribute after the schema conversion).
public setTranslatedAttribute ( $attribute, string | null $alias = null )
$alias string | null

setUseConverter() 공개 메소드

Set whether a converter should be used or not.
public setUseConverter ( boolean $value )
$value boolean

setValue() 공개 메소드

Set the attribute value.
public setValue ( mixed $value )
$value mixed

setWasConverterUsed() 공개 메소드

Set whether a converter was used or not.
public setWasConverterUsed ( boolean $value, string | null $alias = null )
$value boolean
$alias string | null

skipFilterForAlias() 보호된 메소드

Determine whether the operator should actually produce a filter (only if alias is null or matches the current one)
protected skipFilterForAlias ( string | null $alias ) : boolean
$alias string | null
리턴 boolean

toLdapFilter() 공개 메소드

Returns the operator translated to its LDAP filter string value.
public toLdapFilter ( string | null $alias = null ) : string
$alias string | null
리턴 string

프로퍼티 상세

$alias 보호되어 있는 프로퍼티

The alias this operator is associated with, if any.
protected $alias

$attribute 보호되어 있는 프로퍼티

The attribute name.
protected $attribute

$convertedAliasValue 보호되어 있는 프로퍼티

The attribute value for specific aliases that were used.
protected $convertedAliasValue

$convertedValue 보호되어 있는 프로퍼티

The attribute name after any possible schema has been applied.
protected $convertedValue

$converterAliasUsed 보호되어 있는 프로퍼티

Whether or not an attribute converter was used for a specific alias.
protected $converterAliasUsed

$converterUsed 보호되어 있는 프로퍼티

Whether or not an Attribute Converter was used.
protected $converterUsed

$operatorSymbol 보호되어 있는 프로퍼티

The operator symbol (ie. &, |, =, <=, >=, etc)
protected $operatorSymbol

$shouldUseConverter 보호되어 있는 프로퍼티

Whether or not a converter, if present, will be used against this operator.
protected $shouldUseConverter

$translatedAliasAttribute 보호되어 있는 프로퍼티

The attribute name for a specific alias after its schema has been applied.
protected $translatedAliasAttribute

$translatedAttribute 보호되어 있는 프로퍼티

The attribute name after any possible schema has been applied.
protected $translatedAttribute

$validOperators 보호되어 있는 프로퍼티

The valid operator symbols that can be set.
protected $validOperators

$value 보호되어 있는 프로퍼티

The value for the attribute without any possible converters.
protected $value