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: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 
<?php
//  ------------------------------------------------------------------------ //
//                XOOPS - PHP Content Management System                      //
//                    Copyright (c) 2000 XOOPS.org                           //
//                       <http://www.xoops.org/>                             //
//  ------------------------------------------------------------------------ //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  You may not change or alter any portion of this comment or credits       //
//  of supporting developers from this source code or any supporting         //
//  source code which is considered copyrighted (c) material of the          //
//  original comment or credit authors.                                      //
//                                                                           //
//  This program is distributed in the hope that it will be useful,          //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of           //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            //
//  GNU General Public License for more details.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write to the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
//  ------------------------------------------------------------------------ //
// Author: Kazumi Ono (AKA onokazu)                                          //
// URL: http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ //
// Project: The XOOPS Project                                                //
// ------------------------------------------------------------------------- //
/**
 * icms_view_theme_Object component class file
 *
 * @license      http://www.fsf.org/copyleft/gpl.html GNU public license
 * @version     $Id: Object.php 12313 2013-09-15 21:14:35Z skenow $
 * @category    ICMS
 * @package     View
 * @subpackage  Theme
 */
/**
 *
 * Builds the theme components
 * @author       Skalpa Keo <skalpa@xoops.org>
 * @copyright   Copyright (c) 2000 XOOPS.org
 * @category    ICMS
 * @package     View
 * @subpackage  Theme
 */
class icms_view_theme_Object {
    /**
     * The name of this theme
     * @public string
     */
    public $folderName = '';
    /**
     * Physical path of this theme folder
     * @public string
     */
    public $path = '';
    public $url = '';

    /**
     * Whether or not the theme engine should include the output generated by php
     * @public string
     */
    public $bufferOutput = TRUE;
    /**
     * Canvas-level template to use
     * @public string
     */
    public $canvasTemplate = 'theme.html';
    /**
     * Content-level template to use
     * @public string
     */
    public $contentTemplate = '';

    public $contentCacheLifetime = 0;
    public $contentCacheId = NULL;

    /**
     * Text content to display right after the contentTemplate output
     * @public string
     */
    public $content = '';
    /**
     * Page construction plug-ins to use
     * @public array
     */
    public $plugins = array('icms_view_PageBuilder');

    public $renderCount = 0;
    /**
     * Pointer to the theme template engine
     * @public icms_view_Tpl
     */
    public $template = FALSE;

    /**
     * Array containing the document meta-information
     */
    public $metas = array(
        'head' => array(),
        'module' => array(),
        'foot' => array(),
    );
    /**
     * Array of meta types - their order in the array determines their rendering sequence
     */
    public $types = array('http', 'meta', 'link', 'stylesheet', 'script', 'property', 'itemprop');

    /**
     * Array of strings to be inserted in the head tag of HTML documents
     * @public array
     */
    public $htmlHeadStrings = array();
    /**
     * Custom publiciables that will always be assigned to the template
     * @public array
     */
    public $templateVars = array();

    /**
     * User extra information for cache id, like language, user groups
     *
     * @public boolean
     */
    public $use_extra_cache_id = TRUE;

    /**#@-*/

