\Horde_Registry

appInit()

appInit(string  $app, array  $args = array()) : \Horde_Registry_Application

Application bootstrap initialization.

Solves chicken-and-egg problem - need a way to init Horde environment from application without an active Horde_Registry object.

Page compression will be started (if configured).

Global variables defined:

  - $browser: Horde_Browser object
  - $cli: Horde_Cli object (if 'cli' is true)
  - $conf: Configuration array
  - $injector: Horde_Injector object
  - $language: Language
  - $notification: Horde_Notification object
  - $page_output: Horde_PageOutput object
  - $prefs: Horde_Prefs object
  - $registry: Horde_Registry object
  - $session: Horde_Session object

Parameters

  - admin: (boolean) Require authenticated user to be an admin?
           DEFAULT: false
  - authentication: (string) The type of authentication to use:
    - none: Do not authenticate
    - fallback: Attempt to authenticate; if failure, then don't auth
                (@since 2.11.0).
    - [DEFAULT]: Authenticate; on no auth redirect to login screen
  - cli: (boolean) Initialize a CLI interface. Setting this to true
         implicitly sets 'authentication' to 'none' and 'admin' and
         'nocompress' to true.
         DEFAULT: false
  - nocompress: (boolean) If set, the page will not be compressed.
                DEFAULT: false
  - nologintasks: (boolean) If set, don't perform logintasks (never
                  performed if authentication is 'none').
                  DEFAULT: false
  - nonotificationinit: (boolean) If set, don't initialize the
                        application handlers for the notification
                        system (@since 2.12.0).
  - permission: (array) The permission required by the user to access
                the page. The first element (REQUIRED) is the permission
                name. The second element (OPTION; defaults to SHOW) is
                the permission level.
  - session_cache_limiter: (string) Use this value for the session
                           cache limiter.
                           DEFAULT: Uses the value in the config.
  - session_control: (string) Special session control limitations:
    - netscape: TODO; start read/write session
    - none: Do not start a session
    - readonly: Start session readonly
    - [DEFAULT] - Start read/write session
  - test: (boolean) Is this the test script? If so, we relax several
          sanity checks and don't load things from the cache.
          DEFAULT: false
  - timezone: (boolean) Set the time zone?
              DEFAULT: false
  - user_admin: (boolean) Set authentication to an admin user?
                DEFAULT: false

Throws

\Horde_Exception

Returns

The application object.

__construct()

__construct(integer  $session_flags, array  $args = array()) 

Create a new Horde_Registry instance.

Parameters

Throws

\Horde_Exception

setAuthenticationSetting()

setAuthenticationSetting(string  $authentication) 

(Re)set the authentication parameter. Useful for requests, such as Rpc requests where we actually don't perform authentication until later in the request, but still need Horde bootstrapped early in the request. Also clears the local app/api cache since applications will probably already have been initialized during Notification polling.

Parameters

shutdown()

shutdown() 

Events to do on shutdown.

__get()

__get(  $api) 

A property call to the registry object will return a Caller object.

Parameters

__clone()

__clone() 

Clone should never be called on this object. If it is, die.

Throws

\Horde_Exception

__sleep()

__sleep() 

serialize() should never be called on this object. If it is, die.

Throws

\Horde_Exception

rebuild()

rebuild() 

Rebuild the registry configuration.

getApiInstance()

getApiInstance(string  $app, string  $type) : \Horde_Registry_Api|\Horde_Registry_Application

Retrieve an API object.

Parameters

Throws

\Horde_Exception

Returns

The API object.

listApps()

listApps(array  $filter = null, boolean  $assoc = false, integer  $perms = \Horde_Perms::SHOW) : array

Return a list of the installed and registered applications.

Parameters

Returns

List of apps registered with Horde. If no applications are defined returns an empty array.

listAllApps()

listAllApps() : array

Return a list of all applications, ignoring permissions.

Returns

List of all apps registered with Horde.

isInactive()

isInactive(string  $app) : boolean

Is the given application inactive?

Parameters

Returns

True if inactive.

