hFramework

• Home
• ->Hierophant PHP Framework
• ->hFramework

The hFramework class provides the basis for the Hierophant framework.  It's similar to frameworks like jQuery, in which you are able to access the object's methods anywhere. Hierophant plugins, by default, have all of the hFramework methods available, in addition to the methods of several foundation plugins. These methods are made available through PHP5's support for method and property overloading, where you can define a catch-all magic function that catches all references to methods and properties that aren't explicitly defined.

Foundational plugins included in hFramework

Foundational plugins include essential framework functionality that do things like provide Hierophant's plugin architecture, handle the setting of HTTP headers, methods that parse and provide information about the requested path.

• hPlugin

  This plugin is an abstract class that most plugins inherit. Inheriting from this class lets you access Hierophant's various default methods and properties, in addition to accessing Hierophant's cascading framework variables.

• hPlugin Library

  This plugin provides methods that handle Hierophant's plugin architecture. It provides methods for including and executing a plugin, methods for determining a plugin's registration with the database, and methods that provide information about plugins.

• hFrameworkApplication

  This plugin provides the bare minimum of needed functionality to create a Hierophant plugin. Some plugins inherit from this object, rather than hPlugin. Which object you inherit from depends on two factors, whether you want to limit Hierophant's intrusion on the local plugin's namespace, or whether you want to use PHP5 method and property overloading in your own plugin. If either of those situations are a requirement, your plugin should inherit from hFrameworkApplication rather than hPlugin.

• hFilePath

  This plugin provides methods that handle everything to do with the path requested from the server, in addition to some utility methods that provide information about a path (any arbitrary path). This plugin provides some of the functionality required for Hierophant's cascading file system.

• hFrameworkResources

  This plugin provides methods that provide information about Hierophant resources. This plugin provides some of the functionality required for Hierophant's authentication and permissions framework.

• hHTTP

  This plugin provides methods that handle setting the HTTP headers associated with the server's response to the request path. It also provides a few utility methods associated with HTTP headers.

Plugins Included in hFramework for any content

• hUserSession

  This plugin provides PHP session functionality. It creates, or refreshes an active session upon every request, and defines custom session-handling functionality, storing session data in a database, rather than a flat file.

• hFrameworkError

  This plugin provides error-handling functionality for plugins.

• hDatabase

  This plugin provides methods that make database-related functionality easier, such as getting and saving information to a database.

• hUser Library

  This plugin provides methods that provides user-related functionality, such as user variables, getting user ids, user names, email addresses, and so on.

• hUserAuthentication Library

  This plugin provides methods that provides authentication and permissions related functionality, such as determining whether a user is logged in, a member of a group, or has access to a resource.

Plugins included in hFramework for templated HTML content

• hLanguage

  This plugin provides multi-language support. At present, multi-language support in Hierophant is only partially completed.

• hFileDocument

  This plugin provides template functionality, such as breadcrumbs, lists, HTML headers, CSS, JavaScript, in addition to some miscellaneous utility functions related to HTML templates.

• hCoreMetricsAPI

  This plugin is included if the framework variable hCoreMetricsClientID is defined. This plugin provides functionality related to the commercially available CoreMetrics web analytics service, which is a paid third-party service.

• hDatabaseBenchmark

  This plugin is included if the framework variable hDatabaseOptimize is set to true. It provides database optimization data for every query conducted during the request. The data provided by this plugin can be used to speed up database queries by identifying tables that might need indexes or primary keys, or queries that are not otherwise performing efficiently.

• hFrameworkToolbox

  This plugin is included if the user is logged in and a member of the hUserCMS group, a group of users that have administrative access to the framework. e.g., full access to the Finder, the ability to edit documents, the ability to access user data. This plugin creates a Mac OS X style pseudo-dock that appears at the bottom of every HTML templated document.

• hCoreMetricsTag

  This plugin is included if the framework variable hCoreMetricsClientID is defined. This plugin provides functionality related to the commercially available CoreMetrics web analytics service, which is a paid third-party service.

• hGoogleAnalytics

  This plugin is included if the framework variable hGoogleAnalytics is defined. This plugin provides functionality related to the Google Analytics service, which is a free third-party service. The variable, hGoogleAnalytics, should contain your Google Analytics site ID.

Plugins included in hFramework when Hierophant is accessed from the shell

• hShell

  This plugin is included if the framework is accessed from a shell or command line environment.