widgets.php

Go to the documentation of this file.

<?php
function elgg_get_widgets($owner_guid, $context) {
    return _elgg_services()->widgets->getWidgets($owner_guid, $context);
}

function elgg_create_widget($owner_guid, $handler, $context, $access_id = null) {
    return _elgg_services()->widgets->createWidget($owner_guid, $handler, $context, $access_id);
}

function elgg_can_edit_widget_layout($context, $user_guid = 0) {
    return _elgg_services()->widgets->canEditLayout($context, $user_guid);
}

function elgg_register_widget_type($handler, $name = null, $description = null, $context = [], $multiple = false) {
    if (is_array($handler)) {
        $definition = \Elgg\WidgetDefinition::factory($handler);
    } else {
        $definition = \Elgg\WidgetDefinition::factory([
            'id' => $handler,
            'name' => $name,
            'description' => $description,
            'context' => $context,
            'multiple' => $multiple,
        ]);
    }

    return _elgg_services()->widgets->registerType($definition);
}

function elgg_unregister_widget_type($handler) {
    return _elgg_services()->widgets->unregisterType($handler);
}

function elgg_is_widget_type($handler, $context = null, \ElggEntity $container = null) {
    return _elgg_services()->widgets->validateType($handler, $context, $container);
}

function elgg_get_widget_types($context = "") {
    if (is_array($context)) {
        $params = $context;
    } else {
        $params = [
            'context' => $context,
            'container' => null,
        ];
    }
    return _elgg_services()->widgets->getTypes($params);
}

function _elgg_widgets_widget_urls($hook, $type, $result, $params) {
    $widget = elgg_extract('entity', $params);
    if (!($widget instanceof \ElggWidget)) {
        return;
    }
    
    switch ($widget->handler) {
        case 'content_stats':
            return 'admin/statistics';
        case 'cron_status':
            return 'admin/cron';
        case 'new_users':
            return 'admin/users/newest';
        case 'online_users':
            return 'admin/users/online';
    }
}

function _elgg_widgets_init() {
    elgg_register_plugin_hook_handler('entity:url', 'object', '_elgg_widgets_widget_urls');
}

function _elgg_default_widgets_init() {
    $default_widgets = elgg_trigger_plugin_hook('get_list', 'default_widgets', null, []);

    _elgg_config()->default_widget_info = $default_widgets;

    if (empty($default_widgets)) {
        return;
    }

    elgg_register_menu_item('page', [
        'name' => 'default_widgets',
        'text' => elgg_echo('admin:configure_utilities:default_widgets'),
        'href' => 'admin/configure_utilities/default_widgets',
        'section' => 'configure',
        'parent_name' => 'configure_utilities',
        'context' => 'admin',
    ]);

    // override permissions for creating widget on logged out / just created entities
    elgg_register_plugin_hook_handler('container_permissions_check', 'object', '_elgg_default_widgets_permissions_override');

    // only register the callback once per event
    $events = [];
    foreach ($default_widgets as $info) {
        if (!is_array($info)) {
            continue;
        }
        $event = elgg_extract('event', $info);
        $entity_type = elgg_extract('entity_type', $info);
        if (!$event || !$entity_type) {
            continue;
        }
        if (!isset($events[$event][$entity_type])) {
            elgg_register_event_handler($event, $entity_type, '_elgg_create_default_widgets');
            $events[$event][$entity_type] = true;
        }
    }
}

function _elgg_create_default_widgets($event, $type, $entity) {
    $default_widget_info = _elgg_config()->default_widget_info;

    if (empty($default_widget_info) || !$entity) {
        return;
    }

    $type = $entity->getType();
    $subtype = $entity->getSubtype();

    // event is already guaranteed by the hook registration.
    // need to check subtype and type.
    foreach ($default_widget_info as $info) {
        if (elgg_extract('entity_type', $info) !== $type) {
            continue;
        }

        $entity_subtype = elgg_extract('entity_subtype', $info);
        if ($entity_subtype !== ELGG_ENTITIES_ANY_VALUE && $entity_subtype !== $subtype) {
            continue;
        }

        // need to be able to access everything
        $old_ia = elgg_set_ignore_access(true);
        elgg_push_context('create_default_widgets');

        // pull in by widget context with widget owners as the site
        // not using elgg_get_widgets() because it sorts by columns and we don't care right now.
        $widgets = elgg_get_entities([
            'type' => 'object',
            'subtype' => 'widget',
            'owner_guid' => elgg_get_site_entity()->guid,
            'private_setting_name' => 'context',
            'private_setting_value' => elgg_extract('widget_context', $info),
            'limit' => 0,
            'batch' => true,
        ]);
        /* @var \ElggWidget[] $widgets */

        foreach ($widgets as $widget) {
            // change the container and owner
            $new_widget = clone $widget;
            $new_widget->container_guid = $entity->guid;
            $new_widget->owner_guid = $entity->guid;

            // pull in settings
            $settings = $widget->getAllPrivateSettings();

            foreach ($settings as $name => $value) {
                $new_widget->$name = $value;
            }

            $new_widget->save();
        }

        elgg_set_ignore_access($old_ia);
        elgg_pop_context();
    }
}

function _elgg_default_widgets_permissions_override($hook, $type, $return, $params) {
    if ($type == 'object' && $params['subtype'] == 'widget') {
        return elgg_in_context('create_default_widgets') ? true : null;
    }

    return null;
}

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