AddonModule.php

Go to the documentation of this file.

<?php

namespace Combu;

class AddonModule
{
    public $Id = 0;
    public $Name = "";
    public $Version = "1.0";
    public $OnUserCreate = NULL;
    public $OnUserUpdate = NULL;
    public $OnUserDelete = NULL;
    public $OnUserCustomDataOutput = NULL;
    public $OnUserProcessOutput = NULL;
    public $OnUserLogout = NULL;

    private $Folder = "";
    private $Properties = array();
    private $AdminMenu = array();
    private $BlockedUpdateUserCustomData = array();

    public function __construct($folder) {
        $this->Folder = $folder;
        if (substr($this->Folder, -1) != "/") {
            $this->Folder .= "/";
        }
    }

    public static function LoadAddons() {
        $addons = array();
        $handle = NULL;
        if (file_exists(ADDONS_FOLDER)) {
            $handle = opendir(ADDONS_FOLDER);
        }
        while ($handle && false !== ($entry = readdir($handle))) {
            // Skip files
            if (!is_dir(ADDONS_FOLDER . "/" . $entry)) {
                continue;
            }
            // Skip back/current directories
            if ($entry == "." || $entry == "..") {
                continue;
            }
            // Try to load the add-on in this directory
            $addon = self::LoadAddon(ADDONS_FOLDER . "/" . $entry);
            if ($addon) {
                $addon->Id = count($addons) + 1;
                $addons[] = $addon;
            }
        }
        return $addons;
    }
    
    private static function LoadAddon($folder) {
        // Is there a loader file in this folder?
        $addon_file = $folder . "/addon.php";
        $disabled_file = $folder . "/.disabled";
        if (file_exists($addon_file) && !file_exists($disabled_file)) {
            try {
                // Create a new AddonModule for this entry
                $addon = new self($folder);
                // Run the add-on loader
                include_once $addon_file;
                return $addon;
            } catch (Exception $ex) {
                // Loading this add-on failed, log the exception
                AppLog::Error("Error trying to load add-on " . basename($folder) . ": " . $ex->getMessage());
            }
        }
        return NULL;
    }
    
    public static function GetAddon($addonName) {
        global $Addons;
        foreach ($Addons as $addon) {
            if ($addon->Name == $addonName)
                return $addon;
        }
        return NULL;
    }
    
    public function GetFolder() {
        return $this->Folder;
    }
    
    public function GetFile($fileRelativePath) {
        if (substr($fileRelativePath, 0, 1) == "/")
            $fileRelativePath = substr($fileRelativePath, 1);
        return $this->Folder . $fileRelativePath;
    }
    
    public function GetMenuLink($menu) {
        return URL_ROOT . "admin/addon-load.php?addon=" . urlencode($this->Name) . "&menu=" . $menu;
    }
    
    public function GetTooltip() {
        return $this->Name . " " . $this->Version;
    }
    
    public function GetProperties () {
        return $this->Properties;
    }
    
    public function GetProperty($name) {
        if (array_key_exists($name, $this->Properties))
            return $this->Properties[$name];
        return NULL;
    }
    
    public function SetProperty($name, $value) {
        $this->Properties[$name] = $value;
    }
    
    public function AddAdminMenu($displayText, $url) {
        if ($displayText && $url)
            $this->AdminMenu[] = array( "Display" => $displayText, "Url" => $url );
    }
    
    public function GetAdminMenu() {
        return $this->AdminMenu;
    }
    
    public function BlockUpdateUserCustomData($dataKey) {
        if (!array_key_exists($dataKey, $this->BlockedUpdateUserCustomData))
            $this->BlockedUpdateUserCustomData[] = $dataKey;
    }
    
    public static function IsBlockedUpdateUserCustomData($dataKey) {
        global $Addons;
        foreach ($Addons as $addon) {
            if (in_array($dataKey, $addon->BlockedUpdateUserCustomData))
                return TRUE;
        }
        return FALSE;
    }
    
    public static function ProcessOutputUserCustomData($user, &$customData) {
        global $Addons;
        foreach ($Addons as $addon) {
            if ($addon->OnUserCustomDataOutput)
                eval ($addon->OnUserCustomDataOutput . "(\$user, \$customData);");
        }
    }
    
    public static function ProcessOutputUser(&$userData) {
        global $Addons;
        foreach ($Addons as $addon) {
            if ($addon->OnUserProcessOutput)
                eval ($addon->OnUserProcessOutput . "(\$userData);");
        }
    }
    
    public static function NotifyUserCreate($user) {
        global $Addons;
        foreach ($Addons as $addon) {
            if ($addon->OnUserCreate)
                eval ($addon->OnUserCreate . "(\$user);");
        }
    }
    
    public static function NotifyUserUpdate($user) {
        global $Addons;
        foreach ($Addons as $addon) {
            if ($addon->OnUserUpdate)
                eval ($addon->OnUserUpdate . "(\$user);");
        }
    }
    
    public static function NotifyUserDelete($user) {
        global $Addons;
        foreach ($Addons as $addon) {
            if ($addon->OnUserDelete)
                eval ($addon->OnUserDelete . "(\$user);");
        }
    }
    
    public static function NotifyUserLogout($user) {
        global $Addons;
        foreach ($Addons as $addon) {
            if ($addon->OnUserLogout)
                eval ($addon->OnUserLogout . "(\$user);");
        }
    }
}