Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_auth_Ads
  • icms_auth_Factory
  • icms_auth_Ldap
  • icms_auth_Object
  • icms_auth_Provisionning
  • icms_auth_Xoops
  • icms_Autoloader
  • icms_config_category_Handler
  • icms_config_category_Object
  • icms_config_Handler
  • icms_config_Item_Handler
  • icms_config_Item_Object
  • icms_config_option_Handler
  • icms_config_option_Object
  • icms_core_DataFilter
  • icms_core_Debug
  • icms_core_Filesystem
  • icms_core_HTMLFilter
  • icms_core_Logger
  • icms_core_Message
  • icms_core_Object
  • icms_core_ObjectHandler
  • icms_core_OnlineHandler
  • icms_core_Password
  • icms_core_Security
  • icms_core_Session
  • icms_core_StopSpammer
  • icms_core_Textsanitizer
  • icms_core_Versionchecker
  • icms_data_avatar_Handler
  • icms_data_avatar_Object
  • icms_data_comment_Handler
  • icms_data_comment_Object
  • icms_data_comment_Renderer
  • icms_data_file_Handler
  • icms_data_file_Object
  • icms_data_notification_Handler
  • icms_data_notification_Object
  • icms_data_page_Handler
  • icms_data_page_Object
  • icms_data_privmessage_Handler
  • icms_data_privmessage_Object
  • icms_data_urllink_Handler
  • icms_data_urllink_Object
  • icms_db_Connection
  • icms_db_criteria_Compo
  • icms_db_criteria_Element
  • icms_db_criteria_Item
  • icms_db_Factory
  • icms_db_legacy_Database
  • icms_db_legacy_Factory
  • icms_db_legacy_mysql_Database
  • icms_db_legacy_mysql_Proxy
  • icms_db_legacy_mysql_Safe
  • icms_db_legacy_mysql_Utility
  • icms_db_legacy_PdoDatabase
  • icms_db_legacy_updater_Handler
  • icms_db_legacy_updater_Table
  • icms_db_mysql_Connection
  • icms_db_mysql_Utility
  • icms_Event
  • icms_feeds_Rss
  • icms_feeds_Simplerss
  • icms_file_DownloadHandler
  • icms_file_MediaUploadHandler
  • icms_file_TarDownloader
  • icms_file_TarFileHandler
  • icms_file_ZipDownloader
  • icms_file_ZipFileHandler
  • icms_form_Base
  • icms_form_Element
  • icms_form_elements_Button
  • icms_form_elements_Captcha
  • icms_form_elements_captcha_Image
  • icms_form_elements_captcha_ImageHandler
  • icms_form_elements_captcha_Object
  • icms_form_elements_captcha_Text
  • icms_form_elements_Checkbox
  • icms_form_elements_Colorpicker
  • icms_form_elements_Date
  • icms_form_elements_Datetime
  • icms_form_elements_Dhtmltextarea
  • icms_form_elements_Editor
  • icms_form_elements_File
  • icms_form_elements_Groupperm
  • icms_form_elements_Hidden
  • icms_form_elements_Hiddentoken
  • icms_form_elements_Label
  • icms_form_elements_Password
  • icms_form_elements_Radio
  • icms_form_elements_Radioyn
  • icms_form_elements_Select
  • icms_form_elements_select_Country
  • icms_form_elements_select_Editor
  • icms_form_elements_select_Group
  • icms_form_elements_select_Image
  • icms_form_elements_select_Lang
  • icms_form_elements_select_Matchoption
  • icms_form_elements_select_Theme
  • icms_form_elements_select_Timezone
  • icms_form_elements_select_User
  • icms_form_elements_Text
  • icms_form_elements_Textarea
  • icms_form_elements_Tray
  • icms_form_Groupperm
  • icms_form_Simple
  • icms_form_Table
  • icms_form_Theme
  • icms_image_category_Handler
  • icms_image_category_Object
  • icms_image_Handler
  • icms_image_Object
  • icms_image_set_Handler
  • icms_image_set_Object
  • icms_ipf_About
  • icms_ipf_category_Handler
  • icms_ipf_category_Object
  • icms_ipf_Controller
  • icms_ipf_export_Handler
  • icms_ipf_export_Renderer
  • icms_ipf_form_Base
  • icms_ipf_form_elements_Autocomplete
  • icms_ipf_form_elements_Blockoptions
  • icms_ipf_form_elements_Checkbox
  • icms_ipf_form_elements_Date
  • icms_ipf_form_elements_Datetime
  • icms_ipf_form_elements_File
  • icms_ipf_form_elements_Fileupload
  • icms_ipf_form_elements_Image
  • icms_ipf_form_elements_Imageupload
  • icms_ipf_form_elements_Language
  • icms_ipf_form_elements_Page
  • icms_ipf_form_elements_Parentcategory
  • icms_ipf_form_elements_Passwordtray
  • icms_ipf_form_elements_Radio
  • icms_ipf_form_elements_Richfile
  • icms_ipf_form_elements_Section
  • icms_ipf_form_elements_Select
  • icms_ipf_form_elements_Selectmulti
  • icms_ipf_form_elements_Signature
  • icms_ipf_form_elements_Source
  • icms_ipf_form_elements_Text
  • icms_ipf_form_elements_Time
  • icms_ipf_form_elements_Upload
  • icms_ipf_form_elements_Urllink
  • icms_ipf_form_elements_User
  • icms_ipf_form_elements_Yesno
  • icms_ipf_form_Secure
  • icms_ipf_Handler
  • icms_ipf_Highlighter
  • icms_ipf_member_Handler
  • icms_ipf_Metagen
  • icms_ipf_Object
  • icms_ipf_permission_Handler
  • icms_ipf_registry_Handler
  • icms_ipf_seo_Object
  • icms_ipf_Tree
  • icms_ipf_view_Column
  • icms_ipf_view_Row
  • icms_ipf_view_Single
  • icms_ipf_view_Table
  • icms_ipf_view_Tree
  • icms_member_group_Handler
  • icms_member_group_membership_Handler
  • icms_member_group_membership_Object
  • icms_member_group_Object
  • icms_member_groupperm_Handler
  • icms_member_groupperm_Object
  • icms_member_Handler
  • icms_member_user_Handler
  • icms_member_user_Object
  • icms_messaging_EmailHandler
  • icms_messaging_Handler
  • icms_module_Handler
  • icms_module_Object
  • icms_plugins_EditorHandler
  • icms_plugins_Handler
  • icms_plugins_Object
  • icms_preload_Handler
  • icms_preload_Item
  • icms_preload_LibrariesHandler
  • icms_sys_autotasks_System
  • icms_Utils
  • icms_view_block_Handler
  • icms_view_block_Object
  • icms_view_block_position_Handler
  • icms_view_block_position_Object
  • icms_view_Breadcrumb
  • icms_view_PageBuilder
  • icms_view_PageNav
  • icms_view_Printerfriendly
  • icms_view_template_file_Handler
  • icms_view_template_file_Object
  • icms_view_template_set_Handler
  • icms_view_template_set_Object
  • icms_view_theme_Factory
  • icms_view_theme_Object
  • icms_view_Tpl
  • icms_view_Tree

