SSL_NEVER
SSL_NEVER
Provides the base functionality shared by all Horde applications.
debug(mixed $event = null, string $fname = null, boolean $backtrace = true)
Debug method. Allows quick shortcut to produce debug output into a temporary file.
| mixed | $event | Item to log. |
| string | $fname | Filename to log to. If empty, logs to 'horde_debug.txt' in the PHP temporary directory. |
| boolean | $backtrace | Include backtrace information? |
signUrl(string|\Horde_Url $url, integer $now = null) : string|\Horde_Url
Adds a signature + timestamp to a URL and returns the signed URL.
| string|\Horde_Url | $url | The URL to sign. |
| integer | $now | The timestamp at which to sign. Leave blank for generating signatures; specify when testing. |
The signed URL.
verifySignedUrl(string $data, integer $now = null) : string|boolean
Verifies a signature and timestamp on a URL.
| string | $data | The signed URL. |
| integer | $now | The current time (can override for testing). |
The URL stripped off the signature, of false if not verified.
signQueryString(mixed $queryString, integer $now = null) : mixed
Adds a signature + timestamp to a query string and returns the signed query string.
| mixed | $queryString | The query string (or Horde_Url object) to sign. |
| integer | $now | The timestamp at which to sign. Leave blank for generating signatures; specify when testing. |
The signed query string (or Horde_Url object).
verifySignedQueryString(string $data, integer $now = null) : boolean
Verifies a signature and timestamp on a query string.
| string | $data | The signed query string. |
| integer | $now | The current time (can override for testing). |
Whether or not the string was valid.
escapeJson(mixed $data, array $options = array()) : string
Do necessary escaping to output JSON.
| mixed | $data | The data to JSON-ify. |
| array | $options | Additional options:
|
The escaped string.
getDriverConfig(mixed $backend, string $type = 'sql') : array
Returns the driver parameters for the specified backend.
| mixed | $backend | The backend system (e.g. 'prefs', 'categories', 'contacts') being used. The used configuration array will be $conf[$backend]. If an array gets passed, it will be $conf[$key1][$key2]. |
| string | $type | The type of driver. If null, will not merge with base config. |
The connection parameters.
assertDriverConfig(array $params, string $driver, array $fields, string $name = null, string $file = 'conf.php', string $variable = '$conf')
Checks if all necessary parameters for a driver configuration are set and throws a fatal error with a detailed explanation how to fix this, if something is missing.
| array | $params | The configuration array with all parameters. |
| string | $driver | The key name (in the configuration array) of the driver. |
| array | $fields | An array with mandatory parameter names for this driver. |
| string | $name | The clear text name of the driver. If not specified, the application name will be used. |
| string | $file | The configuration file that should contain these settings. |
| string | $variable | The name of the configuration variable. |
url(mixed $uri, boolean $full = false, mixed $opts = array()) : \Horde_Url
Returns a session-id-ified version of $uri.
If a full URL is requested, all parameter separators get converted to "&", otherwise to "&".
| mixed | $uri | The URI to be modified (either a string or any object with a __toString() function). |
| boolean | $full | Generate a full (http://server/path/) URL. |
| mixed | $opts | Additional options. If a string/integer, it is taken to be the 'append_session' option. If an array, one of the following:
|
The URL with the session id appended (if needed).
externalUrl(string $url, boolean $tag = false) : string
Returns an external link passed through the dereferrer to strip session IDs from the referrer.
| string | $url | The external URL to link to. |
| boolean | $tag | If true, a complete tag is returned, only the url otherwise. |
The link to the dereferrer script.
link(\Horde_Url|string $url = '', string $title = '', string $class = '', string $target = '', string $onclick = '', string $title2 = '', string $accesskey = '', array $attributes = array(), boolean $escape = true) : string
Returns an anchor tag with the relevant parameters
| \Horde_Url|string | $url | The full URL to be linked to. |
| string | $title | The link title/description. |
| string | $class | The CSS class of the link. |
| string | $target | The window target to point to. |
| string | $onclick | JavaScript action for the 'onclick' event. |
| string | $title2 | The link title (tooltip) (deprecated - just use $title). |
| string | $accesskey | The access key to use. |
| array | $attributes | Any other name/value pairs to add to the tag. |
| boolean | $escape | Whether to escape special characters in the title attribute. |
The full tag.
linkTooltip(string $url, string $status = '', string $class = '', string $target = '', string $onclick = '', string $title = '', string $accesskey = '', array $attributes = array()) : string
Uses DOM Tooltips to display the 'title' attribute for link() calls.
| string | $url | The full URL to be linked to |
| string | $status | The JavaScript mouse-over string |
| string | $class | The CSS class of the link |
| string | $target | The window target to point to. |
| string | $onclick | JavaScript action for the 'onclick' event. |
| string | $title | The link title (tooltip). Most not contain HTML data other than <br>, which will be converted to a linebreak. |
| string | $accesskey | The access key to use. |
| array | $attributes | Any other name/value pairs to add to the <a> tag. |
The full tag.
widget(array $params) : string
Returns an anchor sequence with the relevant parameters for a widget with accesskey and text.
| array | $params | A hash with widget options (other options will be passed as attributes to the link tag):
|
The full Title sequence.
selfUrl(boolean $script_params = false, boolean $nocache = true, boolean $full = false, boolean $force_ssl = false) : \Horde_Url
Returns a session-id-ified version of $SCRIPT_NAME resp. $PHP_SELF.
| boolean | $script_params | Include script parameters like QUERY_STRING and PATH_INFO? (Deprecated: use Horde::selfUrlParams() instead.) |
| boolean | $nocache | Include a cache-buster parameter in the URL? |
| boolean | $full | Return a full URL? |
| boolean | $force_ssl | Ignore $conf['use_ssl'] and force creation of a SSL URL? |
The requested URL.
selfUrlParams(array $opts = array()) : \Horde_Url
Create a self URL of the current page, building the parameter list from the current Horde_Variables object (or via another Variables object passed as an optional argument) rather than the original request data.
| array | $opts | Additional options:
|
The self URL.
getTempFile(string $prefix = 'Horde', boolean $delete = true, string $dir = '', boolean $secure = false, boolean $session_remove = false) : string
Creates a temporary filename for the lifetime of the script, and (optionally) registers it to be deleted at request shutdown.
| string | $prefix | Prefix to make the temporary name more recognizable. |
| boolean | $delete | Delete the file at the end of the request? |
| string | $dir | Directory to create the temporary file in. |
| boolean | $secure | If deleting file, should we securely delete the file? |
| boolean | $session_remove | Delete this file when session is destroyed? |
Returns the full path-name to the temporary file or false if a temporary file could not be created.
getAccessKey(string $label, boolean $nocheck = false, boolean $shutdown = false) : string
Returns an un-used access key from the label given.
| string | $label | The label to choose an access key from. |
| boolean | $nocheck | Don't check if the access key already has been used? |
| boolean | $shutdown | Is this called as a shutdown function? |
A single lower case character access key, or an empty string if no key can be found.
stripAccessKey(string $label) : string
Strips an access key from a label.
For multibyte charset strings the access key gets removed completely, otherwise only the underscore gets removed.
| string | $label | The label containing an access key. |
The label with the access key being stripped.
highlightAccessKey(string $label, string $accessKey) : string
Highlights an access key in a label.
| string | $label | The label to highlight the access key in. |
| string | $accessKey | The access key to highlight. |
The HTML version of the label with the access key highlighted.
getAccessKeyAndTitle(string $label, boolean $nocheck = false, boolean $return_array = false) : string
Returns the appropriate "accesskey" and "title" attributes for an HTML tag and the given label.
| string | $label | The title of an HTML element |
| boolean | $nocheck | Don't check if the access key already has been used? |
| boolean | $return_array | Return attributes as a hash? |
The title, and if appropriate, the accesskey attributes for the element.
label(string $for, string $label, string $ak = null) : string
Returns a label element including an access key for usage in conjuction with a form field. User preferences regarding access keys are respected.
| string | $for | The form field's id attribute. |
| string | $label | The label text. |
| string | $ak | The access key to use. If null a new access key will be generated. |
The html code for the label element.
getCacheUrl(string $type, array $params = array()) : \Horde_Url
Creates a URL for cached data.
| string | $type | The cache type ('app', 'css', 'js'). |
| array | $params | Optional parameters:
|
The URL to the cache page.
popupJs(string|\Horde_Url $url, array $options = array()) : string
Output the javascript needed to call the popup JS function.
| string|\Horde_Url | $url | The page to load. |
| array | $options | Additional options:
|
The javascript needed to call the popup code.
permissionDeniedError(string $app, string $perm, string $error = null)
Process a permission denied error, running a user-defined hook if necessary.
| string | $app | Application name. |
| string | $perm | Permission name. |
| string | $error | An error message to output via the notification system. |