WidgetDefinition.php

Go to the documentation of this file.

<?php
namespace Elgg;

class WidgetDefinition {

    public $id;

    public $name;

    public $description;

    public $context;

    public $multiple;
    
    public function __construct($id) {
        if (empty($id)) {
            throw new \InvalidParameterException('Id missing for WidgetDefinition');
        }
        
        $this->id = $id;
    }
    
    public static function factory(array $options) {

        $id = elgg_extract('id', $options);
        $definition = new WidgetDefinition($id);
        
        $name = elgg_extract('name', $options);
        if (empty($name)) {
            if (elgg_language_key_exists("widgets:{$id}:name")) {
                $definition->name = elgg_echo("widgets:{$id}:name");
            } elseif (elgg_language_key_exists($id)) {
                $definition->name = elgg_echo($id);
            } else {
                $definition->name = $id;
            }
        } else {
            $definition->name = $name;
        }
        
        $description = elgg_extract('description', $options);
        if (empty($description)) {
            if (elgg_language_key_exists("widgets:{$id}:description")) {
                $definition->description = elgg_echo("widgets:{$id}:description");
            }
        } else {
            $definition->description = $description;
        }
        
        $definition->context = (array) elgg_extract('context', $options, ['all']);
        $definition->multiple = (bool) elgg_extract('multiple', $options, false);
        
        return $definition;
    }
    
    public function __get($name) {
        if ($name === 'handler') {
            // before Elgg 2.2 the widget definitions had the handler attribute as the id
            return $this->id;
        }
        
        return $this->$name;
    }
}