Interfaces

  • icms_db_IConnection
  • icms_db_IUtility
  • icms_db_legacy_IDatabase
  • icms_sys_autotasks_ISystem
  • Overview
  • Package
  • Class
  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: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 
<?php
/**
 * Information about a module
 *
 * @copyright       http://www.impresscms.org/ The ImpressCMS Project
 * @license     LICENSE.txt
 * @category    ICMS
 * @package     Ipf
 * @since       1.1
 * @author      marcan <marcan@impresscms.org>
 * @version     SVN: $Id: About.php 11311 2011-07-20 08:08:45Z mcdonald3072 $
 */

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

/**
 * icms_ipf_About
 *
 * Simple class that lets you build an about page
 *
 * @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     Ipf
 * @since       1.0
 * @author      marcan <marcan@impresscms.org>
 * @todo        Properly set visibility of vars
 */

class icms_ipf_About {
    public $_lang_aboutTitle;
    public $_lang_author_info;
    public $_lang_developer_lead;
    public $_lang_developer_contributor;
    public $_lang_developer_website;
    public $_lang_developer_email;
    public $_lang_developer_credits;
    public $_lang_module_info;
    public $_lang_module_status;
    public $_lang_module_release_date;
    public $_lang_module_demo;
    public $_lang_module_support;
    public $_lang_module_bug;
    public $_lang_module_submit_bug;
    public $_lang_module_feature;
    public $_lang_module_submit_feature;
    public $_lang_module_disclaimer;
    public $_lang_author_word;
    public $_lang_version_history;
    public $_lang_by;
    public $_tpl;