    /**#@+ @tasktype 10 Initialization*/
    /**
     * Initializes this theme
     *
     * Upon initialization, the theme creates its template engine and instanciates the
     * plug-ins from the specified {@link $plugins} list. If the theme is a 2.0 theme, that does not
     * display redirection messages, the HTTP redirections system is disabled to ensure users will
     * see the redirection screen.
     *
     * @param array $options
     * @return bool
     */
    public function xoInit($options = array()) {
        global $xoops;

        $this->path = (is_dir(ICMS_MODULES_PATH . '/system/themes/' . $this->folderName))
            ? ICMS_MODULES_PATH . '/system/themes/' . $this->folderName
            : ICMS_THEME_PATH . '/' . $this->folderName;
        $this->url = (is_dir(ICMS_MODULES_PATH . '/system/themes/' . $this->folderName))
            ? ICMS_MODULES_URL . '/system/themes/' . $this->folderName
            : ICMS_THEME_URL . '/' . $this->folderName;

        $this->template = new icms_view_Tpl();
        $this->template->currentTheme =& $this;
        $this->template->assign_by_ref('xoTheme', $this);

        global $icmsConfig, $icmsConfigMetaFooter, $icmsModule, $xoopsModule;
        $this->template->assign(
            array(
                'icms_style' => ICMS_URL . '/icms' . ((defined('_ADM_USE_RTL') && _ADM_USE_RTL) ? '_rtl' : '') . '.css',
                'icms_theme' => $this->folderName,
                'icms_imageurl' => (is_dir(ICMS_MODULES_PATH . '/system/themes/' . $this->folderName . '/'))
                    ? ICMS_MODULES_URL . '/system/themes/' . $this->folderName . '/'
                    : ICMS_THEME_URL . '/' . $this->folderName . '/',
                'icms_themecss'=> xoops_getcss($this->folderName),
                'icms_requesturi' => htmlspecialchars($_SERVER['REQUEST_URI'], ENT_QUOTES),
                'icms_sitename' => htmlspecialchars($icmsConfig['sitename'], ENT_QUOTES),
                'icms_slogan' => htmlspecialchars($icmsConfig['slogan'], ENT_QUOTES),
                'icms_dirname' => @$icmsModule ? $icmsModule->getVar('dirname') : 'system',
                'icms_pagetitle' => isset($icmsModule) && is_object($icmsModule)
                        ? $icmsModule->getVar('name')
                        : htmlspecialchars($icmsConfig['slogan'], ENT_QUOTES)
            )
        );

        // this is for backward compatibility only!
        $this->template->assign(array(
            'xoops_theme' => $this->template->get_template_vars('icms_theme'),
            'xoops_imageurl' => $this->template->get_template_vars('icms_imageurl'),
            'xoops_themecss' => $this->template->get_template_vars('icms_themecss'),
            'xoops_requesturi' => $this->template->get_template_vars('icms_requesturi'),
            'xoops_sitename' => $this->template->get_template_vars('icms_sitename'),
            'xoops_slogan' => $this->template->get_template_vars('icms_slogan'),
            'xoops_dirname' => $this->template->get_template_vars('icms_dirname'),
        ));
        if (isset(icms::$user) && is_object(icms::$user)) {
            $this->template->assign(array(
                'icms_isuser' => TRUE,
                'icms_userid' => icms::$user->getVar('uid'),
                'icms_uname' => icms::$user->getVar('uname'),
                'icms_isadmin' => icms::$user->isAdmin(),
                'xoops_isuser' => TRUE,
                'xoops_userid' => icms::$user->getVar('uid'),
                'xoops_uname' => icms::$user->getVar('uname'),
                'xoops_isadmin' => icms::$user->isAdmin(),
                )
            );
        } else {
            $this->template->assign(
                array('icms_isuser' => FALSE,
                    'icms_isadmin' => FALSE,
                    'xoops_isuser' => FALSE,
                    'xoops_isadmin' => FALSE
                )
            );
        }
        // Meta tags
        foreach ($icmsConfigMetaFooter as $name => $value) {
            if (substr($name, 0, 5) == 'meta_') {
                $this->addMeta('meta', substr($name, 5), $value);
            } elseif (substr($name, 0, 6) == 'footer') {
                $values = $value;
                $this->template->assign("xoops_$name", $values);
                $this->template->assign("icms_$name", $values);
            } else {
                // prefix each tag with 'xoops_'
                $this->template->assign("xoops_$name", $value);
                $this->template->assign("icms_$name", $value);
            }
        }

        if ($this->bufferOutput) {
            ob_start();
        }
        $GLOBALS['xoTheme'] =& $this;
        $GLOBALS['xoopsTpl'] =& $this->template;
        // Instanciate and initialize all the theme plugins
        foreach ($this->plugins as $k => $bundleId) {
            if (!is_object($bundleId)) {
                $this->plugins[$bundleId] = new $bundleId();
                $this->plugins[$bundleId]->theme =& $this;
                $this->plugins[$bundleId]->xoInit();
                unset($this->plugins[$k]);
            }
        }
        return TRUE;
    }
    /**#@-*/

