[Horde_Framework] element index

Package indexes

All elements
a b c d e f g h i l m n o p r s t u v w _
_
top
Variable $_apiCache
Registry::$_apiCache in Registry.php
Hash storing all of the known services and callbacks.
Variable $_apis
Registry::$_apis in Registry.php
The list of APIs.
Variable $_app
Horde_Config::$_app in Config.php
The name of the configured application.
Variable $_appStack
Registry::$_appStack in Registry.php
Stack of in-use applications.
Variable $_buffer
Help::$_buffer in Help.php
String buffer to hold the XML help source.
Variable $_charset
Help::$_charset in Help.php
String containing the charset of the XML data source.
Variable $_client
Instance of XML_RPC_Client object
Variable $_confCache
Registry::$_confCache in Registry.php
Cache of application configurations.
Variable $_configBegin
The line marking the begin of the generated configuration.
Variable $_configEnd
The line marking the end of the generated configuration.
Variable $_curEntry
Help::$_curEntry in Help.php
String containing the ID of the current help entry.
Variable $_currentApp
Registry::$_currentApp in Registry.php
Quick pointer to the current application.
Variable $_currentConfig
The current $conf array of the configured application.
Variable $_entries
Help::$_entries in Help.php
Hash containing an index of all of the help entries.
Variable $_files
The list of script files to add.
Variable $_fromhorde
The list of javascript files to always load from Horde.
Variable $_handlers
Help::$_handlers in Help.php
Hash of user-defined function handlers for the XML elements.
Variable $_ignored
The list of deprecated files.
Variable $_imgDir
Registry::$_imgDir in Registry.php
Cached values of the image directories.
Variable $_inBlock
Help::$_inBlock in Help.php
Boolean indicating whether we're inside the requested block.
Variable $_included
The list of files we have already included.
Variable $_inHeading
Help::$_inHeading in Help.php
Boolean indicating whether we're inside a heading block.
Variable $_inHelp
Help::$_inHelp in Help.php
Boolean indicating whether we're inside a <help> block.
Variable $_interfaces
Registry::$_interfaces in Registry.php
Hash storing all of the registered interfaces that applications provide.
Variable $_inTitle
Help::$_inTitle in Help.php
Boolean indicating whether we're inside a <title> block.
Variable $_keyword
Help::$_keyword in Help.php
String containing the keyword for the search.
Variable $_loadhordejs
Auto load horde.js/horde-prototype.js?
Variable $_mask
Menu::$_mask in Menu.php
Mask defining what general Horde links are shown in this Menu.
Variable $_menu
Menu::$_menu in Menu.php
Menu array.
Variable $_nocache
Registry::$_nocache in Registry.php
Don't update cache at end of request?
Variable $_oldConfig
The content of the old configuration file.
Variable $_output
Help::$_output in Help.php
String containing the formatted output.
Variable $_params
Local copy of config params.
Variable $_parser
Help::$_parser in Help.php
Handle for the XML parser object.
Variable $_phpConfig
The content of the generated configuration file.
Variable $_postConfig
The manual configuration after the generated configuration.
Variable $_preConfig
The manual configuration in front of the generated configuration.
Variable $_ptversions
The list of javscript files in Horde that have prototypejs'd versions.
Variable $_reqEntry
Help::$_reqEntry in Help.php
String containing the ID of the requested help entry.
Variable $_search
Help::$_search in Help.php
Hash containing an index of all of the search results.
Variable $_themeCache
Registry::$_themeCache in Registry.php
Cached values of theme information.
Variable $_typeCache
Registry::$_typeCache in Registry.php
Hash storing all known data types.
Variable $_updatecache
Registry::$_updatecache in Registry.php
Update these cache entries on shutdown.
Variable $_usecache
Registry::$_usecache in Registry.php
Are we using registry caching?
Variable $_useFormToken
Don't use form tokens for the configuration form - while generating configuration info, things like the Token system might not work correctly. This saves some headaches.
Variable $_vars
ConfigForm::$_vars in Config.php
Contains the Variables object of this form.
Variable $_versionTag
The CVS version tag of the conf.xml file which will be copied into the conf.php file.
Variable $_xmlConfig
Contains the Horde_Config object that this form represents.
Variable $_xmlConfigTree
The XML tree of the configuration file traversed to an associative array.
Method _add
Helper function to determine if given file needs to be output.
Method _fmVerify
check if freshmeat announcement was successful.
Method _listQueues
Perform a listQueue api call.
Method __call
RegistryCaller::__call() in Registry.php
Method __clone
Registry::__clone() in Registry.php
Clone should never be called on Registry objects. If it is, die.
Method __construct
Method __get
Registry::__get() in Registry.php
a
top
Variable $api
RegistryCaller::$api in Registry.php
Variable $applications
Registry::$applications in Registry.php
Hash storing information on each registry-aware application.
Method add
Adds the javascript code to the output (if output has already started) or to the list of script files to include.
Method add
Menu::add() in Menu.php
Add an item to the menu array.
Method addAppLinks
Any links to other Horde applications defined in an application's config file by the $conf['menu']['apps'] array are added to the menu array.
Method addArray
Menu::addArray() in Menu.php
Add an item to the menu array.
Method addNewVersion
Add a new version to the current modules queue.
Method addScriptFile
Adds the javascript code to the output (if output has already started) or to the list of script files to include via includeScriptFiles().
Method addSiteLinks
Add any other links found in $this->_menufile to be included in the menu.
Method addWhupsVersion
Add the new version to bugs.horde.org
Method allowOutputCompression
Determines if output compression can be used.
Method announce
announce release to mailing lists and freshmeat.
Method applicationFilePath
Replace any %application% strings with the filesystem path to the application.
Method applicationUrl
Returns a session-id-ified version of $uri, using the current application's webroot setting.
Method applicationWebPath
Replace any %application% strings with the web path to the application.
Method assertDriverConfig
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.
Method authenticationFailureRedirect
Redirects to the main Horde login page on authentication failure.
b
top
Variable $binaryDiffs
The list of binary diffs.
c
top
Variable $changelogVersion
Revision number of CHANGES file.
Method call
Registry::call() in Registry.php
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".
Method callByPackage
Output the hook corresponding to the specific package named.
Method callHook
Horde::callHook() in Horde.php
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).
Method checkArguments
Check the command-line arguments and set some internal defaults
Method checkOutFramework
Checkout and install framework
Method checkOutTag
Check out the tag we've been given to work with and move it to the
Method checkRequestToken
Check if a token for a form is valid.
Method checkSetSystem
Check the command-line arguments and set some internal defaults
Method cleanDirectories
work through the source directory given, cleaning things up by removing
Method clearCache
Registry::clearCache() in Registry.php
Clear the registry cache.
Method compressOutput
Starts output compression, if requested.
Method ConfigForm
Constructor.
Class ConfigForm
ConfigForm in Config.php
A Horde_Form:: form that implements a user interface for the config system.
Page Config.php
Config.php in Config.php
d
top
Variable $directoryName
Directory name of unpacked tarball.
Method deleteDirectory
Delete the directory given as an argument
Method diff
Horde_Release::diff() in Release.php
Make a diff of the two directories given as arguments
Method disableAutoloadHordeJS
Disable auto-loading of the horde.js script.
Method disableAutoloadHordeJS
Disable auto-loading of the horde.js script.
Method display
Help::display() in Help.php
Display the contents of the formatted output buffer.
Method downloadUrl
Returns a URL to be used for downloading, that takes into account any special browser quirks (i.e. IE's broken filename handling).
e
top
Method externalUrl
Returns an external link passed through the dereferrer to strip session IDs from the referrer.
f
top
Method fatal
Horde::fatal() in Horde.php
Aborts with a fatal error, displaying debug information to the user.
g
top
Method generatePHPConfig
Generates the content of the application's configuration file.
Method get
Registry::get() in Registry.php
Return the requested configuration parameter for the specified
Method getAccessKey
Returns an un-used access key from the label given.
Method getAccessKeyAndTitle
Returns the appropriate "accesskey" and "title" attributes for an HTML tag and the given label.
Method getApp
Registry::getApp() in Registry.php
Return the current application - the app at the top of the application stack.
Method getArguments
Get all of the command-line arguments from the user
Method getCleanSession
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.
Method getDriverConfig
Returns the driver parameters for the specified backend.
Method getImageDir
Registry::getImageDir() in Registry.php
Function to work out an application's graphics URI, taking into account any themes directories that may be set up.
Method getInitialPage
Query the initial page for an application - the webroot, if there is no initial_page set, and the initial_page, if it is set.
Method getLogger
Horde::getLogger() in Horde.php
Get an instantiated instance of the configured logger, if enabled.
Method getMailerConfig
Return the driver and parameters for the current mailer configuration.
Method getPHPConfig
Returns the file content of the current configuration file.
Method getQueueId
Look up the queue id for the requested module name.
Method getRequestToken
Get a token for protecting a form.
Method getServiceLink
Checks if link should be shown and return the necessary code.
Method getSignature
Registry::getSignature() in Registry.php
Returns a method's signature.
Method getStylesheets
Return the list of base stylesheets to display.
Method getTempDir
Horde::getTempDir() in Horde.php
Determines the location of the system temporary directory. If a specific setting cannot be found, it defaults to /tmp.
Method getTempFile
Creates a temporary filename for the lifetime of the script, and (optionally) registers it to be deleted at request shutdown.
Method getVFSConfig
Returns the VFS driver parameters for the specified backend.
h
top
Variable $hordeVersionString
Major version number of Horde compatible to this release.
Method hasInterface
Registry::hasInterface() in Registry.php
Determine if an interface is implemented by an active application.
Method hasMethod
Registry::hasMethod() in Registry.php
Determine if a method has been registered with the registry.
Method hasPermission
Check permissions on an application.
Method hasPermission
Returns the specified permission for the current user.
Method Help
Help::Help() in Help.php
Constructor
Class Help
Help in Help.php
The Help:: class provides an interface to the online help subsystem.
Constant HELP_SOURCE_FILE
HELP_SOURCE_FILE in Help.php
Help text is in a file.
Constant HELP_SOURCE_RAW
HELP_SOURCE_RAW in Help.php
Raw help in the string.
Method highlightAccessKey
Highlights an access key in a label.
Class Horde
Horde in Horde.php
The Horde:: class provides the functionality shared by all Horde applications.
Page Help.php
Help.php in Help.php
Page Horde.php
Horde.php in Horde.php
Method Horde_Config
Constructor.
Class Horde_Config
Horde_Config in Config.php
The Config:: package provides a framework for managing the configuration of Horde applications, writing conf.php files from conf.xml source files, generating user interfaces, etc.
Constant HORDE_MENU_MASK_ALL
Constant HORDE_MENU_MASK_HELP
Constant HORDE_MENU_MASK_LOGIN
Constant HORDE_MENU_MASK_NONE
Constant HORDE_MENU_MASK_PREFS
Constant HORDE_MENU_MASK_PROBLEM
Constant HORDE_MENU_POS_LAST
Class Horde_Release
Horde_Release in Release.php
Class to make an "official" Horde or application release.
Method Horde_Release
Load the configuration
Class Horde_Release_Whups
Horde_Release_Whups in Release.php
Class for interfacing with the tickets api
Method Horde_Release_Whups
Class Horde_Script_Files
Horde_Script_Files in Horde.php
The Horde_Script_Files:: class provides a coherent way to manage script files for inclusion in Horde output. This class is meant to be used internally by Horde:: only.
Constant HORDE_SESSION_NONE
HORDE_SESSION_NONE in Registry.php
Do not start a session.
Constant HORDE_SESSION_READONLY
HORDE_SESSION_READONLY in Registry.php
Do not write changes to session.
i
top
Method img
Horde::img() in Horde.php
Constructs a correctly-pathed link to an image.
Method importConfig
Registry::importConfig() in Registry.php
Reads the configuration values for the given application and imports them into the global $conf variable.
Method includeFiles
Includes javascript files that are needed before any headers are sent.
Method includeScriptFiles
Includes javascript files that were needed before any headers were sent.
Page install-packages.php
install-packages.php in install-packages.php
Method isSelected
Menu::isSelected() in Menu.php
Checks to see if the current url matches the given url.
l
top
Variable $latest
Horde_Release::$latest in Release.php
Whether or not this is a final release version.
Method label
Horde::label() in Horde.php
Returns a label element including an access key for usage in conjuction with a form field. User preferences regarding access keys are respected.
Method link
Help::link() in Help.php
Generates the HTML link that will pop up a help window for the requested topic.
Method link
Registry::link() in Registry.php
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".
Method link
Horde::link() in Horde.php
Returns an anchor tag with the relevant parameters
Method linkByPackage
Output the hook corresponding to the specific package named.
Method linkTooltip
Uses DOM Tooltips to display the 'title' attribute for Horde::link() calls.
Method listAPIs
Registry::listAPIs() in Registry.php
Returns all available registry APIs.
Method listApps
Registry::listApps() in Registry.php
Return a list of the installed and registered applications.
Method listFiles
Prepares the list of javascript files to include.
Method listMethods
Registry::listMethods() in Registry.php
Returns all of the available registry methods, or alternately only those for a specified API.
Method listScriptFiles
Provide a list of script files to be included in the current page.
Method listTypes
Registry::listTypes() in Registry.php
Returns all of the available registry data types.
Method loadConfiguration
Loads global and vhost specific configuration files.
Method loadPrefs
Registry::loadPrefs() in Registry.php
Loads the preferences for the current user for the current application and imports them into the global $prefs variable.
Method logMessage
Horde::logMessage() in Horde.php
Logs a message to the global Horde log backend.
Method lookup
Help::lookup() in Help.php
Looks up the requested entry in the XML help buffer.
m
top
Variable $makeDiff
Whether or not to create a patch file.
Page Menu.php
Menu.php in Menu.php
Method makeTarball
tar and gzip the directory given as an argument
Method Menu
Menu::Menu() in Menu.php
Constructor
Class Menu
Menu in Menu.php
The Menu:: class provides standardized methods for creating menus in Horde applications.
n
top
Variable $newSourceVersionString
Version number of next release.
Variable $newSourceVersionStringPlain
Version number of next release for docs/CHANGES.
o
top
Variable $oldChangelogVersion
Revision number of previous CHANGES file.
Variable $oldDirectoryName
Directory name of unpacked previous tarball.
Variable $oldHordeVersionString
Major version number of Horde compatible to the previous release.
Variable $oldSourceVersionString
Version number of previous release.
Variable $oldTagVersionString
CVS tag of previous release.
Variable $oldVersion
Whether or not we have an old version to compare against.
Variable $options
Default options.
p
top
Variable $patchMD5
MD5 sum of the patch file.
Variable $patchName
Filename of the gzip'ed patch file (without .gz extension).
Method popApp
Registry::popApp() in Registry.php
Remove the current app from the application stack, setting the current app to whichever app was current before this one took over.
Method print_usage
Show people how to use the damned thing
Method pushApp
Registry::pushApp() in Registry.php
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.
r
top
Variable $registry
Page Registry.php
Registry.php in Registry.php
Page Release.php
Release.php in Release.php
Method readXMLConfig
Reads the application's conf.xml file and builds an associative array from its XML tree.
Class Registry
Registry in Registry.php
The Registry:: class provides a set of methods for communication between Horde applications and keeping track of application configuration information.
Class RegistryCaller
RegistryCaller in Registry.php
Method render
Menu::render() in Menu.php
Return the unordered list representing the list of menu items. Styling is done through CSS.
s
top
Variable $sourceVersionString
Version number of release.
Method saveChangelog
get and save the revision number of the CHANGES file
Method search
Help::search() in Help.php
Returns a hash of all of the topics in this help buffer containing the keyword specified.
Method selfUrl
Horde::selfUrl() in Horde.php
Returns a session-id-ified version of $SCRIPT_NAME resp. $PHP_SELF.
Method setPosition
Method setupSessionHandler
Sets a custom session handler up, if there is one.
Method setVersionStrings
Set the version strings to use given the arguments
Method showService
Method signQueryString
Add a signature + timestamp to a query string and return the signed query string.
Method singleton
Singleton.
Method singleton
Registry::singleton() in Registry.php
Returns a reference to the global Registry object, only creating it if it doesn't already exist.
Method stripAccessKey
Strips an access key from a label.
Method stylesheetLink
Returns the <link> tags for the CSS stylesheets.
t
top
Variable $tagVersionString
CVS tag of release.
Variable $tarballMD5
MD5 sum of the tarball.
Variable $tarballName
Filename of the tarball.
Variable $ticketVersion
Version string to use in Whups
Variable $ticketVersionDesc
Version description to use in Whups
Method tagSource
Label all of the source here with the new label given as an argument
Method test
Horde_Release::test() in Release.php
Do testing (development only)
Method topics
Help::topics() in Help.php
Returns a hash of all of the topics in this help buffer.
u
top
Method unloadPrefs
Registry::unloadPrefs() in Registry.php
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.
Method updateSentinel
Update the CHANGES file with the new version number
Method updateVersionFile
Change the version file for the module in the directory specified to
Method upload
Upload tarball to the FTP server
Method url
Horde::url() in Horde.php
Returns a session-id-ified version of $uri.
v
top
Method verifySignedQueryString
Verify a signature and timestamp on a query string.
w
top
Method webServerID
Returns the Web server being used.
Method widget
Horde::widget() in Horde.php
Returns an anchor sequence with the relevant parameters for a widget with accesskey and text.
a b c d e f g h i l m n o p r s t u v w _