    /**
     * Constructor
     *
     * Initiate the object, based on the module
     *
     * @param string $aboutTitle text used in the extreme right caption of the menu
     * @return icms_ipf_About
     */

    public function __construct($aboutTitle = _MODABOUT_ABOUT) {
        global $icmsConfig;

        icms_loadLanguageFile(icms::$module->getVar("dirname"), 'modinfo');
        icms_loadLanguageFile('core', 'moduleabout');

        $this->_aboutTitle = $aboutTitle;

        $this->_lang_developer_contributor = _MODABOUT_DEVELOPER_CONTRIBUTOR;
        $this->_lang_developer_website = _MODABOUT_DEVELOPER_WEBSITE;
        $this->_lang_developer_email = _MODABOUT_DEVELOPER_EMAIL;
        $this->_lang_developer_credits = _MODABOUT_DEVELOPER_CREDITS;
        $this->_lang_module_info = _MODABOUT_MODULE_INFO;
        $this->_lang_module_status = _MODABOUT_MODULE_STATUS;
        $this->_lang_module_release_date =_MODABOUT_MODULE_RELEASE_DATE ;
        $this->_lang_module_demo = _MODABOUT_MODULE_DEMO;
        $this->_lang_module_support = _CO_ICMS_MODULE_SUPPORT;
        $this->_lang_module_bug = _MODABOUT_MODULE_BUG;
        $this->_lang_module_submit_bug = _MODABOUT_MODULE_SUBMIT_BUG;
        $this->_lang_module_feature = _MODABOUT_MODULE_FEATURE;
        $this->_lang_module_submit_feature = _CO_ICMS_MODULE_SUBMIT_FEATURE;
        $this->_lang_module_disclaimer = _MODABOUT_MODULE_DISCLAIMER;
        $this->_lang_author_word = _MODABOUT_AUTHOR_WORD;
        $this->_lang_version_history = _MODABOUT_VERSION_HISTORY;
    }

    /**
     * Sanitize a value
     *
     * @param string $value to be sanitized
     * @return string sanitized value
     */
    public function sanitize($value) {
        return icms_core_DataFilter::checkVar($value, 'html', 'input'); // using input
    }

