widgets.php

Go to the documentation of this file.

<?php
use Elgg\WidgetDefinition;
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 = array('all'), $multiple = false) {
    if (is_array($handler)) {
        $definition = \Elgg\WidgetDefinition::factory($handler);
    } else {
        if (is_string($context)) {
            elgg_deprecated_notice('context parameters for elgg_register_widget_type() should be passed as an array())', 1.9);
            $context = explode(",", $context);
        } elseif (empty($context)) {
            $context = array('all');
        }
        
        $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 = "", $exact = false) {
    if (is_array($context)) {
        $params = $context;
    } else {
        $params = [
            'context' => $context,
            'exact' => $exact,
            'container' => null,
        ];
    }
    return _elgg_services()->widgets->getTypes($params);
}

function _elgg_widgets_set_ajax_title($hook, $type, $results, $params) {
    if ($params['action'] == 'widgets/save') {
        // @todo Elgg makes ajax so difficult - no other way to add data to output
        $widget = get_entity(get_input('guid'));
        if ($widget && $widget->title) {
            $results['title'] = $widget->title;
            return $results;
        }
    }
}

function _elgg_widgets_init() {
    elgg_register_action('widgets/save');
    elgg_register_action('widgets/add');
    elgg_register_action('widgets/move');
    elgg_register_action('widgets/delete');

    elgg_register_plugin_hook_handler('output', 'ajax', '_elgg_widgets_set_ajax_title');
}

function _elgg_default_widgets_init() {
    global $CONFIG;
    $default_widgets = elgg_trigger_plugin_hook('get_list', 'default_widgets', null, array());

    $CONFIG->default_widget_info = $default_widgets;

    if ($default_widgets) {
        elgg_register_admin_menu_item('configure', 'default_widgets', 'appearance');

        // 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 = array();
        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_get_config('default_widget_info');

    if (!$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 ($info['entity_type'] == $type) {
            if ($info['entity_subtype'] == ELGG_ENTITIES_ANY_VALUE || $info['entity_subtype'] == $subtype) {

                // 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.
                $options = array(
                    'type' => 'object',
                    'subtype' => 'widget',
                    'owner_guid' => elgg_get_site_entity()->guid,
                    'private_setting_name' => 'context',
                    'private_setting_value' => $info['widget_context'],
                    'limit' => 0
                );

                $widgets = elgg_get_entities_from_private_settings($options);
                /* @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 = get_all_private_settings($widget->guid);

                    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');
};