Overview

Packages

  • framework
    • api
    • auth
    • cache
    • config
    • crypt
    • db
    • dispatch
    • format
    • module
    • modules
    • oauth2
    • output
    • request
    • servers
    • session
    • setup
    • webdav
  • modules
    • 2fa
      • handler
      • output
    • account
      • handler
      • output
    • api
      • login
        • functions
        • handler
    • calendar
      • handler
      • lib
      • output
    • carddav
      • contacts
        • functions
        • handler
    • contacts
      • handler
      • lib
      • output
    • core
      • handler
      • output
    • desktop
      • notifications
    • developer
      • handler
      • output
    • dynamic
      • login
        • handler
        • lib
        • output
    • feeds
      • handler
      • lib
      • output
    • github
      • handler
      • lib
      • output
    • gmail
      • contacts
        • handler
        • lib
    • helloworld
      • handler
      • output
    • history
      • handler
      • output
    • idletimer
      • handler
      • output
    • imap
      • folders
        • handler
        • output
      • handler
      • lib
      • output
    • inline
      • message
        • handler
        • output
    • keyboard
      • shortcuts
        • handler
        • output
    • ldap
      • contacts
        • handler
        • lib
        • output
    • local
      • contacts
        • handler
        • output
    • nasa
      • handler
      • output
    • nux
      • handler
      • lib
      • output
    • pgp
      • handler
      • output
    • pop3
      • handler
      • lib
      • output
    • profile
      • handler
      • output
    • profiles
      • lib
    • recaptcha
      • handler
      • output
    • recover
      • settings
        • handler
        • output
    • savedsearches
      • handler
      • lib
      • output
    • site
      • handler
    • smtp
      • handler
      • lib
      • output
    • tags
      • handler
      • libs
      • output
    • themes
      • handler
      • output
    • wordpress
      • handler
      • output
  • None

Classes

  • Hm_Handler_
  • Hm_Handler_Module
  • Hm_Output_
  • Hm_Output_Module

Traits

  • Hm_Handler_Validate
  • Hm_Module_Output
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Hm_Handler_

Base class for data input processing modules, called "handler modules"

All modules that deal with processing input data extend from this class. It provides access to input and state through the following member variables:

$session The session interface object $request The HTTP request details object $config The site config object $user_config The user settings object for the current user

Modules that extend this class need to override the process function Modules can pass information to the output modules using the out() and append() methods, and see data from other modules with the get() method

Hm_Handler_Module uses Hm_Module_Output, Hm_Handler_Validate
Extended by Hm_Handler_
Package: framework\module
Located at module.php
Methods summary
public
# process( )

Handler modules need to override this method to do work

Handler modules need to override this method to do work

Methods inherited from Hm_Handler_Module
__construct(), module_is_supported(), process_form(), process_key()
Methods used from Hm_Module_Output
append(), check_overwrite(), concat(), exists(), get(), html_safe(), in(), module_output(), out(), output_protected()
Methods used from Hm_Handler_Validate
source_and_target(), validate_method(), validate_origin(), validate_source(), validate_target()
Properties inherited from Hm_Handler_Module
$config, $page, $request, $session, $user_config
Properties used from Hm_Module_Output
$appendable, $output, $protected
Cypht Documentation API documentation generated by ApiGen