Synopsis

resource plexcel_new(string $bindstr, array $options)

Description

The plexcel_new function creates a new Plexcel context for use with other Plexcel functions. A Plexcel context resource tracks binding state and context specific options with respect to authentication, LDAP routines and other Plexcel features.

The $bindstr parameter specifies a target domain controller and optionally default search parameters. The value may be one of the following.

Note: The domain name or domain of a hostname or server component of a Plexcel LDAP URL is resolved by querying DNS using SRV queries for _ldap._tcp.dc._msdcs. <domain name>, _kerberos._tcp.dc._msdcs. <domain name> and _kerberos._udp.dc._msdcs. <domain name> where <domain name> is either the name supplied, successively shorter domain name suffixes of the name supplied or, if no name was supplied, the realm of the HTTP service principal in the local credential file (the realm of the first entry in the plexcel.keytab file).

Plexcel LDAP URLs

The plexcel_new $bindstr parameter may be in the form of a Plexcel LDAP URL. The syntax of these RFC 2255 style URLs is roughly as follows:

ldap://[<server>[:port]]/[<base>][?<attrs>[?<scope>[?<filter>]]]

The server component of a Plexcel LDAP URL can be an empty string, a domain name or a hostname and is resolved using DNS SRV queries.

The base component of a Plexcel LDAP URL can be an empty string to indicate the RootDSE, a full DN or one of the following alternative base component strings.

Plexcel LDAP URL Examples

ldap:/// - The default directory server will be located using DNS SRV queries.

ldap:///RootDSE - Same as ' ldap:/// '

ldap://example.com/ - The default directory server in the example.com domain will be located using DNS SRV queries.

ldap://ad1.example.com/ - The specified server is used provided that DNS SRV queries can verify that it is listed in the example.com domain.

ldap:///CN=Hans Müller,DC=Users,DC=example,DC=com - This binds a specific user object on the local directory server.

ldap:///CN=Users,DC=example,DC=com - This specifies the Users container as the base DN.

ldap:///Users - This also specifies the Users container but it uses WKGUID binding with the Users GUID as the base DN.

ldap:///CN=Hans Müller,DC=Users,DC=example,DC=com?cn,telephoneNumber,homePhone - A search with no explicit parameters using this binding would select the cn and some phone oriented information for the specified user from the local directory server.

ldap:///Users??sub?(objectClass=user) - A search with no explicit parameters using this binding would select all attributes of all users (but not groups) in the default Users container on the local directory server.

ldap://ad1.example.com/Users??sub?(lastLogon>=128175527431758394) - This would return all users that have logged onto the specified AD server after March 5th, 2007.

Note: SID binding does not work with Windows 2000.

Returns

The plexcel_new function returns the new Plexcel context resource or FALSE to indicate an error has occurred in which case plexcel_status should be queried (with a NULL context).

Example

The following PHP fragment illustrates how to use a Plexcel LDAP URL with plexcel_new to simplify searching the directory.

<?php
// Bind the defaultNamingContext on the local directory server

        $px = plexcel_new('ldap:///DefaultNamingContext', NULL);
      
if ($px == FALSE)
    die('<pre>' . plexcel_status(NULL) . '</pre>');
} else {
    $params = array( // no need to specify base
        'scope' => 'sub',
        'filter' => '(&(objectClass=user)(logonCount=0))'
    );
    $objs = plexcel_search_objects($px, $params);
    ...

See also

plexcel_preamble