Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • AbstractProxy
  • ActiveDirectoryProxy
  • Auth0Proxy
  • DatabaseProxy
  • LDAPProxy
  • ProxyFactory

Class ProxyFactory

Returns the Proxy object to be used to manage the user based on the value of $authenticateAgainst from the configuration files.

Namespace: hrm\user\proxy
Package: hrm
Located at user/proxy/ProxyFactory.php

Methods summary

public static string
# getDefaultAuthenticationMode( )

Return the default authentication mode for all users.

Return the default authentication mode for all users.

Returns

string

Default authentication mode (one of 'integrated', 'active_dir', 'ldap', auth0).

public static string
# getAuthenticationModeForUser( string $username )

Return the authentication mode for the user.

Return the authentication mode for the user.

The authentication method specified in the database is returned; if none is found, the default one specified in the configuration files. One of 'integrated', 'active_dir', 'ldap'.

Parameters

$username
name of the User to query.

Returns

string
Authentication mechanism.
public static hrm\user\proxy\DatabaseProxy|hrm\user\proxy\ActiveDirectoryProxy|hrm\user\proxy\LDAPProxy
# getProxy( string $username )

Get the configured proxy for the requested user name.

Get the configured proxy for the requested user name.

If the User with given name does not exist, or no authentication mode is specified, return the default authenticator.

Parameters

$username
Name of the User to query.

Returns

hrm\user\proxy\DatabaseProxy|hrm\user\proxy\ActiveDirectoryProxy|hrm\user\proxy\LDAPProxy
Proxy.
public static hrm\user\proxy\AbstractProxy
# getDefaultProxy( )

Get the default proxy from the configuration files.

Get the default proxy from the configuration files.

Returns

hrm\user\proxy\AbstractProxy
Proxy.
public static array
# getAllConfiguredAuthenticationModes( )

Returns the list of all configured authentication methods.

Returns the list of all configured authentication methods.

The array keys correspond to the actual authentication mode as encoded in the configuration, where the corresponding values are the human-friendly names (for display purposes).

Returns

array
List of configured authentication modes.
Huygens Remote Manager API documentation generated by ApiGen