PHP Класс LdapTools\Query\Operator\BaseOperator

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

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

Свойство Тип Описание
$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