[ Index ]
 

Code source de eGroupWare 1.2.106-2

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/phpgwapi/inc/horde/Horde/ -> Registry.php (sommaire)

(pas de description)

Poids: 1028 lignes (34 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

Registry:: (27 méthodes):
  singleton()
  Registry()
  listApps()
  listAPIs()
  listMethods()
  listTypes()
  getSignature()
  hasInterface()
  hasMethod()
  call()
  callByPackage()
  link()
  linkByPackage()
  applicationFilePath()
  applicationWebPath()
  pushApp()
  popApp()
  getApp()
  hasPermission()
  importConfig()
  loadPrefs()
  unloadPrefs()
  get()
  getImageDir()
  _getIcon()
  getInitialPage()
  _fillAPICache()


Classe: Registry  - X-Ref

The Registry:: class provides a set of methods for communication
between Horde applications and keeping track of application
configuration information.

$Horde: framework/Horde/Horde/Registry.php,v 1.249 2005/02/14 18:00:59 jan Exp $

Copyright 1999-2005 Chuck Hagenbuch <chuck@horde.org>
Copyright 1999-2005 Jon Parise <jon@horde.org>
Copyright 1999-2005 Anil Madhavapeddy <anil@recoil.org>

See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

singleton($session_flags = 0)   X-Ref
Returns a reference to the global Registry object, only
creating it if it doesn't already exist.

This method must be invoked as: $registry = &Registry::singleton()

param: optional integer $session_flags  Any session flags.
return: object Registry  The Horde Registry instance.

Registry($session_flags = 0)   X-Ref
Create a new registry instance. Should never be called except
by &Registry::singleton().

param: optional integer $session_flags  Any session flags.

listApps($filter = null, $assoc = false, $permission = PERMS_SHOW)   X-Ref
Return a list of the installed and registered applications.

param: array   $filter      (optional) An array of the statuses that
param: boolean $assoc       (optional) Associative array with app names
param: integer $permission  (optional) The permission level to check
return: array  List of apps registered with Horde. If no

listAPIs()   X-Ref
Returns all available registry APIs.

return: array  The API list.

listMethods($api = null)   X-Ref
Returns all of the available registry methods, or alternately
only those for a specified API.

param: optional string $api  Defines the API for which the methods
return: array  The method list.

listTypes()   X-Ref
Returns all of the available registry data types.

return: array  The data type list.

getSignature($method)   X-Ref
Returns a method's signature.

param: string $method  The full name of the method to check for.
return: array  A two dimensional array. The first element contains an

hasInterface($interface)   X-Ref
Determine if an interface is implemented by an active
application.

param: string $interface  The interface to check for.
return: mixed  The application implementing $interface if we have it,

hasMethod($method, $app = null)   X-Ref
Determine if a method has been registered with the registry.

param: string  $method      The full name of the method to check for.
param: string  $app         (optional) Only check this application.
return: mixed  The application implementing $method if we have it,

call($method, $args = array()   X-Ref
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".

param: string $method        The method to call.
param: optional array $args  Arguments to the method.
return: TODO

callByPackage($app, $call, $args = array()   X-Ref
Output the hook corresponding to the specific package named.

param: string $app           The application being called.
param: string $call          The method to call.
param: optional array $args  Arguments to the method.
return: TODO

link($method, $args = array()   X-Ref
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".

param: string $method         The method to link to.
param: optional array $args   Arguments to the method.
param: optional mixed $extra  Extra, non-standard arguments to the
return: TODO

linkByPackage($app, $call, $args = array()   X-Ref
Output the hook corresponding to the specific package named.

param: string $app            The application being called.
param: string $call           The method to link to.
param: optional array $args   Arguments to the method.
param: optional mixed $extra  Extra, non-standard arguments to the
return: TODO

applicationFilePath($path, $app = null)   X-Ref
Replace any %application% strings with the filesystem path to
the application.

param: string $path          The application string.
param: optional string $app  The application being called.
return: TODO

applicationWebPath($path, $app = null)   X-Ref
Replace any %application% strings with the web path to the
application.

param: string $path          The application string.
param: optional string $app  The application being called.
return: TODO

pushApp($app, $checkPerms = true)   X-Ref
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.

param: string  $app         The name of the application to push.
param: boolean $checkPerms  (optional) Make sure that the current user
return: boolean  Whether or not the _appStack was modified.

popApp()   X-Ref
Remove the current app from the application stack, setting the
current app to whichever app was current before this one took
over.

return: string  The name of the application that was popped.

getApp()   X-Ref
Return the current application - the app at the top of the
application stack.

return: string  The current application.

hasPermission($app, $permission = PERMS_READ)   X-Ref
Check permissions on an application.

return: boolean  Whether or not access is allowed.

importConfig($app)   X-Ref
Reads the configuration values for the given application and
imports them into the global $conf variable.

param: string $app  The name of the application.
return: boolean  True on success, PEAR_Error on error.

loadPrefs($app = null)   X-Ref
Loads the preferences for the current user for the current
application and imports them into the global $prefs variable.

param: string $app  The name of the application.

unloadPrefs($app = null)   X-Ref
Unload preferences from an application or (if no application is
specified) from ALL applications. Useful when a user has logged
out but you need to continue on the same page, etc.

After unloading, if there is an application on the app stack to
load preferences from, then we reload a fresh set.

param: string $app  (optional) The application to unload prefrences for.

get($parameter, $app = null)   X-Ref
Return the requested configuration parameter for the specified
application. If no application is specified, the value of
$this->_currentApp (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.

param: string $parameter     The configuration value to retrieve.
param: optional string $app  The application to get the value for.
return: string  The requested parameter, or null if it is not set.

getImageDir($app = null)   X-Ref
Function to work out an application's graphics URI, taking into
account any themes directories that may be set up.

param: optional string $app  The application for which to get the
return: string  The image directory uri path.

_getIcon($app)   X-Ref
Returns the path to an application's icon, respecting whether the
current theme has its own icons.

param: string $app  The application for which to get the icon.

getInitialPage($app = null)   X-Ref
Query the initial page for an application - the webroot, if
there is no initial_page set, and the initial_page, if it is
set.

param: optional string $app  The name of the application.
return: string  URL pointing to the inital page of the application.

_fillAPICache()   X-Ref
Fills the registry's API cache with the available services.




Généré le : Sun Feb 25 17:20:01 2007 par Balluche grâce à PHPXref 0.7