| [ Index ] |
|
Code source de eGroupWare 1.2.106-2 |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 1474 lignes (54 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 3 fichiers phpgwapi/inc/horde/Horde/Browser.php phpgwapi/inc/horde/Horde/Util.php phpgwapi/inc/horde/config/nls.php |
Horde:: (37 méthodes):
logMessage()
getLogger()
getCleanSession()
fatal()
addScriptFile()
includeScriptFiles()
inlineScriptFiles()
getServiceLink()
showService()
getDriverConfig()
getVFSConfig()
assertDriverConfig()
url()
applicationUrl()
externalUrl()
downloadUrl()
link()
widget()
selfUrl()
img()
getTempDir()
getTempFile()
compressOutput()
allowOutputCompression()
webServerID()
stylesheetLink()
setupSessionHandler()
getAccessKey()
stripAccessKey()
highlightAccessKey()
getAccessKeyAndTitle()
label()
authenticationFailureRedirect()
linkTooltip()
callHook()
initialPage()
getHordeMenu()
| logMessage($message, $file, $line, $priority = PEAR_LOG_INFO) X-Ref |
| Logs a message to the global Horde log backend. param: mixed $message Either a string or a PEAR_Error object. param: string $file What file was the log function called from param: integer $line What line was the log function called from param: integer $priority The priority of the message. One of: |
| getLogger() X-Ref |
| Pas de description |
| getCleanSession() X-Ref |
| Destroys any existing session on login and make sure to use a new session ID, to avoid session fixation issues. Should be called before checking a login. |
| fatal($error, $file, $line, $log = true) X-Ref |
| Aborts with a fatal error, displaying debug information to the user. param: mixed $error A PEAR_Error object with debug information or an param: integer $file The file in which the error occured. param: integer $line The line on which the error occured. param: boolean $log Log this message via Horde::logMesage()? |
| addScriptFile($file, $app = null, $direct = false) X-Ref |
| Adds the javascript code to the output (if output has already started) or to the list of script files to include via includeScriptFiles(). param: string $file The full javascript file name. param: string $app The application name. Defaults to the current param: boolean $direct Include the file directly without passing it |
| includeScriptFiles() X-Ref |
| Includes javascript files that were needed before any headers were sent. |
| inlineScriptFiles() X-Ref |
| Includes javascript files that were needed before any headers were sent. |
| getServiceLink($type, $app, $override = false, $referrer = true) X-Ref |
| Checks if link should be shown and return the nescessary code. param: string $type Type of link to display param: string $app The name of the current Horde application. param: boolean $override Override Horde settings? param: boolean $referrer Include the current page as the referrer (url=)? return: string The HTML to create the link. |
| showService($type) X-Ref |
param: string $type The type of link. return: boolean True if the link is to be shown. |
| getDriverConfig($backend, $type = 'sql') X-Ref |
| Returns the driver parameters for the specified backend. param: mixed $backend The backend system (e.g. 'prefs', 'categories', param: string $type The type of driver. return: array The connection parameters. |
| getVFSConfig($name) X-Ref |
| Returns the VFS driver parameters for the specified backend. param: string $name The VFS system name (e.g. 'images', 'documents') return: array A hash with the VFS parameters; the VFS driver in 'type' |
| assertDriverConfig($params, $driver, $fields, $name = null,$file = 'conf.php', $variable = '$conf') X-Ref |
| Checks if all necessary parameters for a driver configuration are set and throws a fatal error with a detailed explaination how to fix this, if something is missing. param: array $params The configuration array with all parameters. param: string $driver The key name (in the configuration array) of param: array $fields An array with mandatory parameter names for param: string $name The clear text name of the driver. If not param: string $file The configuration file that should contain param: string $variable The name of the configuration variable. |
| url($uri, $full = false, $append_session = 0, $force_ssl = false) X-Ref |
| Returns a session-id-ified version of $uri. If a full URL is requested, all parameter separators get converted to "&", otherwise to "&". param: string $uri The URI to be modified. param: bool $full Generate a full (http://server/path/) URL. param: int $append_session 0 = only if needed, 1 = always, -1 = never. return: string The URL with the session id appended (if needed). |
| applicationUrl($uri, $full = false, $append_session = 0) X-Ref |
| Returns a session-id-ified version of $uri, using the current application's webroot setting. param: string $uri The URI to be modified. param: bool $full Generate a full (http://server/path/) URL. param: int $append_session 0 = only if needed, 1 = always, -1 = never. return: string The url with the session id appended. |
| externalUrl($url, $tag = false) X-Ref |
| Returns an external link passed through the dereferer to strip session IDs from the referer. param: string $url The external URL to link to. param: boolean $tag If true, a complete <a> tag is returned, only the return: string The correct link to the dereferer script. |
| downloadUrl($filename, $params = array() X-Ref |
| Returns a URL to be used for downloading, that takes into account any special browser quirks (i.e. IE's broken filename handling). param: string $filename The filename of the download data. param: array $params Any additional parameters needed. param: string $url The URL to alter. If none passed in, will use return: string The download URL. |
| link($url, $status = '', $class = '', $target = '', $onclick = '',$title = '', $accesskey = '', $attributes = array() X-Ref |
| Returns an anchor tag with the relevant parameters param: string $url The full URL to be linked to param: string $status The JavaScript mouse-over string param: string $class The CSS class of the link param: string $target The window target to point to. param: string $onclick JavaScript action for the 'onclick' event. param: string $title The link title (tooltip). param: string $accesskey The access key to use. param: array $attributes Any other name/value pairs to add to the <a> return: string The full <a href> tag. |
| widget($url, $status = '', $class = 'widget', $target = '',$onclick = '', $title = '', $nocheck = false) X-Ref |
| Returns an anchor sequence with the relevant parameters for a widget with accesskey and text. param: string $url The full URL to be linked to param: string $status The JavaScript mouse-over string param: string $class The CSS class of the link param: string $target The window target to point to. param: string $onclick JavaScript action for the 'onclick' event. param: string $title The link title (tooltip). param: boolean $nocheck Don't check if the access key already has been return: string The full <a href>Title</a> sequence. |
| selfUrl($query_string = false, $nocache = true, $full = false,$force_ssl = false) X-Ref |
| Returns a session-id-ified version of $PHP_SELF. param: boolean $query_string Include any QUERY_STRING? param: boolean $nocache Include a nocache parameter in the URL? param: boolean $full Return a full URL? return: string The requested URI. |
| img($src, $alt = '', $attr = '', $dir = null) X-Ref |
| Constructs a correctly-pathed link to an image. param: string $src The image file. param: optional string $alt Text describing the image. param: optional mixed $attr Any additional attributes for the image tag. param: optional string $dir The root graphics directory. return: string The full image tag. |
| getTempDir() X-Ref |
| Determines the location of the system temporary directory. If a specific setting cannot be found, it defaults to /tmp. return: string A directory name which can be used for temp files. |
| getTempFile($prefix = 'Horde', $delete = true, $dir = '',$secure = false) X-Ref |
| Creates a temporary filename for the lifetime of the script, and (optionally) registers it to be deleted at request shutdown. param: string $prefix Prefix to make the temporary name more param: boolean $delete Delete the file at the end of the request? param: string $dir Directory to create the temporary file in. param: boolean $secure If deleting file, should we securely delete the return: string Returns the full path-name to the temporary file or |
| compressOutput() X-Ref |
| Starts output compression, if requested. |
| allowOutputCompression() X-Ref |
| Determines if output compression can be used. return: boolean True if output compression can be used, false if not. |
| webServerID() X-Ref |
| Returns the Web server being used. PHP string list built from the PHP 'configure' script. return: string A web server identification string. |
| stylesheetLink($apps = null, $theme = '', $inherit = true) X-Ref |
| Returns the <link> tags for the CSS stylesheets. param: string|array $app The Horde application(s). param: mixed $theme The theme to use; specify an empty value to param: boolean $inherit Inherit Horde-wide CSS? return: string <link> tags for CSS stylesheets. |
| setupSessionHandler() X-Ref |
| Sets a custom session handler up, if there is one. |
| getAccessKey($label, $nocheck = false, $shutdown = false) X-Ref |
| Returns an un-used access key from the label given. param: string $label The label to choose an access key from. param: boolean $nocheck Don't check if the access key already has been return: string A single lower case character access key or empty |
| stripAccessKey($label) X-Ref |
| Strips an access key from a label. For multibyte charset strings the access key gets removed completely, otherwise only the underscore gets removed. param: string $label The label containing an access key. return: string The label with the access key being stripped. |
| highlightAccessKey($label, $accessKey) X-Ref |
| Highlights an access key in a label. param: string $label The label to to highlight the access key in. param: string $accessKey The access key to highlight. return: string The HTML version of the label with the access key |
| getAccessKeyAndTitle($label, $nocheck = false) X-Ref |
| Returns the appropriate "accesskey" and "title" attributes for an HTML tag and the given label. param: string $label The title of an HTML element param: boolean $nocheck Don't check if the access key already has been return: string The title, and if appropriate, the accesskey attributes |
| label($for, $label, $ak = null) X-Ref |
| Returns a label element including an access key for usage in conjuction with a form field. User preferences regarding access keys are respected. param: string $for The form field's id attribute. param: string $label The label text. param: string $ak The access key to use. If null a new access key return: string The html code for the label element. |
| authenticationFailureRedirect() X-Ref |
| Redirects to the main Horde login page on authentication failure. |
| linkTooltip($url, $status = '', $class = '', $target = '',$onclick = '', $title = '', $accesskey = '',$attributes = array() X-Ref |
| Uses DOM Tooltips (via javascript) to display the 'title' attribute for Horde::link() calls. If using this function, the following function must be called: Horde::addScriptFile('tooltip.js', 'horde', true); param: string $url The full URL to be linked to param: string $status The JavaScript mouse-over string param: string $class The CSS class of the link param: string $target The window target to point to. param: string $onclick JavaScript action for the 'onclick' event. param: string $title The link title (tooltip). param: string $accesskey The access key to use. param: array $attributes Any other name/value pairs to add to the <a> return: string The full <a href> tag. |
| callHook($hook, $args = array() X-Ref |
| Provides a standardised function to call a Horde hook, checking whether a hook config file exists and whether the function itself exists. If these two conditions are not satisfied it will return the specified value (by default a PEAR error). param: string $hook The function to call. param: array $args An array of any arguments to pass to the hook param: string $app If specified look for hooks in the config directory param: mixed $error What to return if $app/config/hooks.php or $hook return: mixed Either the results of the hook or PEAR error on failure. |
| initialPage() X-Ref |
| Return the initial page to load when accessing Horde. return: string The URL of the initial page. |
| getHordeMenu() X-Ref |
| Returns an array of available menu items when in a Horde script. return: array Available menu items. |
| Généré le : Sun Feb 25 17:20:01 2007 | par Balluche grâce à PHPXref 0.7 |