Class Hm_Handler_Module

`abstract`
`uses`	`Hm_Module_Output, Hm_Handler_Validate`

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

Located at lib/module.php

Methods


					
	public

__construct(object $parent, string $page, array $output = [], array $protected = [])

Assign input and state sources

Parameters

`$parent`	instance of the Hm_Request_Handler class
`$page`	page id
`$output`	data from handler modules
`$protected`	list of protected output names


					
	public

process_key(): false|string

Validate a form key. If this is a non-empty POST form from an HTTP request or AJAX update, it will take the user to the…

Validate a form key. If this is a non-empty POST form from an HTTP request or AJAX update, it will take the user to the home page if the page_key value is either not present or not valid


					
	public

process_form(array $form): array

Process an HTTP POST form

Parameters

$form

list of required field names in the form

Returns

tuple with a bool indicating success, and an array of valid form values


					
	public

module_is_supported(string $name): bool

Determine if a module set is enabled

Parameters

$name

the module set name to check for


					
	public

should_skip_execution(string $setting_key, mixed $default = false): bool

Checks if a config setting is disabled and signals whether to skip further execution.

Parameters

`$setting_key`	The configuration key to check.
`$default`	The default value to use if the key is not set.

Returns

True if the feature is disabled and should be skipped.


					
	public

save_hm_msgs()


					abstract
	public

process()

Handler modules need to override this method to do work

Implemented by

Methods used from Hm_Module_Output
`check_overwrite(), out(), append(), html_safe(), concat(), module_output(), output_protected(), get(), exists(), in()`

Methods used from Hm_Handler_Validate
`validate_method(), validate_origin()`

Properties
`public`	`$session`	#
`public`	`$request`	#
`public`	`$config`	#
`protected`	`$page = ''`	#
`public`	`$user_config`	#
`public`	`$cache`	#

Properties used from Hm_Module_Output
`$output, $protected, $appendable`

Namespaces

Classes

Traits

Functions

Class Hm_Handler_Module

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Implemented by