1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 

<?php
/**
 * Handles all functions related to 3rd party libraries within ImpressCMS
 *
 * @copyright   http://www.impresscms.org/ The ImpressCMS Project
 * @license     LICENSE.txt
 * @category    ICMS
 * @package     Preload
 * @subpackage  Libraries
 * @since       1.1
 * @author      marcan <marcan@impresscms.org>
 * @author      modified by UnderDog <underdog@impresscms.org>
 * @version     SVN: $Id: LibrariesHandler.php 10868 2010-12-11 12:02:57Z phoenyx $
 */

defined('ICMS_ROOT_PATH') or die("ImpressCMS root path not defined");

/**
 * icms_preload_LibrariesHandler
 *
 * Class handling third party libraries within ImpressCMS
 *
 * @copyright   The ImpressCMS Project http://www.impresscms.org/
 * @license     http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License (GPL)
 * @category    ICMS
 * @package     Preload
 * @subpackage  Libraries
 * @since       1.1
 * @author      marcan <marcan@impresscms.org>
 */
class icms_preload_LibrariesHandler {
    /**
     * @public array $_librariesArray array containing a list of all available third party libraries
     */
    public $_librariesArray=array();

    /**
     * Constructor
     *
     * @return  void
     */
    public function __construct() {
        $librariesArray = icms_core_Filesystem::getDirList(ICMS_LIBRARIES_PATH);
        foreach ($librariesArray as $library) {
            $library_boot_file = $this->getLibraryBootFilePath($library);
            if (file_exists($library_boot_file)) {
                include_once $library_boot_file;
                $this->_librariesArray[] = $library;
            }
        }
    }

    /**
     * Access the only instance of this class
     *
     *
     * @return  object
     */
    static public function &getInstance() {
        static $instance;
        if (!isset($instance)) {
            $instance = new self();
        }
        return $instance;
    }

    /**
     * Triggers a specific event on all the libraries
     *
     * Here are the currently supported events:
     * - finishCoreBoot : this event is triggered at the end of the core booting process (end of include/common.php)
     * - adminHeader : this event is triggered when calling icms_cp_header() and is used to output content in the head section of the admin side
     * - beforeFooter : this event is triggered when include/footer.php is called, at the begining of the file
     * - startOutputInit : this event is triggered when starting to output the content, in include/header.php after instantiation of $xoopsTpl
     *
     * @param $event string name of the event to trigger
     * @param $array mixed container to pass any arguments to be used by the library
     * @return  TRUE if successful, FALSE if not
     */
    public function triggerEvent($event, $array=false) {
        foreach($this->_librariesArray as $library) {
            $functionName = $this->getFunctionName($event, $library);
            if (function_exists($functionName)) {
                $ret = $functionName($array);
            }
        }
    }

    /**
     * Construct the path of the boot file a specified library
     *
     * @param $library string name of the library
     * @return  string path of the boot file of the specified library
     */
    public function getLibraryBootFilePath($library) {
        $ret = ICMS_LIBRARIES_PATH . '/' . $library . '/icms.library.' . $library . '.php';
        return $ret;
    }

    /**
     * Construct the name of the function which would be call on a specific event for a specific library
     *
     * @param $event string name of the event
     * @param $library string name of the library
     * @return  string name of the function
     */
    public function getFunctionName($event, $library) {
        $ret = 'icmsLibrary' . ucfirst($library) . '_' . $event;
        return $ret;
    }
}