listAPIs()

listAPIs() : array

Returns all available registry APIs.

Returns

The API list.

listMethods()

listMethods(string  $api = null) : array

Returns all of the available registry methods, or alternately only those for a specified API.

Parameters

Returns

The method list.

hasInterface()

hasInterface(string  $interface) : mixed

Determine if an interface is implemented by an active application.

Parameters

Returns

The application implementing $interface if we have it, false if the interface is not implemented.

hasMethod()

hasMethod(string  $method, string  $app = null) : mixed

Determine if a method has been registered with the registry.

Parameters

Returns

The application implementing $method if we have it, false if the method doesn't exist.

hasLink()

hasLink(string  $method, string  $app = null) : mixed

Determine if a link has been registered with the registry.

Parameters

Returns

The application implementing $method if we have it, false if the link method doesn't exist.

call()

call(string  $method, array  $args = array()) : mixed

Return the hook corresponding to the default package that provides the functionality requested by the $method parameter.

$method is a string consisting of "packagetype/methodname".

Parameters

Throws

\Horde_Exception

Returns

Return from method call.

callByPackage()

callByPackage(string  $app, string  $call, array  $args = array(), array  $options = array()) : mixed

Output the hook corresponding to the specific package named.

Parameters

Throws

\Horde_Exception_PushApp

Returns

Return from application call.

callAppMethod()

callAppMethod(string  $app, string  $call, array  $options = array()) : mixed

Call a private Horde application method.

Parameters

Throws

\Horde_Exception

Application methods should throw this if there is a fatal error.

\Horde_Exception_PushApp

Returns

Various.

link()

link(string  $method, array  $args = array(), mixed  $extra = '') : string

Returns the link corresponding to the default package that provides the functionality requested by the $method parameter.

Parameters

Throws

\Horde_Exception

Returns

The link for that method.

linkByPackage()

linkByPackage(string  $app, string  $call, array  $args = array(), mixed  $extra = '') : string

Returns the link corresponding to the specific package named.

Parameters

Throws

\Horde_Exception

Returns

The link for that method.

applicationFilePath()

applicationFilePath(string  $path, string  $app = null) : string

Replace any %application% strings with the filesystem path to the application.

Parameters

Throws

\Horde_Exception

Returns

The application file path.

applicationWebPath()

applicationWebPath(string  $path, string  $app = null) : string

Replace any %application% strings with the web path to the application.

Parameters

Returns

The application web path.

showService()

showService(string  $type) : boolean

TODO

Parameters

The following must be defined in Horde's menu config, or else they
won't be displayed in the menu:
'help', 'problem', 'logout', 'login', 'prefs'

Returns

True if the link is to be shown.

getServiceLink()

getServiceLink(string  $type, string  $app = null, boolean  $full = false) : \Horde_Url

Returns the URL to access a Horde service.

Parameters

Throws

\Horde_Exception

Returns

The link.

pushApp()

pushApp(string  $app, array  $options = array()) : boolean

Set the current application, adding it to the top of the Horde application stack. If this is the first application to be pushed, retrieve session information as well.

pushApp() also reads the application's configuration file and sets up its global $conf hash.

Parameters

Throws

\Horde_Exception_PushApp

Returns

Whether or not the _appStack was modified.

popApp()

popApp() : string

Remove the current app from the application stack, setting the current app to whichever app was current before this one took over.

Throws

\Horde_Exception

Returns

The name of the application that was popped.

getApp()

getApp() : string

Return the current application - the app at the top of the application stack.

Returns

The current application.

hasPermission()

hasPermission(string  $app, integer  $perms = \Horde_Perms::READ, array  $params = array()) : boolean

Check permissions on an application.

Parameters

Returns

Whether access is allowed.

importConfig()

importConfig(string  $app) 

Reads the configuration values for the given application and imports them into the global $conf variable.

Parameters

loadPrefs()

loadPrefs(string  $app = null) 

Loads the preferences for the current user for the current application and imports them into the global $prefs variable.

$app will be the active application after calling this function.

