engine/lib/widgets.php

Go to the documentation of this file.

<?php

    class ElggWidget extends ElggObject
    {
        protected function initialise_attributes()
        {
            parent::initialise_attributes();
            
            $this->attributes['subtype'] = "widget";
        }

        public function __construct($guid = null) { parent::__construct($guid); }
            
        public function get($name)
        {
            // See if its in our base attribute
            if (isset($this->attributes[$name])) {
                return $this->attributes[$name];
            }
            
            // No, so see if its in the private data store.
            $meta = get_private_setting($this->guid, $name);
            if ($meta)
                return $meta;
            
            // Can't find it, so return null
            return null;
        }

        public function set($name, $value)
        {
            if (array_key_exists($name, $this->attributes))
            {
                // Check that we're not trying to change the guid! 
                if ((array_key_exists('guid', $this->attributes)) && ($name=='guid'))
                    return false;
                    
                $this->attributes[$name] = $value;
            }
            else 
                return set_private_setting($this->guid, $name, $value);
        
            return true;
        }
    }

        function use_widgets($context) {
            
            global $CONFIG;
            if (!isset($CONFIG->widgets))
                $CONFIG->widgets = new stdClass;
            if (!isset($CONFIG->widgets->contexts)) {
                $CONFIG->widgets->contexts = array();
            }
            if (!empty($context)) {
                $CONFIG->widgets->contexts[] = $context;
            }
            
        }
        
        function using_widgets() {
            
            global $CONFIG;
            $context = get_context();
            if (isset($CONFIG->widgets->contexts) && is_array($CONFIG->widgets->contexts)) {
                if (in_array($context, $CONFIG->widgets->contexts)) return true;
            }
            
            return false;
            
        }
        
        function save_widget_location(ElggObject $widget, $order, $column) {
            
            if ($widget instanceof ElggObject) {
                if ($widget->subtype == "widget") {
                    
                    // If you can't move the widget, don't save a new location
                    if (!$widget->draggable)
                        return false;
                    
                    // Sanitise the column value
                    if ($column != 1 || $column != 2 || $column != 3)
                        $column = 1;
                        
                    $widget->column = (int) $column;
                    
                    $ordertmp = array();
                    
                    if ($entities = get_entities_from_metadata_multi(array(                                                                     
                            'context' => $widget->context,
                            'column' => $column,
                            ),'object','widget')) {
                        foreach($entities as $entity) {
                            $entityorder = $entity->order;
                            if ($entityorder < $order) {
                                $ordertmp[$entityorder] = $entity;                               
                            }
                            if ($entityorder >= $order) {
                                $ordertmp[$entityorder + 10000] = $entity;
                            }
                        }   
                    }
                    
                    $ordertmp[$order] = $widget;
                    ksort($ordertmp);
                    
                    $orderticker = 10;
                    foreach($ordertmp as $orderval => $entity) {
                        $entity->order = $orderticker;
                        $orderticker += 10;
                    }
                    
                    return true;
                    
                } else {
                    register_error($widget->subtype);
                }
                
            }
            
            return false;
            
        }
        
        function get_widgets($user_guid, $context, $column) {
            
            if ($widgets = get_entities_from_private_setting_multi(array(
                                                'column' => $column,
                                                'context' => $context), "object", "widget", $user_guid, "", 10000))
            /*if ($widgets = get_user_objects_by_metadata($user_guid, "widget", array(
                                                'column' => $column,
                                                'context' => $context, 
                                                                    ), 10000)) {
            */
            {
                                                                        
                $widgetorder = array();
                foreach($widgets as $widget) {
                    $order = $widget->order;
                    while(isset($widgetorder[$order])) {
                        $order++;
                    }
                    $widgetorder[$order] = $widget; 
                }
                
                ksort($widgetorder);
                
                return $widgetorder;
                                                                        
            }
            
            return false;
            
        }

        function display_widget(ElggObject $widget) {
            
            return elgg_view_entity($widget);
            
        }
        
        function add_widget($user_guid, $handler, $context, $order = 0, $column = 1, $access_id = null) {
            
            if (empty($user_guid) || empty($context) || empty($handler) || !widget_type_exists($handler))
                return false;
            
            if ($user = get_user($user_guid)) {
                
                $widget = new ElggWidget;
                $widget->owner_guid = $user_guid;
                $widget->container_guid = $user_guid;
                if (isset($access_id)) {
                    $widget->access_id = $access_id;
                } else {
                    $widget->access_id = get_default_access();
                }

                if (!$widget->save())
                    return false;
                    
                $widget->handler = $handler;
                $widget->context = $context;
                $widget->column = $column;
                $widget->order = $order;
                
                // save_widget_location($widget, $order, $column);
                return true;
                
            }
            
            return false;
            
        }
        
        function add_widget_type($handler, $name, $description, $context = "all", $multiple = false, $positions = "side,main") {

            if (!empty($handler) && !empty($name)) {
                
                global $CONFIG;
                
                if (!isset($CONFIG->widgets))
                    $CONFIG->widgets = new stdClass;
                    
                if (!isset($CONFIG->widgets->handlers))
                    $CONFIG->widgets->handlers = array();
                
                $handlerobj = new stdClass;
                $handlerobj->name = $name;
                $handlerobj->description = $description;
                $handlerobj->context = explode(",",$context);
                $handlerobj->multiple = $multiple;
                $handlerobj->positions = explode(",",$positions);
                    
                $CONFIG->widgets->handlers[$handler] = $handlerobj;

                return true;
                    
            }
            
            return false;
            
        }
        
        function widget_type_exists($handler) {
            
            global $CONFIG;
            if (!empty($CONFIG->widgets) 
                && !empty($CONFIG->widgets->handlers) 
                && is_array($CONFIG->widgets->handlers) 
                && array_key_exists($handler, $CONFIG->widgets->handlers))
                    return true;

            return false;
            
        }
        
        function get_widget_types() {
            
            global $CONFIG;
            if (!empty($CONFIG->widgets) 
                && !empty($CONFIG->widgets->handlers) 
                && is_array($CONFIG->widgets->handlers)) {
                    
                    $context = get_context();
                    
                    foreach($CONFIG->widgets->handlers as $key => $handler) {
                        if (!in_array('all',$handler->context) &&
                            !in_array($context,$handler->context)) {
                                unset($CONFIG->widgets->handlers[$key]);
                        }
                    }
                    
                    return $CONFIG->widgets->handlers;
                    
                }
                
            return array();
            
        }
        
        function save_widget_info($widget_guid, $params) {
            
            if ($widget = get_entity($widget_guid)) {
                
                $subtype = $widget->getSubtype();
                
                if ($subtype != "widget") return false;
                $handler = $widget->handler;
                if (empty($handler) || !widget_type_exists($handler)) return false;
                
                if (!$widget->canEdit()) return false;
                
                // Save the params to the widget 
                if (is_array($params) && sizeof($params) > 0) {
                    foreach($params as $name => $value) {
                        
                        if (!empty($name) && !in_array($name,array(
                                'guid','owner_guid','site_guid'
                                                                    ))) {
                            if (is_array($value))
                            {
                                // TODO: Handle arrays securely
                                $widget->setMetaData($name, $value, "", true);
                            }else
                                $widget->$name = $value;
                        }
                    }
                    $widget->save();
                }
                
                $function = "save_{$handler}_widget";
                if (is_callable($function)) {
                    return $function($params);
                }
                
                return true;
                
            }
            
            return false;
            
        }
        
        function reorder_widgets_from_panel($panelstring1, $panelstring2, $panelstring3, $context, $owner) {
            
            $return = true;
            
            $mainwidgets = explode('::',$panelstring1);
            $sidewidgets = explode('::',$panelstring2);
            $rightwidgets = explode('::',$panelstring3);
            
            $handlers = array();
            $guids = array();
            
            if (is_array($mainwidgets) && sizeof($mainwidgets) > 0) {
                foreach($mainwidgets as $widget) {
                    
                    $guid = (int) $widget;

                    if ("{$guid}" == "{$widget}") {
                        $guids[1][] = $widget;
                    } else {
                        $handlers[1][] = $widget;
                    }
                    
                }
            }
            if (is_array($sidewidgets) && sizeof($sidewidgets) > 0) {
                foreach($sidewidgets as $widget) {
                    
                    $guid = (int) $widget;

                    if ("{$guid}" == "{$widget}") {
                        $guids[2][] = $widget;
                    } else {
                        $handlers[2][] = $widget;
                    }
                    
                }
            }
            if (is_array($rightwidgets) && sizeof($rightwidgets) > 0) {
                foreach($rightwidgets as $widget) {
                    
                    $guid = (int) $widget;

                    if ("{$guid}" == "{$widget}") {
                        $guids[3][] = $widget;
                    } else {
                        $handlers[3][] = $widget;
                    }
                    
                }
            }
            
            // Reorder existing widgets or delete ones that have vanished
            foreach (array(1,2,3) as $column) {
                if ($dbwidgets = get_widgets($owner,$context,$column)) {
                    
                    foreach($dbwidgets as $dbwidget) {
                        if (in_array($dbwidget->getGUID(),$guids[1]) || in_array($dbwidget->getGUID(),$guids[2]) || in_array($dbwidget->getGUID(),$guids[3])) {
                            if (in_array($dbwidget->getGUID(),$guids[1])) {
                                $pos = array_search($dbwidget->getGUID(),$guids[1]);
                                $col = 1;
                            } else if (in_array($dbwidget->getGUID(),$guids[2])) {
                                $pos = array_search($dbwidget->getGUID(),$guids[2]);
                                $col = 2;
                            } else {
                                $pos = array_search($dbwidget->getGUID(),$guids[3]);
                                $col = 3;
                            }
                            $pos = ($pos + 1) * 10;
                            $dbwidget->column = $col;
                            $dbwidget->order = $pos;
                        } else {
                            $dbguid = $dbwidget->getGUID();
                            if (!$dbwidget->delete()) {
                                $return = false;
                            } else {
                                // Remove state cookie
                                setcookie('widget' + $dbguid, null);
                            }
                        }
                    }
                    
                }
                // Add new ones
                if (sizeof($guids[$column]) > 0) {
                    foreach($guids[$column] as $key => $guid) {
                        if ($guid == 0) {
                            $pos = ($key + 1) * 10;
                            $handler = $handlers[$column][$key];
                            if (!add_widget($owner,$handler,$context,$pos,$column))
                                $return = false;
                        }
                    }
                }
            }
            
            return $return;
            
        }
        
        function widget_run_once()
        {
            // Register a class
            add_subtype("object", "widget", "ElggWidget");  
        }

        function widgets_init() {
            
            register_action('widgets/reorder');
            register_action('widgets/save');
            register_action('widgets/add');
            
            // Now run this stuff, but only once
            run_function_once("widget_run_once");
        }
        
    // Register event
        register_elgg_event_handler('init','system','widgets_init');

    // Use widgets on the dashboard
        use_widgets('dashboard');


?>

---