WidgetDefinition.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Exceptions\InvalidArgumentException;

#[\AllowDynamicProperties]
class WidgetDefinition {

    public $id;

    public $name;

    public $description;

    public $context;

    public $multiple;

    public $required_plugin;
    
    public function __construct($id) {
        if (empty($id)) {
            throw new InvalidArgumentException('"id" missing for ' . __CLASS__);
        }
        
        $this->id = $id;
    }
    
    public static function factory(array $options) {

        $id = (string) 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;
        }
        
        $context = (array) elgg_extract('context', $options, ['profile', 'dashboard']);
        $definition->context = $context;
        
        $definition->multiple = (bool) elgg_extract('multiple', $options, false);
        
        $definition->required_plugin = (array) elgg_extract('required_plugin', $options, []);
        
        return $definition;
    }
    
    public function isValid() {
        return $this->checkRequiredActivePlugins();
    }
    
    protected function checkRequiredActivePlugins() {
        if (empty($this->required_plugin)) {
            return true;
        }
        
        foreach ($this->required_plugin as $plugin) {
            if (!elgg_is_active_plugin($plugin)) {
                return false;
            }
        }
        
        return true;
    }
}