PHP 클래스 LdapTools\DomainConfiguration

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

보호된 프로퍼티들

프로퍼티 타입 설명
$config The configuration values.
$required These values must be set for the configuration to be valid.
$yamlConfigMap Maps YAML domain config values to their array key values.

공개 메소드들

메소드 설명
__construct ( string $domainName = '' )
getBaseDn ( ) : string The base distinguished name in use.
getBindFormat ( ) : string Get the format a username should be bound as.
getConnectTimeout ( ) : integer Get the initial connection timeout value (seconds). This is how long it will wait when making the initial connection attempt to the LDAP server before it considers it unreachable/down.
getDomainName ( ) : string Get the fully qualified domain name.
getEncoding ( ) : string Get the encoding type to use.
getIdleReconnect ( ) : integer Get the elapsed time (in seconds) when an idle connection will attempt to reconnect to LDAP. A value of 0 means never.
getLazyBind ( ) : boolean Get whether or not the connection should bind on construction, or what until necessary.
getLdapOptions ( ) : array Get the array of LDAP_OPT_* constants and values that will be used when connecting.
getLdapType ( ) : string Get the LDAP type set for this domain (ie. Active Directory, OpenLDAP, etc).
getOperationInvoker ( ) : LdapTools\Operation\Invoker\LdapOperationInvokerInterface Get the operation invoker used in the LDAP connection.
getPageSize ( ) : integer Get the page size for paging operations.
getPassword ( ) : string Set the password to use when binding.
getPort ( ) : integer Get the port number to connect to.
getSchemaName ( ) : string Get the schema name set for this domain. If none is set explicitly, it will return the LDAP type name.
getServerSelection ( ) : mixed Get the server selection method to be used.
getServers ( ) : array Get the LDAP server names or IP addresses.
getUsePaging ( ) : boolean Get whether or not LDAP paging control should be used.
getUseSsl ( ) : boolean Whether SSL will be used for the connection or not.
getUseTls ( ) : boolean Get whether TLS will be used for the connection or not.
getUsername ( ) : string Get the username to use when binding.
load ( array $config ) Load a configuration from an array of values. The keys must be the same name as their YAML config names.
setBaseDn ( string $baseDn ) The base distinguished name to use (ie. "dc=example,dc=com").
setBindFormat ( string $bindFormat ) Set the format a username should be bound as.
setConnectTimeout ( $seconds ) Set the initial connection timeout value (seconds). This is how long it will wait when making the initial connection attempt to the LDAP server before it considers it unreachable/down.
setDomainName ( string $domainName ) Set the fully qualified domain name (ie. "example.com").
setEncoding ( string $encoding ) Set the encoding type to use.
setIdleReconnect ( integer $seconds ) Set the elapsed time (in seconds) when an idle connection will attempt to reconnect to LDAP. If you want to set it so an idle reconnect never happens, set the value to 0.
setLazyBind ( boolean $lazyBind ) Set whether or not the connection should bind on construction, or what until necessary.
setLdapOption ( string | integer $option, $value ) Set a specific LDAP_OPT_* constant and value.
setLdapOptions ( array $ldapOptions ) Set the LDAP_OPT_* constants to be used when connecting. This should be in the form of:
setLdapType ( string $ldapType ) Set the LDAP type for this domain.
setOperationInvoker ( LdapTools\Operation\Invoker\LdapOperationInvokerInterface $operationInvoker ) Set the operation invoker used in the LDAP connection.
setPageSize ( integer $pageSize ) Set the page size for paging operations.
setPassword ( string $password ) Set the password to use when binding.
setPort ( integer $port ) The port number to connect to.
setSchemaName ( string $schemaName ) Set the schema name to use for this domain.
setServerSelection ( $type ) Set the server selection method that should be used. Let the LdapServerPool take care of validation.
setServers ( array $servers ) Set the LDAP servers as an array of names or IP addresses.
setUsePaging ( boolean $paging ) Set whether or not LDAP paging control should be used.
setUseSsl ( boolean $useSsl ) Set whether SSL will be used for the connection or not.
setUseTls ( boolean $useTls ) Set whether TLS will be used for the connection or not.
setUsername ( string $username ) Set the username to use when binding.

보호된 메소드들

메소드 설명
isParsedConfigValid ( array $config ) : boolean Checks whether all required values for the configuration have been set.
validateInteger ( mixed $value, string $name ) : integer This is a helper since an integer could simply be passed as a string, which is still valid.

메소드 상세

__construct() 공개 메소드

public __construct ( string $domainName = '' )
$domainName string

getBaseDn() 공개 메소드

The base distinguished name in use.
public getBaseDn ( ) : string
리턴 string

getBindFormat() 공개 메소드

Get the format a username should be bound as.
public getBindFormat ( ) : string
리턴 string

getConnectTimeout() 공개 메소드

Get the initial connection timeout value (seconds). This is how long it will wait when making the initial connection attempt to the LDAP server before it considers it unreachable/down.
public getConnectTimeout ( ) : integer
리턴 integer

getDomainName() 공개 메소드

Get the fully qualified domain name.
public getDomainName ( ) : string
리턴 string

getEncoding() 공개 메소드

Get the encoding type to use.
public getEncoding ( ) : string
리턴 string

getIdleReconnect() 공개 메소드

Get the elapsed time (in seconds) when an idle connection will attempt to reconnect to LDAP. A value of 0 means never.
public getIdleReconnect ( ) : integer
리턴 integer

getLazyBind() 공개 메소드

Get whether or not the connection should bind on construction, or what until necessary.
public getLazyBind ( ) : boolean
리턴 boolean

getLdapOptions() 공개 메소드

Get the array of LDAP_OPT_* constants and values that will be used when connecting.
public getLdapOptions ( ) : array
리턴 array