Parameters

Throws

\Horde_Exception

loadConfigFile()

loadConfigFile(string  $conf_file, mixed  $vars = null, string  $app = null) : \Horde_Registry_Loadconfig

Load a configuration file from a Horde application's config directory.

This call is cached (a config file is only loaded once, regardless of the $vars value).

Parameters

Throws

\Horde_Exception

Returns

The config object.

get()

get(string  $parameter, string  $app = null) : string

Return the requested configuration parameter for the specified application. If no application is specified, the value of the current application is used. However, if the parameter is not present for that application, the Horde-wide value is used instead.

If that is not present, we return null.

Parameters

Returns

The requested parameter, or null if it is not set.

getVersion()

getVersion(string  $app = null, boolean  $number = false) : string

Return the version string for a given application.

Parameters

Returns

The version string for the application.

hasFeature()

hasFeature(string  $id, string  $app = null) : boolean

Does the application have the queried feature?

Parameters

Returns

True if the application has the feature.

hasView()

hasView(integer  $view, string  $app = null) : boolean

Does the given application have the queried view?

Parameters

Returns

True if the view is available in the application.

setView()

setView(integer  $view = self::VIEW_BASIC) 

Set current view.

Parameters

getView()

getView() : integer

Get current view.

Returns

The view type.

getAppDrivers()

getAppDrivers(string  $app, string  $prefix) : array

Returns a list of available drivers for a library that are available in an application.

Parameters

Returns

The list of available class names.

getInitialPage()

getInitialPage(string  $app = null) : string

Query the initial page for an application - the webroot, if there is no initial_page set, and the initial_page, if it is set.

Parameters

Throws

\Horde_Exception

Returns

URL pointing to the initial page of the application.

clearAuth()

clearAuth(boolean  $destroy = true) 

Clears any authentication tokens in the current session.

Parameters

clearAuthApp()

clearAuthApp(  $app) : boolean

Clears authentication tokens for a given application in the current session.

Parameters

Returns

If false, did not remove authentication token because the application is in control of Horde's auth.

isAdmin()

isAdmin(array  $options = array()) : boolean

Is a user an administrator?

Parameters

Returns

Whether or not this is an admin user.

isAuthenticated()

isAuthenticated(array  $opts = array()) : boolean

Checks if there is a session with valid auth information. If there isn't, but the configured Auth driver supports transparent authentication, then we try that.

Parameters

Returns

Whether or not the user is authenticated.

currentProcessAuth()

currentProcessAuth() : boolean

Checks whether this process required authentication.

Returns

True if the current process required authentication.

getLogoutUrl()

getLogoutUrl(array  $options = array()) : \Horde_Url

Returns a URL to the login screen, adding the necessary logout parameters.

If no reason/msg is passed in, uses the current global authentication error message.

Parameters

Returns

The formatted URL.

downloadUrl()

downloadUrl(string  $filename, array  $params = array()) : \Horde_Url

Returns a URL to be used for downloading data.

Parameters

Returns

The download URL. This URL should be used as-is, since the filename MUST be the last parameter added to the URL.

convertUsername()

convertUsername(string  $userId, boolean  $toHorde) : string

Converts an authentication username to a unique Horde username.

Parameters

Throws

\Horde_Exception

Returns

The converted username.

getAuth()

getAuth(string  $format = null) : mixed

Returns the currently logged in user, if there is one.

Parameters

Returns

The user ID or false if no user is logged in.

passwordChangeRequested()

passwordChangeRequested() : boolean

Return whether the authentication backend requested a password change.

Returns

Whether the backend requested a password change.

getAuthCredential()

getAuthCredential(string  $credential = null, string  $app = null) : mixed

Returns the requested credential for the currently logged in user, if present.

Parameters

Returns

The requested credential, all credentials if $credential is null, or false if no user is logged in.

setAuthCredential()

setAuthCredential(mixed  $credential, string  $value = null, string  $app = null) 

Sets the requested credential for the currently logged in user.

Parameters

remoteHost()

remoteHost() : object

