Class: H_module

H_module

Base class for HelPHP client-side modules.
Handles module instantiation, AJAX settings, and instance management.
Used as h.libs.module.
Extend this class to create your own modules.

new H_module()

module.js, line 25

Members

instancesObject

Stores all module instances by class name and dom_id.

Methods

ajax_settings(){Settings}

module.js, line 69
Returns default AJAX settings for this module.
You can override or extend this in your module.
Returns:
Type Description
Settings Default AJAX settings object.

clean(){boolean}

module.js, line 100
Cleans up the module instance.
Should be overrided in your module for custom cleanup.
Returns:
Type Description
boolean True when cleaned.

exist(){boolean}

module.js, line 91
Checks if the module instance exists.
Must be overrided in your module.
Returns:
Type Description
boolean True if exists.

staticH_module.clean_instances()

module.js, line 135
Cleans up all module instances that no longer exist.
Calls clean() (should be overided) on each and removes from the instances list.

staticH_module.create_instance(dom_id, settings){H_module}

module.js, line 117
Creates a new instance of the module for a given dom_id.
Cleans up any existing instance for the same dom_id.
Name Type Description
dom_id string The DOM element id.
settings Object Optional settings for the instance.
Returns:
Type Description
H_module The created module instance.