    /**
     * Generate cache id based on extra information of language and user groups
     *
     * User groups other than anonymous should be detected to avoid disclosing group sensitive contents
     *
     * @param string    $cache_id       raw cache id
     * @param string    $extraString    extra string
     *
     * @return string   complete cache id
     */
    public function generateCacheId($cache_id, $extraString = '') {
        static $extra_string;

        if (!$this->use_extra_cache_id) {
            return $cache_id;
        }

        if (empty($extraString)) {
            if (empty($extra_string)) {
                global $icmsConfig;

                // Generate language section
                $extra_string = $icmsConfig['language'];

                // Generate group section
                if (!@is_object(icms::$user)) {
                    $extra_string .= '|' . ICMS_GROUP_ANONYMOUS;
                } else {
                    $groups = icms::$user->getGroups();
                    sort($groups);
                    // Generate group string for non-anonymous groups,
                    // XOOPS_DB_PASS and XOOPS_DB_NAME (before we find better variables) are used to protect group sensitive contents
                    $extra_string .= '|' . implode(",", $groups)
                        . substr(md5(XOOPS_DB_PASS . XOOPS_DB_NAME), 0, strlen(XOOPS_DB_USER) * 2);
                }
            }
            $extraString = $extra_string;
        }
        $cache_id .= '|' . $extraString;

        return $cache_id;
    }

    /**
     * Checks cache for a changed version of the template and renders template
     * @return  bool
     */
    public function checkCache() {
        global $xoopsModule, $icmsModule;

        if ($_SERVER['REQUEST_METHOD'] != 'POST' && $this->contentCacheLifetime) {
            $template = $this->contentTemplate ? $this->contentTemplate : 'db:system_dummy.html';
            $dirname = $icmsModule->getVar('dirname', 'n');

            $this->template->caching = 2;
            $this->template->cache_lifetime = $this->contentCacheLifetime;
            $uri = str_replace(ICMS_URL, '', $_SERVER['REQUEST_URI']);
            // Clean uri by removing session id
            if (defined('SID') && SID && strpos($uri, SID)) {
                $uri = preg_replace("/([\?&])(" . SID . "$|" . SID . "&)/", "\\1", $uri);
            }
            $this->contentCacheId = $this->generateCacheId($dirname . '|' . $uri);

            if ($this->template->is_cached($template, $this->contentCacheId)) {
                icms::$logger->addExtra($template, sprintf(_REGENERATES, $this->contentCacheLifetime));
                $this->render(NULL, NULL, $template);
                return TRUE;
            }
        }
        return FALSE;
    }

