ElggWidget.php

Go to the documentation of this file.

<?php

class ElggWidget extends \ElggObject {

    protected function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['subtype'] = "widget";
    }

    public function __get($name) {
        // See if its in our base attribute
        if (array_key_exists($name, $this->attributes)) {
            return $this->attributes[$name];
        }
    
        // object title and description are stored as metadata
        if (in_array($name, ['title', 'description'])) {
            return parent::__get($name);
        }

        return $this->getPrivateSetting($name);
    }

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

            $this->attributes[$name] = $value;
            return;
        }
        
        // object title and description are stored as metadata
        if (in_array($name, ['title', 'description'])) {
            parent::__set($name, $value);
            return;
        }
        
        $this->setPrivateSetting($name, $value);
    }
    
    public function __isset($name) {
        if (array_key_exists($name, $this->attributes)) {
            return parent::__isset($name);
        }
        
        // object title and description are stored as metadata
        if (in_array($name, ['title', 'description'])) {
            return parent::__isset($name);
        }
        
        $private_setting = $this->getPrivateSetting($name);
        return !is_null($private_setting);
    }

    public function setContext($context) {
        $this->context = $context;
        return true;
    }

    public function getContext() {
        return (string) $this->context;
    }

    public function getTitle() {
        _elgg_services()->deprecation->sendNotice(__METHOD__ . ' is deprecated. Use \ElggWidget::getDisplayName() instead', '3.0');
        return $this->getDisplayName();
    }
    
    public function getDisplayName() {
        $result = parent::getDisplayName();
        if (!$result) {
            $container = $this->getContainerEntity() ? : null;
            $result = _elgg_services()->widgets->getNameById($this->handler, $this->getContext(), $container);
        }
        return $result;
    }

    public function move($column, $rank) {
        $options = [
            'type' => 'object',
            'subtype' => 'widget',
            'container_guid' => $this->container_guid,
            'limit' => false,
            'private_setting_name_value_pairs' => [
                ['name' => 'context', 'value' => $this->getContext()],
                ['name' => 'column', 'value' => $column]
            ]
        ];
        /* @var $widgets \ElggWidget[] */
        $widgets = elgg_get_entities($options);
        if (empty($widgets)) {
            $this->column = (int) $column;
            $this->order = 0;
            return;
        }

        usort($widgets, function($a, $b) {
            return (int) $a->order > (int) $b->order;
        });

        // remove widgets from inactive plugins
        $widget_types = elgg_get_widget_types([
            'context' => $this->context,
            'container' => $this->getContainerEntity(),
        ]);
        $inactive_widgets = [];
        foreach ($widgets as $index => $widget) {
            if (!array_key_exists($widget->handler, $widget_types)) {
                $inactive_widgets[] = $widget;
                unset($widgets[$index]);
            }
        }

        $bottom_rank = count($widgets);
        if ($column == $this->column) {
            $bottom_rank--;
        }
        
        if ($rank == 0) {
            // top of the column
            $this->order = reset($widgets)->order - 10;
        } elseif ($rank == $bottom_rank) {
            // bottom of the column of active widgets
            $this->order = end($widgets)->order + 10;
        } else {
            // reorder widgets

            // remove the widget that's being moved from the array
            foreach ($widgets as $index => $widget) {
                if ($widget->guid == $this->guid) {
                    unset($widgets[$index]);
                }
            }

            // split the array in two and recombine with the moved widget in middle
            $before = array_slice($widgets, 0, $rank);
            array_push($before, $this);
            $after = array_slice($widgets, $rank);
            $widgets = array_merge($before, $after);
            ksort($widgets);
            $order = 0;
            foreach ($widgets as $widget) {
                $widget->order = $order;
                $order += 10;
            }
        }

        // put inactive widgets at the bottom
        if ($inactive_widgets) {
            $bottom = 0;
            foreach ($widgets as $widget) {
                if ($widget->order > $bottom) {
                    $bottom = $widget->order;
                }
            }
            $bottom += 10;
            foreach ($inactive_widgets as $widget) {
                $widget->order = $bottom;
                $bottom += 10;
            }
        }

        $this->column = $column;
    }

    public function saveSettings($params) {
        if (!$this->canEdit()) {
            return false;
        }

        // plugin hook handlers should return true to indicate the settings have
        // been saved so that default code does not run
        $hook_params = [
            'widget' => $this,
            'params' => $params
        ];
        if (_elgg_services()->hooks->trigger('widget_settings', $this->handler, $hook_params, false) === true) {
            return true;
        }

        if (is_array($params) && count($params) > 0) {
            foreach ($params as $name => $value) {
                if (is_array($value)) {
                    // private settings cannot handle arrays
                    return false;
                } else {
                    $this->$name = $value;
                }
            }
            $this->save();
        }

        return true;
    }
}