AModule.php

Go to the documentation of this file.

<?php

namespace Tools;

abstract class AModule
{
    private $context;

    private $entity;

    public abstract function install();

    public function uninstall()
    { }

    public abstract function doAction($event);

    public abstract function doShortCode($shortCode, $params);

    public function setContext($context)
    {
        if ($this->context === null)
            $this->context = $context;
    }

    public function setEntity($entity)
    {
        if ($this->entity === null)
            $this->entity = $entity;
    }

    public function registerHook($hookName)
    {
        $this->context->hookManager->register($this, $hookName);
    }

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

    public function getDescription()
    { return ""; }

    public function __get($key)
    {
        switch ($key)
        {
            case "context": return $this->context; break;
            case "entity": return $this->entity; break;
        }
        throw new \Exception("Cannot access attribute {$key}");
    }
}