    /**
     * Render the page
     *
     * The theme engine builds pages from 2 templates: canvas and content.
     *
     * A module can call this method directly and specify what templates the theme engine must use.
     * If render() hasn't been called before, the theme defaults will be used for the canvas and
     * page template (and xoopsOption['template_main'] for the content).
     *
     * @param string $canvasTpl     The canvas template, if different from the theme default
     * @param string $pageTpl       The page template, if different from the theme default (unsupported, 2.3+ only)
     * @param string $contentTpl    The content template
     * @param array  $vars          Template variables to send to the template engine
     */
    public function render($canvasTpl = NULL, $pageTpl = NULL, $contentTpl = NULL, $vars = array()) {
        global $xoops, $xoopsOption;

        if ($this->renderCount) {
            return FALSE;
        }
        icms::$logger->startTime('Page rendering');

        // @internal: Lame fix to ensure the metas specified in the xoops config page don't appear twice
        $old = array('robots', 'keywords', 'description', 'rating', 'author', 'copyright');
        foreach ($this->metas['module']['meta'] as $name => $value) {
            if (in_array($name, $old)) {
                $this->template->assign("xoops_meta_$name", htmlspecialchars($value['value'], ENT_QUOTES));
                $this->template->assign("icms_meta_$name", htmlspecialchars($value['value'], ENT_QUOTES));
                unset($this->metas['module']['meta'][$name]);
            }
        }

        if ($canvasTpl) $this->canvasTemplate   = $canvasTpl;
        if ($contentTpl) $this->contentTemplate = $contentTpl;

        if (!empty($vars)) {
            $this->template->assign($vars);
        }
        if ($this->contentTemplate) {
            $this->content = $this->template->fetch($this->contentTemplate, $this->contentCacheId);
        }
        if ($this->bufferOutput) {
            $this->content .= ob_get_contents();
            ob_end_clean();
        }
        $this->template->assign_by_ref('xoops_contents', $this->content);
        $this->template->assign_by_ref('icms_contents', $this->content);

        $header = empty($xoopsOption['icms_module_header'])
            ? $this->template->get_template_vars('icms_module_header')
            : $xoopsOption['icms_module_header'];
        /** @todo   Remove xoops_module_header in 2.0 */
        $xheader = empty($xoopsOption['xoops_module_header'])
            ? $this->template->get_template_vars('xoops_module_header')
            : $xoopsOption['xoops_module_header'];
        if ($xheader != "") icms_core_Debug::setDeprecated('icms_module_header', sprintf(_CORE_REMOVE_IN_VERSION, "2.0"));
        $header = ($header != "") ? $header : $xheader;
        $this->template->assign('xoops_module_header', $header . "\n" . $this->renderOldMetas(NULL, TRUE));
        $this->template->assign('icms_module_header', $header . "\n" . $this->renderOldMetas(NULL, TRUE));

        /* create template vars for the new meta zones */
        foreach ($this->metas as $zone => $value) {
            $this->template->assign($zone, "<!-- " . ucfirst($zone) . " section-->\n" . $this->renderMetas(NULL, TRUE, $zone));
        }

        $pagetitle = empty($xoopsOption['icms_pagetitle'])
            ? $this->template->get_template_vars('icms_pagetitle')
            : $xoopsOption['icms_pagetitle'];
        /** @todo   Remove xoops_pagetitle in 2.0 */
        $xpagetitle = empty($xoopsOption['xoops_pagetitle'])
            ? $this->template->get_template_vars('xoops_pagetitle')
            : $xoopsOption['xoops_pagetitle'];
        if ($xpagetitle != "") icms_core_Debug::setDeprecated('icms_pagetitle', sprintf(_CORE_REMOVE_IN_VERSION, "2.0"));
        $pagetitle = ($pagetitle != "") ? $pagetitle : $xpagetitle;
        $this->template->assign('xoops_pagetitle', $pagetitle);
        $this->template->assign('icms_pagetitle', $pagetitle);

        // Do not cache the main (theme.html) template output
        $this->template->caching = 0;
        $this->template->display($this->path . '/' . $this->canvasTemplate);

        $this->renderCount++;
        icms::$logger->stopTime('Page rendering');
    }

    /**#@+ @tasktype 20 Manipulating page meta-information*/
    /**
     * Adds script code to the document head
     *
     * This methods allows the insertion of an external script file (if $src is provided), or
     * of a script snippet. The file URI is parsed to take benefit of the theme resource
     * overloading system.
     *
     * The $attributes parameter allows you to specify the attributes that will be added to the
     * inserted <script> tag. If unspecified, the <var>type</var> attribute value will default to
     * 'text/javascript'.
     *
     * <code>
     * // Add an external script using a physical path
     * $theme->addScript('www/script.js', NULL, '');
     * $theme->addScript('modules/newbb/script.js', NULL, '');
     * // Specify attributes for the <script> tag
     * $theme->addScript('mod_xoops_SiteManager#common.js', array('type' => 'application/x-javascript'), '');
     * // Insert a code snippet
     * $theme->addScript(NULL, array('type' => 'application/x-javascript'), 'window.open("Hello world");');
     * </code>
     *
     * @param string $src path to an external script file
     * @param array $attributes hash of attributes to add to the <script> tag
     * @param string $content Code snippet to output within the <script> tag
     * @param   str $zone   Area of the HTML page to place the script
     * @param   int $weight Sort factor - lower weights are loaded first
     *
     * @return void
     **/
    public function addScript($src = '', $attributes = array(), $content = '', $zone = 'module', $weight = 0) {

        if (empty($attributes)) {
            $attributes = array();
        }
        if (!empty($src)) {
            $attributes['src'] = icms::url($this->resourcePath($src));
        }
        if (!empty($content)) {
            $attributes['_'] = $content;
        }
        if (!isset($attributes['type'])) {
            $attributes['type'] = 'text/javascript';
        }
        $this->addMeta('script', $src, $attributes, $zone, $weight);
    }

