plugins.php

Go to the documentation of this file.

<?php
use Elgg\Filesystem\Directory;


define('ELGG_PLUGIN_INCLUDE_START', 1);

define('ELGG_PLUGIN_REGISTER_VIEWS', 2);

define('ELGG_PLUGIN_REGISTER_LANGUAGES', 4);

define('ELGG_PLUGIN_REGISTER_CLASSES', 8);

//define('ELGG_PLUGIN_SETTING_PREFIX', 'plugin:setting:');

define('ELGG_PLUGIN_USER_SETTING_PREFIX', 'plugin:user_setting:');

define('ELGG_PLUGIN_INTERNAL_PREFIX', 'elgg:internal:');

function _elgg_generate_plugin_entities() {
    return _elgg_services()->plugins->generateEntities();
}

function _elgg_cache_plugin_by_id(\ElggPlugin $plugin) {
    return _elgg_services()->plugins->cache($plugin);
}

function elgg_get_plugin_from_id($plugin_id) {
    return _elgg_services()->plugins->get($plugin_id);
}

function elgg_plugin_exists($id) {
    return _elgg_services()->plugins->exists($id);
}

function _elgg_get_max_plugin_priority() {
    return _elgg_services()->plugins->getMaxPriority();
}

function elgg_is_active_plugin($plugin_id, $site_guid = null) {
    return _elgg_services()->plugins->isActive($plugin_id, $site_guid);
}

function elgg_get_plugins($status = 'active', $site_guid = null) {
    return _elgg_services()->plugins->find($status, $site_guid);
}

function _elgg_namespace_plugin_private_setting($type, $name, $id = null) {
    return _elgg_services()->plugins->namespacePrivateSetting($type, $name, $id);
}

function _elgg_invalidate_plugins_provides_cache() {
    return _elgg_services()->plugins->invalidateProvidesCache();
}

function _elgg_check_plugins_provides($type, $name, $version = null, $comparison = 'ge') {
    return _elgg_services()->plugins->checkProvides($type, $name, $version, $comparison);
}

function _elgg_get_plugin_dependency_strings($dep) {
    return _elgg_services()->plugins->getDependencyStrings($dep);
}

function elgg_get_all_plugin_user_settings($user_guid = 0, $plugin_id = null, $return_obj = false) {
    return _elgg_services()->plugins->getAllUserSettings($user_guid, $plugin_id, $return_obj);
}

function elgg_set_plugin_user_setting($name, $value, $user_guid = 0, $plugin_id = null) {
    return _elgg_services()->plugins->setUserSetting($name, $value, $user_guid, $plugin_id);
}

function elgg_unset_plugin_user_setting($name, $user_guid = 0, $plugin_id = null) {
    return _elgg_services()->plugins->unsetUserSetting($name, $user_guid, $plugin_id);
}

function elgg_get_plugin_user_setting($name, $user_guid = 0, $plugin_id = null, $default = null) {
    return _elgg_services()->plugins->getUserSetting($name, $user_guid, $plugin_id, $default);
}

function elgg_set_plugin_setting($name, $value, $plugin_id = null) {
    return _elgg_services()->plugins->setSetting($name, $value, $plugin_id);
}

function elgg_get_plugin_setting($name, $plugin_id = null, $default = null) {
    return _elgg_services()->plugins->getSetting($name, $plugin_id, $default);
}

function elgg_unset_plugin_setting($name, $plugin_id = null) {
    return _elgg_services()->plugins->unsetSetting($name, $plugin_id);
}

function elgg_unset_all_plugin_settings($plugin_id = null) {
    return _elgg_services()->plugins->unsetAllSettings($plugin_id);
}

function elgg_get_entities_from_plugin_user_settings(array $options = array()) {
    return _elgg_services()->plugins->getEntitiesFromUserSettings($options);
}

function _elgg_plugins_test($hook, $type, $value, $params) {
    global $CONFIG;
    $value[] = $CONFIG->path . 'engine/tests/ElggCorePluginsAPITest.php';
    return $value;
}

function _plugins_deactivate_dependency_check($event, $type, $params) {
    $plugin_id = $params['plugin_entity']->getManifest()->getPluginID();
    $plugin_name = $params['plugin_entity']->getManifest()->getName();

    $active_plugins = elgg_get_plugins();

    $dependents = array();
    foreach ($active_plugins as $plugin) {
        $manifest = $plugin->getManifest();
        $requires = $manifest->getRequires();

        foreach ($requires as $required) {
            if ($required['type'] == 'plugin' && $required['name'] == $plugin_id) {
                // there are active dependents
                $dependents[$manifest->getPluginID()] = $plugin;
            }
        }
    }

    if ($dependents) {
        $list = '<ul>';
        // construct error message and prevent disabling
        foreach ($dependents as $dependent) {
            $list .= '<li>' . $dependent->getManifest()->getName() . '</li>';
        }
        $list .= '</ul>';

        register_error(elgg_echo('ElggPlugin:Dependencies:ActiveDependent', array($plugin_name, $list)));

        return false;
    }
}

function _elgg_plugins_init() {

    if (elgg_is_admin_logged_in()) {
        elgg_register_ajax_view('object/plugin/full');
        elgg_register_ajax_view('object/plugin/details');
    }

    elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_plugins_test');

    // note - plugins are booted by the time this handler is registered
    // deactivation due to error may have already occurred
    elgg_register_event_handler('deactivate', 'plugin', '_plugins_deactivate_dependency_check');

    $svc = _elgg_services()->plugins;
    elgg_register_event_handler('deactivate', 'plugin', array($svc, 'invalidateIsActiveCache'));
    elgg_register_event_handler('activate', 'plugin', array($svc, 'invalidateIsActiveCache'));

    elgg_register_action("plugins/settings/save", '', 'admin');
    elgg_register_action("plugins/usersettings/save");

    elgg_register_action('admin/plugins/activate', '', 'admin');
    elgg_register_action('admin/plugins/deactivate', '', 'admin');
    elgg_register_action('admin/plugins/activate_all', '', 'admin');
    elgg_register_action('admin/plugins/deactivate_all', '', 'admin');

    elgg_register_action('admin/plugins/set_priority', '', 'admin');
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('init', 'system', '_elgg_plugins_init');
};