hooks.js

Go to the documentation of this file.

/*
 * Javascript hook interface
 */

elgg.provide('elgg.config.hooks');
elgg.provide('elgg.config.instant_hooks');
elgg.provide('elgg.config.triggered_hooks');

elgg.register_hook_handler = function(name, type, handler, priority) {
    elgg.assertTypeOf('string', name);
    elgg.assertTypeOf('string', type);
    elgg.assertTypeOf('function', handler);

    if (!name || !type) {
        return false;
    }

    var hooks = elgg.config.hooks;

    elgg.provide([name, type], hooks);

    if (!(hooks[name][type] instanceof elgg.ElggPriorityList)) {
        hooks[name][type] = new elgg.ElggPriorityList();
    }

    // call if instant and already triggered.
    if (elgg.is_instant_hook(name, type) && elgg.is_triggered_hook(name, type)) {
        handler(name, type, null, null);
    }

    return hooks[name][type].insert(handler, priority);
};

elgg.trigger_hook = function(name, type, params, value) {
    elgg.assertTypeOf('string', name);
    elgg.assertTypeOf('string', type);

    // mark as triggered
    elgg.set_triggered_hook(name, type);

    // default to null if unpassed
    value = !elgg.isNullOrUndefined(value) ? value : null;

    var hooks = elgg.config.hooks,
        tempReturnValue = null,
        returnValue = value,
        callHookHandler = function(handler) {
            tempReturnValue = handler(name, type, params, returnValue);
            if (!elgg.isNullOrUndefined(tempReturnValue)) {
                returnValue = tempReturnValue;
            }
        };

    elgg.provide([name, type], hooks);
    elgg.provide(['all', type], hooks);
    elgg.provide([name, 'all'], hooks);
    elgg.provide(['all', 'all'], hooks);

    var hooksList = [];
    
    if (name != 'all' && type != 'all') {
        hooksList.push(hooks[name][type]);
    }

    if (type != 'all') {
        hooksList.push(hooks['all'][type]);
    }

    if (name != 'all') {
        hooksList.push(hooks[name]['all']);
    }

    hooksList.push(hooks['all']['all']);

    hooksList.every(function(handlers) {
        if (handlers instanceof elgg.ElggPriorityList) {
            handlers.forEach(callHookHandler);
        }
        return true;
    });

    return returnValue;
};

elgg.register_instant_hook = function(name, type) {
    elgg.assertTypeOf('string', name);
    elgg.assertTypeOf('string', type);

    return elgg.push_to_object_array(elgg.config.instant_hooks, name, type);
};

elgg.is_instant_hook = function(name, type) {
    return elgg.is_in_object_array(elgg.config.instant_hooks, name, type);
};

elgg.set_triggered_hook = function(name, type) {
    return elgg.push_to_object_array(elgg.config.triggered_hooks, name, type);
};

elgg.is_triggered_hook = function(name, type) {
    return elgg.is_in_object_array(elgg.config.triggered_hooks, name, type);
};

elgg.register_instant_hook('init', 'system');
elgg.register_instant_hook('ready', 'system');
elgg.register_instant_hook('boot', 'system');