[cvs] [Wiki] changed: Doc/Dev/InjectorH4

[Jan Schneider]

jan  Thu, 03 Jun 2010 18:57:59 -0400

Modified page: http://wiki.horde.org/Doc/Dev/InjectorH4
New Revision:  1.4
Change log:  Fill in parameter descriptions

@@ -30,31 +30,31 @@
  Returns factory object with the following publicly available methods:

  $auth = getAuth([$driver, [$params]])
  > $auth = (Horde_Auth_Base)
-> $driver = (string) TODO
-> $params = (array) TODO
+> $driver = (string) The driver. Defaults to the configured driver.
+> $params = (array) Additional parameters to pass to the driver.  
Defaults to the configured parameters.

  +++ Horde_Data

  Returns factory object with the following publicly available methods:

  $data = getData([$driver, [$params]])
  > $data = (Horde_Data_Base)
-> $driver = (string) TODO
-> $params = (array) TODO
+> $driver = (string) The driver.
+> $params = (array) Driver parameters

  +++ Horde_Db

  Returns factory object with the following publicly available methods:

  $db = getDb([$app, [$type]])
  > $db = (Horde_Db_Adapter_Base)
-> $app = (string) TODO
-> $type = (string) TODO
+> $app = (string) The application. Defaults to 'horde'.
+> $type = (string) The type, i.e. the library that is providing  
parameters for an SQL driver, like 'prefs' or 'alarm'.

  $config = getConfig();
-> $config = (array)
+> $type = (string) The type, i.e. the library that is providing  
parameters for an SQL driver, like 'prefs' or 'alarm'.

  +++ Horde_Db_Pear

  Returns factory object with the following publicly available methods:
@@ -68,30 +68,31 @@
  Returns factory object with the following publicly available methods:

  $editor = getEditor($driver, [$params])
  > $editor = (Horde_Editor)
-> $driver = (string) TODO
-> $params = (array) TODO
+> $driver = (string) The editor driver, e.g. 'Ckeditor' or 'Fckeditor'.
+> $params = (array) Additional parameters to pass to the driver (will  
override Horde defaults).
+

  +++ Horde_Ldap

  Returns factory object with the following publicly available methods:

  $ldap = getLdap([$driver, [$params]])
  > $ldap = (Horde_Ldap)
-> $driver = (string) TODO
-> $params = (array) TODO
+> $app = (string) The application. Defaults to 'horde'.
+> $type = (string) The type, i.e. the library that is providing  
parameters for an SQL driver, like 'prefs' or 'alarm'.

-$config = getConfig();
-> $config = (array)
+$config = getConfig($type);
+> $type = (string) The type, i.e. the library that is providing  
parameters for an SQL driver, like 'prefs' or 'alarm'.

  +++ Horde_LoginTasks

  Returns factory object with the following publicly available methods:

  $lt = getLoginTasks($app)
  > $lt = (Horde_LoginTasks)
-> $app = (string) TODO
+> $app = (string) The current application.

  +++ Horde_Prefs_Identity

  Returns factory object with the following publicly available methods:
@@ -106,18 +107,18 @@
  Returns factory object with the following publicly available methods:

  $share = getScope([$app, [$driver]])
  > $share = (Horde_Share)
-> $app = (string) TODO
-> $driver = (array) TODO
+> $app = (string) The application scope to use, if not the current app.
+> $driver = (array) The share driver. Either empty (use default  
driver from $conf) or a driver name.

  +++ Horde_Vfs

  Returns factory object with the following publicly available methods:

  $vfs = getVfs([$scope])
  > $vfs = (VFS)
-> $scope = (string) TODO
+> $scope = (string) The vfs scope to return, usually an application name.

  $config = getVfsConfig([$name])
  > $config = (array)
-> $name = (string) TODO
+> $name = (string) The vfs scope to return, usually an application name.