    /**
     * Render the whole About page of a module
     *
     */
    public function render() {
        global $icmsConfig;

        icms_cp_header();

        $module_handler = icms::handler('icms_module');
        $versioninfo =& $module_handler->get(icms::$module->getVar('mid'));

        icms::$module->displayAdminMenu(-1, $this->_aboutTitle . " " . $versioninfo->getInfo('name'));

        $this->_tpl = new icms_view_Tpl();

        $this->_tpl->assign('module_url', ICMS_URL . "/modules/" . icms::$module->getVar('dirname') . "/");
        $this->_tpl->assign('module_image', $versioninfo->getInfo('image'));
        $this->_tpl->assign('module_name', $versioninfo->getInfo('name'));
        $this->_tpl->assign('module_version', $versioninfo->getInfo('version'));
        $this->_tpl->assign('module_status_version', $versioninfo->getInfo('status_version'));

        // Left headings...
        if ($versioninfo->getInfo('author_realname') != '') {
            $author_name = $versioninfo->getInfo('author') . " (" . $versioninfo->getInfo('author_realname') . ")";
        } else {
            $author_name = $versioninfo->getInfo('author');
        }
        $this->_tpl->assign('module_author_name', $author_name);

        $this->_tpl->assign('module_license', $versioninfo->getInfo('license'));

        $this->_tpl->assign('module_credits', $versioninfo->getInfo('credits'));

        // Developers Information
        $this->_tpl->assign('module_developer_lead', $versioninfo->getInfo('developer_lead'));
        $this->_tpl->assign('module_developer_contributor', $versioninfo->getInfo('developer_contributor'));
        $this->_tpl->assign('module_developer_website_url', $versioninfo->getInfo('developer_website_url'));
        $this->_tpl->assign('module_developer_website_name', $versioninfo->getInfo('developer_website_name'));
        $this->_tpl->assign('module_developer_email', $versioninfo->getInfo('developer_email'));

        $people = $versioninfo->getInfo('people');
        if ($people) {

            $this->_tpl->assign('module_people_developers', isset($people['developers'])
                ? array_map(array($this, 'sanitize'), $people['developers'])
                : false
            );
            $this->_tpl->assign('module_people_testers', isset($people['testers'])
                ? array_map(array($this, 'sanitize'), $people['testers'])
                : false
            );
            $this->_tpl->assign('module_people_translators', isset($people['translators'])
                ? array_map(array($this, 'sanitize'), $people['translators'])
                : false
            );
            $this->_tpl->assign('module_people_documenters', isset($people['documenters'])
                ? array_map(array($this, 'sanitize'), $people['documenters'])
                : false
            );
            $this->_tpl->assign('module_people_other', isset($people['other'])
                ? array_map(array($this, 'sanitize'), $people['other'])
                : false
            );
        }
        //$this->_tpl->assign('module_developers', $versioninfo->getInfo('developer_email'));

        // Module Development information
        $this->_tpl->assign('module_date', $versioninfo->getInfo('date'));
        $this->_tpl->assign('module_status', $versioninfo->getInfo('status'));
        $this->_tpl->assign('module_demo_site_url', $versioninfo->getInfo('demo_site_url'));
        $this->_tpl->assign('module_demo_site_name', $versioninfo->getInfo('demo_site_name'));
        $this->_tpl->assign('module_support_site_url', $versioninfo->getInfo('support_site_url'));
        $this->_tpl->assign('module_support_site_name', $versioninfo->getInfo('support_site_name'));
        $this->_tpl->assign('module_submit_bug', $versioninfo->getInfo('submit_bug'));
        $this->_tpl->assign('module_submit_feature', $versioninfo->getInfo('submit_feature'));

        // Manual
        $manual =$versioninfo->getInfo('manual');
        if ($manual) {
            $this->_tpl->assign('module_manual', isset($manual['wiki']) ? array_map(array($this, 'sanitize'), $manual['wiki']) : false);
        }

        // Warning
        $this->_tpl->assign('module_warning', icms_core_DataFilter::checkVar($versioninfo->getInfo('warning'), 'html', 'input'));

        // Author's note
        $this->_tpl->assign('module_author_word', $versioninfo->getInfo('author_word'));

        // For changelog thanks to 3Dev

        $filename = ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/changelog.txt';
        if (is_file($filename)) {

            $filesize = filesize($filename);
            $handle = fopen($filename, 'r');
            $this->_tpl->assign('module_version_history', icms_core_DataFilter::checkVar(fread($handle, $filesize), 'text', 'output'));
            fclose($handle);
        }

        $filename = ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/docs/changelog.txt';
        if (is_file($filename)) {

            $filesize = filesize($filename);
            $handle = fopen($filename, 'r');
            $this->_tpl->assign('module_version_history', icms_core_DataFilter::checkVar(fread($handle, $filesize), 'text', 'output'));
            fclose($handle);
        }

        // For license thanks to 3Dev
        if (file_exists( ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/docs/license.txt' )) {
            $filename = ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/docs/license.txt';
        } elseif (file_exists( ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/docs/' . $icmsConfig['language'] . '_license.txt' )) {
            $filename = ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/docs/' . $icmsConfig['language'] . '_license.txt';
        } elseif (file_exists( ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/license.txt' )) {
            $filename = ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/license.txt';
        } elseif (file_exists( ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/license/' . $icmsConfig['language'] . '_license.txt' )) {
            $filename = ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/license/' . $icmsConfig['language'] . '_license.txt';
        } elseif (file_exists( ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/license.txt' )) {
            $filename = ICMS_ROOT_PATH . '/modules/' . icms::$module->getVar('dirname') . '/license.txt';
        }
        if (is_file($filename)) {
            $filesize = filesize($filename);
            $handle = fopen($filename, 'r');
            $this->_tpl->assign('module_license_txt', icms_core_DataFilter::checkVar(fread($handle, $filesize), 'text', 'output'));
            fclose($handle);
        }

        $this->_tpl->display('db:system_adm_moduleabout.html');

        icms_cp_footer();
    }
}

API documentation generated by ApiGen