Tool.php

Go to the documentation of this file.

<?php

namespace Elgg\Groups;

use Elgg\Collections\CollectionItemInterface;

class Tool implements CollectionItemInterface {

    public $name;

    protected $options;

    public function __construct($name, array $options = []) {
        $this->name = $name;

        $defaults = [
            'label' => null,
            'default_on' => true,
            'priority' => 500,
        ];

        $this->options = array_merge($defaults, $options);
    }

    public function __get($name) {
        switch ($name) {
            case 'label':
                return $this->getLabel();

            case 'default_on':
                return $this->isEnabledByDefault();
        }

        return elgg_extract($name, $this->options);
    }

    public function __set($name, $value) {
        $this->options[$name] = $value;
    }

    public function getID() {
        return $this->name;
    }

    public function getPriority() {
        return $this->priority;
    }

    public function getLabel() {
        $label = elgg_extract('label', $this->options);
        if (isset($label)) {
            return $label;
        }

        return elgg_echo("groups:tool:{$this->name}");
    }

    public function getDescription(): ?string {
        $lan_key = "groups:tool:{$this->name}:description";
        if (!elgg_language_key_exists($lan_key)) {
            return null;
        }
        
        return elgg_echo($lan_key);
    }

    public function isEnabledByDefault() {
        $default_on = elgg_extract('default_on', $this->options, true);

        if ($default_on === true || $default_on === 'yes') {
            return true;
        }

        return false;
    }

    public function mapMetadataName() {
        return "{$this->name}_enable";
    }

    public function mapMetadataValue($value = null) {
        if (!isset($value)) {
            $value = $this->default_on;
        }

        if ($value === 'yes' || $value === true) {
            return 'yes';
        }

        return 'no';
    }
}