Returns information about the remote host.

Returns

An object with the following properties:

  - addr: (string) Remote IP address.
  - host: (string) Remote hostname (if resolvable; otherwise, this value
          is identical to 'addr').
  - proxy: (boolean) True if this user is connecting through a proxy.

setAuth()

setAuth(string  $authId, array  $credentials, array  $options = array()) 

Sets data in the session saying that authorization has succeeded, note which userId was authorized, and note when the login took place.

If a user name hook was defined in the configuration, it gets applied to the $userId at this point.

Parameters

checkExistingAuth()

checkExistingAuth(string  $app = 'horde') : boolean

Check existing auth for triggers that might invalidate it.

Parameters

Returns

Is existing auth valid?

removeUser()

removeUser(string  $userId) 

Removes a user from the authentication backend and calls all applications' removeUserData API methods.

Parameters

Throws

\Horde_Exception

removeUserData()

removeUserData(string  $user, string  $app = null) 

Removes user's application data.

Parameters

Throws

\Horde_Exception

getAuthInfo()

getAuthInfo() : array

Returns authentication metadata information.

Returns

Authentication metadata:

• authId: (string) The username used during the original auth.
• browser: (string) The remote browser string.
• change: (boolean) Is a password change requested?
• credentials: (string) The 'auth_app' entry that contains the Horde credentials.
• remoteAddr: (string) The remote IP address of the user.
• timestamp: (integer) The login time.
• userId: (string) The unique Horde username.

getAuthApps()

getAuthApps() : array

Returns the list of applications currently authenticated to.

Returns

List of authenticated applications.

getLanguageCharset()

getLanguageCharset() : string

Returns the charset for the current language.

Returns

The character set that should be used with the current locale settings.

getEmailCharset()

getEmailCharset() : string

Returns the charset to use for outgoing emails.

Returns

The preferred charset for outgoing mails based on the user's preferences and the current language.

preferredLang()

preferredLang(string  $lang = null) : string

Selects the most preferred language for the current client session.

Parameters

Returns

The selected language abbreviation.

setLanguage()

setLanguage(string  $lang = null) : string

Sets the language.

Parameters

Throws

\Horde_Exception

Returns

The current language (since 2.5.0).

setLanguageEnvironment()

setLanguageEnvironment(string  $lang = null, string  $app = null) 

Sets the language and reloads the whole NLS environment.

When setting the language, the gettext catalogs have to be reloaded too, charsets have to be updated etc. This method takes care of all this.

Parameters

setTextdomain()

setTextdomain(string  $app, string  $directory) 

Sets the gettext domain.

Parameters

setTimeZone()

setTimeZone() 

Sets the current timezone, if available.

isTest()

isTest() : boolean

Is the registry in 'test' mode?

Returns

True if in testing mode.

_loadApplications()

_loadApplications() 

Load application information from registry config files.

_cacheId()

_cacheId(string  $hash = null) 

Get the cache ID for the registry information.

Parameters

_loadApi()

_loadApi(string  $app) : \Horde_Registry_Api

Load an application's API object.

Parameters

Returns

The API object, or null if not available.

_doHasSearch()

_doHasSearch(  $method,   $app, string  $func) : mixed

Do the has*() search.

Parameters

Returns

The application implementing $method, false if it doesn't exist;

_methodLookup()

_methodLookup(string  $method) : mixed

Do a lookup of method name -> app call.

Parameters

Returns

An array containing the app and method call, or false if not found.

_pushAppError()

_pushAppError(\Exception  $e, integer  $error) 

Process Exceptions thrown when pushing app on stack.

Parameters

Throws

\Horde_Exception_PushApp

_getAuthCredentials()

_getAuthCredentials(string  $app) : mixed

Get the list of credentials for a given app.

Parameters

Returns

True, false, or the credential list.

_mapLang()

_mapLang(string  $language) : string

Maps languages with common two-letter codes (such as nl) to the full locale code (in this case, nl_NL). Returns the language unmodified if it isn't an alias.

Parameters

Returns

The mapped language code.