getLdapType() 공개 메소드

Get the LDAP type set for this domain (ie. Active Directory, OpenLDAP, etc).
public getLdapType ( ) : string
리턴 string

getOperationInvoker() 공개 메소드

Get the operation invoker used in the LDAP connection.
public getOperationInvoker ( ) : LdapTools\Operation\Invoker\LdapOperationInvokerInterface
리턴 LdapTools\Operation\Invoker\LdapOperationInvokerInterface

getPageSize() 공개 메소드

Get the page size for paging operations.
public getPageSize ( ) : integer
리턴 integer

getPassword() 공개 메소드

Set the password to use when binding.
public getPassword ( ) : string
리턴 string

getPort() 공개 메소드

Get the port number to connect to.
public getPort ( ) : integer
리턴 integer

getSchemaName() 공개 메소드

Get the schema name set for this domain. If none is set explicitly, it will return the LDAP type name.
public getSchemaName ( ) : string
리턴 string

getServerSelection() 공개 메소드

Get the server selection method to be used.
public getServerSelection ( ) : mixed
리턴 mixed

getServers() 공개 메소드

Get the LDAP server names or IP addresses.
public getServers ( ) : array
리턴 array

getUsePaging() 공개 메소드

Get whether or not LDAP paging control should be used.
public getUsePaging ( ) : boolean
리턴 boolean

getUseSsl() 공개 메소드

Whether SSL will be used for the connection or not.
public getUseSsl ( ) : boolean
리턴 boolean

getUseTls() 공개 메소드

Get whether TLS will be used for the connection or not.
public getUseTls ( ) : boolean
리턴 boolean

getUsername() 공개 메소드

Get the username to use when binding.
public getUsername ( ) : string
리턴 string

isParsedConfigValid() 보호된 메소드

Checks whether all required values for the configuration have been set.
protected isParsedConfigValid ( array $config ) : boolean
$config array
리턴 boolean

load() 공개 메소드

Load a configuration from an array of values. The keys must be the same name as their YAML config names.
public load ( array $config )
$config array

setBaseDn() 공개 메소드

The base distinguished name to use (ie. "dc=example,dc=com").
public setBaseDn ( string $baseDn )
$baseDn string

setBindFormat() 공개 메소드

Set the format a username should be bound as.
public setBindFormat ( string $bindFormat )
$bindFormat string

setConnectTimeout() 공개 메소드

Set the initial connection timeout value (seconds). This is how long it will wait when making the initial connection attempt to the LDAP server before it considers it unreachable/down.
public setConnectTimeout ( $seconds )

setDomainName() 공개 메소드

Set the fully qualified domain name (ie. "example.com").
public setDomainName ( string $domainName )
$domainName string

setEncoding() 공개 메소드

Set the encoding type to use.
public setEncoding ( string $encoding )
$encoding string

setIdleReconnect() 공개 메소드

Set the elapsed time (in seconds) when an idle connection will attempt to reconnect to LDAP. If you want to set it so an idle reconnect never happens, set the value to 0.
public setIdleReconnect ( integer $seconds )
$seconds integer

setLazyBind() 공개 메소드

Set whether or not the connection should bind on construction, or what until necessary.
public setLazyBind ( boolean $lazyBind )
$lazyBind boolean

setLdapOption() 공개 메소드

Set a specific LDAP_OPT_* constant and value.
public setLdapOption ( string | integer $option, $value )
$option string | integer
$value

setLdapOptions() 공개 메소드

[ LDAP_OPT_* => value, ] ...where LDAP_OPT_* is either the int value of the constant, or the constant name in the form of a string.
public setLdapOptions ( array $ldapOptions )
$ldapOptions array

setLdapType() 공개 메소드

Set the LDAP type for this domain.
public setLdapType ( string $ldapType )
$ldapType string The LDAP type.

setOperationInvoker() 공개 메소드

Set the operation invoker used in the LDAP connection.
public setOperationInvoker ( LdapTools\Operation\Invoker\LdapOperationInvokerInterface $operationInvoker )
$operationInvoker LdapTools\Operation\Invoker\LdapOperationInvokerInterface

setPageSize() 공개 메소드

Set the page size for paging operations.
public setPageSize ( integer $pageSize )
$pageSize integer

setPassword() 공개 메소드

Set the password to use when binding.
public setPassword ( string $password )
$password string

setPort() 공개 메소드

The port number to connect to.
public setPort ( integer $port )
$port integer

setSchemaName() 공개 메소드

Set the schema name to use for this domain.
public setSchemaName ( string $schemaName )
$schemaName string

setServerSelection() 공개 메소드

Set the server selection method that should be used. Let the LdapServerPool take care of validation.
public setServerSelection ( $type )
$type

setServers() 공개 메소드

Set the LDAP servers as an array of names or IP addresses.
public setServers ( array $servers )
$servers array

setUsePaging() 공개 메소드

Set whether or not LDAP paging control should be used.
public setUsePaging ( boolean $paging )
$paging boolean

setUseSsl() 공개 메소드

Set whether SSL will be used for the connection or not.
public setUseSsl ( boolean $useSsl )
$useSsl boolean

setUseTls() 공개 메소드

Set whether TLS will be used for the connection or not.
public setUseTls ( boolean $useTls )
$useTls boolean

setUsername() 공개 메소드

Set the username to use when binding.
public setUsername ( string $username )
$username string

validateInteger() 보호된 메소드

This is a helper since an integer could simply be passed as a string, which is still valid.
protected validateInteger ( mixed $value, string $name ) : integer
$value mixed
$name string
리턴 integer

프로퍼티 상세

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

The configuration values.
protected $config

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

These values must be set for the configuration to be valid.
protected $required

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

Maps YAML domain config values to their array key values.
protected $yamlConfigMap