    /**
     * Add StyleSheet or CSS code to the document head
     * @param string $src path to .css file
     * @param array $attributes name => value paired array of attributes such as title
     * @param string $content CSS code to output between the <style> tags (in case $src is empty)
     * @param   str $zone   Area of the HTML page to place the stylesheet
     * @param   int $weight Sort factor - lower weights are loaded first
     *
     * @return void
     **/
    public function addStylesheet($src = '', $attributes = array(), $content = '', $zone = 'module', $weight = 0) {

        if (empty($attributes)) {
            $attributes = array();
        }
        if (!empty($src)) {
            $attributes['href'] = icms::url($this->resourcePath($src));
        }
        if (!isset($attributes['type'])) {
            $attributes['type'] = 'text/css';
        }
        if (!empty($content)) {
            $attributes['_'] = $content;
        }
        $this->addMeta('stylesheet', $src, $attributes, $zone, $weight);
    }

    /**
     * Add a <link> to the header
     * @param string    $rel        Relationship from the current doc to the anchored one
     * @param string    $href       URI of the anchored document
     * @param array     $attributes Additional attributes to add to the <link> element
     * @param   str $zone   Area of the HTML page to place the link
     * @param   int $weight Sort factor - lower weights are loaded first
     */
    public function addLink($rel, $href = '', $attributes = array(), $zone = 'module', $weight = 0) {


        if (empty($attributes)) {
            $attributes = array();
        }
        if (!empty($href)) {
            $attributes['href'] = $href;
        }
        $this->addMeta('link', $rel, $attributes, $zone, $weight);
    }

    /**
     * Set a meta http-equiv value
     * @param   str $zone   Area of the HTML page to place the http meta
     * @param   int $weight Sort factor - lower weights are loaded first
     */
    public function addHttpMeta($name, $value = NULL, $zone = 'module', $weight = 0) {
        if (isset($value)) {
            return $this->addMeta('http', $name, $value, $zone, $weight);
        }
        unset($this->metas[$zone]['http'][$name]);
    }

    /**
     * Set a meta property value, mostly used by Facebook Graph nowadays
     * @param   str $zone   Area of the HTML page to place the property meta
     * @param   int $weight Sort factor - lower weights are loaded first
     */
    public function addPropertyMeta($name, $value = NULL, $zone = 'module', $weight = 0) {
        if (isset($value)) {
            return $this->addMeta('property', $name, $value, $zone, $weight);
        }
        unset($this->metas[$zone]['property'][$name]);
    }

    /**
     * Set a meta itemprop value, mostly used by Google+ nowadays
     * @param   str $zone   Area of the HTML page to place the itemprop meta
     * @param   int $weight Sort factor - lower weights are loaded first
     */
    public function addItempropMeta($name, $value = NULL, $zone = 'module', $weight = 0) {
        if (isset($value)) {
            return $this->addMeta('itemprop', $name, $value, $zone, $weight);
        }
        unset($this->metas[$zone]['itemprop'][$name]);
    }

    /**
     * Change output page meta-information
     *
     * @param   str $type   Type of meta tag: script, link, stylesheet, http
     * @param   str $name   Name
     * @param   str $value
     * @param   str $zone   Area of the HTML page to place the meta
     * @param   int $weight Sort factor - lower weights are loaded first
     */
    function addMeta($type = 'meta', $name = '', $value = '', $zone = 'module', $weight = 0) {
        !empty($zone) || $zone = 'module';
        if (!isset($this->metas[$zone][$type])) {
            $this->metas[$zone][$type] = array();
        }
        if (!empty($name)) {
            $this->metas[$zone][$type][$name] = array('value' => $value, 'weight' => $weight);
        } else {
            $this->metas[$zone][$type][] = array('value' => $value, 'weight' => $weight);
        }

        return $value;
    }

    /**
     * Puts $content into the htmlheadstrings array
     *
     * @param   string  $params
     * @param   string  $content    content to put in the htmlheadstrings array
     * @param   string  &$smarty
     * @param   string  &$repeat
     */
    public function headContent($params, $content, &$smarty, &$repeat) {
        if (!$repeat) {
            $this->htmlHeadStrings[] = $content;
        }
    }

