LDAPService

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

Register an callback to invoke that defines extra methods

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Get meta-data details on a named method

Return the names of all the methods available on this object

No description

Add all the methods from an object property (which is an Extension) to this object.

Add all the methods from an object property (which is an Extension) to this object.

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

Add callback as a method.

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

No description

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).

Remove an extension from a class.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

No description

Get extra config sources for this class

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during __construct()} in {@link defineMethods().

Get an extension instance attached to this object by name.

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Get all extension instances for this specific object instance.

See get_extensions() to get all applied extension classes for this class (not the instance).

This method also provides lazy-population of the extension_instances property.

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

Get the cache object used for LDAP results. Note that the default lifetime set here is 8 hours, but you can change that by adding configuration:

SilverStripe\Core\Injector\Injector:
  Psr\SimpleCache\CacheInterface.ldap:
    constructor:
      defaultLifetime: 3600 # time in seconds

Flushes out the LDAP results cache when flush=1 is called.

Setter for gateway. Useful for overriding the gateway with a fake for testing.

Return the LDAP gateway currently in use. Can be strung together to access the underlying Zend\Ldap instance, or the PHP ldap resource itself. For example:

• Get the Zend\Ldap object: $service->getGateway()->getLdap() // Zend\Ldap\Ldap object
• Get the underlying PHP ldap resource: $service->getGateway()->getLdap()->getResource() // php resource

Checkes whether or not the service is enabled.

Authenticate the given username and password with LDAP.

Return all nodes (organizational units, containers, and domains) within the current base DN.

Return all AD groups in configured search locations, including all nested groups.

Uses groups_search_locations if defined, otherwise falls back to NULL, which tells LDAPGateway to use the default baseDn defined in the connection.

Return all member groups (and members of those, recursively) underneath a specific group DN.

Note that these get cached in-memory per-request for performance to avoid re-querying for the same results.

Get a particular AD group's data given a GUID.

Get a particular AD group's data given a DN.

Return all AD users in configured search locations, including all users in nested groups.

Uses users_search_locations if defined, otherwise falls back to NULL, which tells LDAPGateway to use the default baseDn defined in the connection.

Get a specific AD user's data given a GUID.

Get a specific AD user's data given a DN.

Get a specific user's data given an email.

Get a specific user's data given a username.

Get a username for an email.

Given a group DN, get the group membership data in LDAP.

Attempts to process the thumbnail photo for a given user and store it against a Member object. This will overwrite any old file with the same name. The filename of the photo will be set to 'thumbnailphoto-.jpg'.

At the moment only JPEG files are supported, as this is mainly to support Active Directory, which always provides the photo in a JPEG format, and always at a specific resolution.

Ensure the user is mapped to any applicable groups.

Sync a specific Group by updating it with LDAP data.

Creates a new LDAP user from the passed Member record.

Note that the Member record must have a non-empty Username field for this to work.

Creates a new LDAP group from the passed Group record.

Update the Member data back to the corresponding LDAP user object.

Ensure the user belongs to the correct groups in LDAP from their membership to local LDAP mapped SilverStripe groups.

This also removes them from LDAP groups if they've been taken out of one. It will not affect group membership of non-mapped groups, so it will not touch such internal AD groups like "Domain Users".

Add LDAP user by DN to LDAP group.

Change a members password on the AD. Works with ActiveDirectory compatible services that saves the password in the unicodePwd attribute.

Use the Zend\Ldap\Attribute::setPassword functionality to create a password in an abstract way, so it works on other LDAP directories, not just Active Directory. Ensure that the LDAP bind:ed user can change passwords and that the connection is secure.

Delete an LDAP user mapped to the Member record

A simple proxy to LDAP update operation.

A simple proxy to LDAP delete operation.

A simple proxy to LDAP copy/delete operation.

A simple proxy to LDAP add operation.

Get a logger