    /**
     * Render the meta content in the metas array (carefull Recursive!)
     *
     * @param   string  $type     what type of metacontent is it
     * @param   string  $return   will we return to the calling function (just default setting)
     * @return  bool
     */
    public function renderMetas($type = NULL, $return = FALSE, $zone = 'module') {
        $str = '';
        if (!isset($type)) {
            if (!is_array($this->metas[$zone])) return;
            $types = $this->types;
            $usedTypes = array_keys($this->metas[$zone]);
            foreach (array_intersect($types, $usedTypes) as $type) {
                $str .= $this->renderMetas($type, TRUE, $zone);
            }
            $str .= implode("\n", $this->htmlHeadStrings);
        } else {
            $sort = array();
            foreach($this->metas[$zone][$type] as $name => $item) {
                $sort[] = $item['weight'];
            }
            array_multisort(array_values($sort), array_keys($sort), $this->metas[$zone][$type]);
            switch($type) {
                case 'script':
                    foreach ($this->metas[$zone][$type] as $attrs) {
                        $str .= '<script' . $this->renderAttributes($attrs['value']) . ">";
                        if (@$attrs['value']['_']) {
                            $str .= "\n" . $attrs['value']['_'] . "\n";
                        }
                        $str .= "</script>\n";
                    }
                    break;

                case 'link':
                    foreach ($this->metas[$zone][$type] as $rel => $attrs) {
                        $str .= '<link rel="' . $rel . '"' . $this->renderAttributes($attrs['value']) . " />\n";
                    }
                    break;

                case 'stylesheet':
                    foreach ($this->metas[$zone][$type] as $attrs) {
                        if (@$attrs['value']['_']) {
                            $str .= '<style' . $this->renderAttributes($attrs['value']) . ">\n" . $attrs['value']['_'] . "\n</style>";
                        } else {
                            $str .= '<link rel="stylesheet"' . $this->renderAttributes($attrs['value']) . " />\n";
                        }
                    }
                    break;

                case 'http':
                    foreach ($this->metas[$zone][$type] as $name => $content) {
                        $str .= '<meta http-equiv="' . htmlspecialchars($name, ENT_QUOTES) . '" content="' . htmlspecialchars($content, ENT_QUOTES) . "\" />\n";
                    }
                    break;

                case 'property':
                    foreach ($this->metas[$zone][$type] as $name => $content) {
                        $str .= '<meta property="' . htmlspecialchars($name, ENT_QUOTES) . '" content="' . htmlspecialchars($content, ENT_QUOTES) . "\" />\n";
                    }
                    break;

                case 'itemprop':
                    foreach ($this->metas[$zone][$type] as $name => $content) {
                        $str .= '<meta itemprop="' . htmlspecialchars($name, ENT_QUOTES) . '" content="' . htmlspecialchars($content, ENT_QUOTES) . "\" />\n";
                    }
                    break;


                default:
                    foreach ($this->metas[$zone][$type] as $name => $content) {
                        $str .= '<meta name="' . htmlspecialchars($name, ENT_QUOTES) . '" content="' . htmlspecialchars($content['value'], ENT_QUOTES) . "\" />\n";
                    }
                    break;
            }
        }
        if ($return) {
            return $str;
        }
        echo $str;
        return TRUE;
    }
    /**
     * Legacy method to render all the zones as a single zone
     *
     * @param   str     $type
     * @param   bool    $return
     * @return  str     string of the old metas
     */
    public function renderOldMetas($type = NULL, $return = TRUE) {
        $str = '';
        // loop through and render all the zones
        foreach ($this->metas as $z => $values) {
            $str .= $this->renderMetas($type, TRUE, $z);
        }
        return $str;
    }

    /**
     * Generates a unique element ID
     * @param string $tagName
     * @return string
     */
    public function genElementId($tagName = 'xos') {
        static $cache = array();
        if (!isset($cache[$tagName])) {
            $cache[$tagName] = 1;
        }
        return $tagName . '-' . $cache[$tagName]++;
    }

    /**
     * Transform an attributes collection to an XML string
     * @param array $coll
     * @return string
     */
    public function renderAttributes($coll) {
        $str = '';
        foreach ($coll as $name => $val) {
            if ($name != '_') {
                $str .= ' ' . $name . '="' . htmlspecialchars($val, ENT_QUOTES) . '"';
            }
        }
        return $str;
    }

    /**
     * Return a themable file resource path
     *
     * @param string $path
     * @return string
     */
    public function resourcePath($path) {

        if (substr($path, 0, 1) == '/') {
            $path = substr($path, 1);
        }
        if (file_exists("$this->path/$path")) {
            return "themes/$this->folderName/$path";
        }
        return $path;
    }
}
API documentation generated by ApiGen