t3lib/class.t3lib_pagerenderer.php

   1 <?php
   2 /***************************************************************
   3  *  Copyright notice
   4  *
   5  *  (c) 2009 Steffen Kamper (info@sk-typo3.de)
   6  *  All rights reserved
   7  *
   8  *  This script is part of the TYPO3 project. The TYPO3 project is
   9  *  free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  The GNU General Public License can be found at
  15  *  http://www.gnu.org/copyleft/gpl.html.
  16  *  A copy is found in the textfile GPL.txt and important notices to the license
  17  *  from the author is found in LICENSE.txt distributed with these scripts.
  18  *
  19  *
  20  *  This script is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  This copyright notice MUST APPEAR in all copies of the script!
  26  ***************************************************************/
  27
  28 /**
  29  * TYPO3 pageRender class (new in TYPO3 4.3.0)
  30  * This class render the HTML of a webpage, usable for BE and FE
  31  *
  32  * @author      Steffen Kamper <info@sk-typo3.de>
  33  * @package TYPO3
  34  * @subpackage t3lib
  35  * $Id$
  36  */
  37 class t3lib_PageRenderer implements t3lib_Singleton {
  38
  39         protected $compressJavascript = FALSE;
  40         protected $compressCss = FALSE;
  41         protected $removeLineBreaksFromTemplate = FALSE;
  42
  43         protected $concatenateFiles = FALSE;
  44
  45         protected $moveJsFromHeaderToFooter = FALSE;
  46
  47         protected $csConvObj;
  48         protected $lang;
  49
  50         // static array containing associative array for the included files
  51         protected static $jsFiles = array ();
  52         protected static $jsFooterFiles = array ();
  53         protected static $jsLibs = array ();
  54         protected static $jsFooterLibs = array ();
  55         protected static $cssFiles = array ();
  56
  57         protected $title;
  58         protected $charSet;
  59         protected $favIcon;
  60         protected $baseUrl;
  61
  62         // static header blocks
  63         protected $xmlPrologAndDocType = '';
  64         protected $metaTags = array ();
  65         protected $inlineComments = array ();
  66         protected $headerData = array ();
  67         protected $footerData = array ();
  68         protected $titleTag = '<title>|</title>';
  69         protected $metaCharsetTag = '<meta http-equiv="Content-Type" content="text/html; charset=|" />';
  70         protected $htmlTag = '<html>';
  71         protected $headTag = '<head>';
  72         protected $baseUrlTag = '<base href="|" />';
  73         protected $iconMimeType = '';
  74         protected $shortcutTag = '<link rel="shortcut icon" href="%1$s"%2$s />
  75 <link rel="icon" href="%1$s"%2$s />';
  76
  77         // static inline code blocks
  78         protected $jsInline = array ();
  79         protected $extOnReadyCode = array ();
  80         protected $cssInline = array ();
  81
  82         protected $bodyContent;
  83
  84         protected $templateFile;
  85
  86         protected $jsLibraryNames = array ('prototype', 'scriptaculous', 'extjs');
  87
  88         const PART_COMPLETE = 0;
  89         const PART_HEADER = 1;
  90         const PART_FOOTER = 2;
  91
  92         // internal flags for JS-libraries
  93         protected $addPrototype = FALSE;
  94         protected $addScriptaculous = FALSE;
  95         protected $addScriptaculousModules = array ('builder' => FALSE, 'effects' => FALSE, 'dragdrop' => FALSE, 'controls' => FALSE, 'slider' => FALSE);
  96         protected $addExtJS = FALSE;
  97         protected $addExtCore = FALSE;
  98         protected $extJSadapter = 'ext/ext-base.js';
  99
 100         protected $enableExtJsDebug = FALSE;
 101         protected $enableExtCoreDebug = FALSE;
 102
 103         // available adapters for extJs
 104         const EXTJS_ADAPTER_JQUERY = 'jquery';
 105         const EXTJS_ADAPTER_PROTOTYPE = 'prototype';
 106         const EXTJS_ADAPTER_YUI = 'yui';
 107
 108         protected $enableExtJSQuickTips = false;
 109
 110         protected $inlineLanguageLabels = array ();
 111         protected $inlineSettings = array ();
 112
 113         protected $inlineJavascriptWrap = array ();
 114
 115         // used by BE modules
 116         public $backPath;
 117
 118         /**
 119          * Constructor
 120          *
 121          * @param string $templateFile  declare the used template file. Omit this parameter will use default template
 122          * @param string $backPath      relative path to typo3-folder. It varies for BE modules, in FE it will be typo3/
 123          * @return void
 124          */
 125         public function __construct($templateFile = '', $backPath = '') {
 126
 127                 $this->reset();
 128
 129                 if (strlen($templateFile)) {
 130                         $this->templateFile = $templateFile;
 131                 }
 132                 $this->backPath = $backPath;
 133
 134                 $this->inlineJavascriptWrap = array(
 135                         '<script type="text/javascript">' . chr(10) . '/*<![CDATA[*/' . chr(10) . '<!-- ' . chr(10),
 136                         '// -->' . chr(10) . '/*]]>*/' . chr(10) . '</script>' . chr(10)
 137                 );
 138                 $this->inlineCssWrap = array(
 139                         '<style type="text/css">' . chr(10) . '/*<![CDATA[*/' . chr(10) . '<!-- ' . chr(10),
 140                         '-->' . chr(10) . '/*]]>*/' . chr(10) . '</style>' . chr(10)
 141                 );
 142
 143         }
 144
 145         /**
 146          * reset all vars to initial values
 147          *
 148          * @return void
 149          */
 150         protected function reset() {
 151                 $this->templateFile = TYPO3_mainDir . 'templates/template_page_backend.html';
 152                 $this->jsFiles = array ();
 153                 $this->jsFooterFiles = array ();
 154                 $this->jsInline = array ();
 155                 $this->jsFooterInline = array ();
 156                 $this->jsLibs = array ();
 157                 $this->cssFiles = array ();
 158                 $this->cssInline = array ();
 159                 $this->metaTags = array ();
 160                 $this->inlineComments = array ();
 161                 $this->headerData = array ();
 162                 $this->footerData = array ();
 163                 $this->extOnReadyCode = array ();
 164         }
 165         /*****************************************************/
 166         /*                                                   */
 167         /*  Public Setters                                   */
 168         /*                                                   */
 169         /*                                                   */
 170         /*****************************************************/
 171
 172         /**
 173          * Sets the title
 174          *
 175          * @param string $title title of webpage
 176          * @return void
 177          */
 178         public function setTitle($title) {
 179                 $this->title = $title;
 180         }
 181
 182         /**
 183          * Sets xml prolog and docType
 184          *
 185          * @param string $xmlPrologAndDocType   complete tags for xml prolog and docType
 186          * @return void
 187          */
 188         public function setXmlPrologAndDocType($xmlPrologAndDocType) {
 189                 $this->xmlPrologAndDocType = $xmlPrologAndDocType;
 190         }
 191
 192         /**
 193          * Sets meta charset
 194          * @return void
 195          *
 196          * @param string $charSet       used charset
 197          */
 198         public function setCharSet($charSet) {
 199                 $this->charSet = $charSet;
 200         }
 201
 202         /**
 203          * Sets html tag
 204          *
 205          * @param string $htmlTag       html tag
 206          * @return void
 207          */
 208         public function setHtmlTag($htmlTag) {
 209                 $this->htmlTag = $htmlTag;
 210         }
 211
 212         /**
 213          * Sets head tag
 214          *
 215          * @param string $tag   head tag
 216          * @return void
 217          */
 218         public function setHeadTag($headTag) {
 219                 $this->headTag = $headTag;
 220         }
 221
 222         /**
 223          * Sets favicon
 224          *
 225          * @param string $favIcon
 226          * @return void
 227          */
 228         public function setFavIcon($favIcon) {
 229                 $this->favIcon = $favIcon;
 230         }
 231
 232         /**
 233          * Sets icon mime type
 234          *
 235          * @param string $iconMimeType
 236          * @return void
 237          */
 238         public function setIconMimeType($iconMimeType) {
 239                 $this->iconMimeType = $iconMimeType;
 240         }
 241
 242         /**
 243          * Sets base url
 244          *
 245          * @param string $url
 246          * @return void
 247          */
 248         public function setBaseUrl($baseUrl) {
 249                 $this->baseUrl = $baseUrl;
 250         }
 251
 252         /**
 253          * Sets template file
 254          *
 255          * @param string $file
 256          * @return void
 257          */
 258         public function setTemplateFile($file) {
 259                 $this->templateFile = $file;
 260         }
 261
 262         /**
 263          * Sets back path
 264          *
 265          * @param string $backPath
 266          * @return void
 267          */
 268         public function setBackPath($backPath) {
 269                 $this->backPath = $backPath;
 270         }
 271
 272         /**
 273          * Sets Content for Body
 274          *
 275          * @param string $content
 276          * @return void
 277          */
 278         public function setBodyContent($content) {
 279                 $this->bodyContent = $content;
 280         }
 281
 282         /*****************************************************/
 283         /*                                                   */
 284         /*  Public Enablers                                  */
 285         /*                                                   */
 286         /*                                                   */
 287         /*****************************************************/
 288         /**
 289          * Enables MoveJsFromHeaderToFooter
 290          *
 291          * @param void
 292          * @return void
 293          */
 294         public function enableMoveJsFromHeaderToFooter() {
 295                 $this->moveJsFromHeaderToFooter = TRUE;
 296         }
 297
 298         /**
 299          * Enables compression of javascript
 300          *
 301          * @param void
 302          * @return void
 303          */
 304         public function enableCompressJavascript() {
 305                 $this->compressJavascript = TRUE;
 306         }
 307
 308         /**
 309          * Enables compression of css
 310          *
 311          * @param void
 312          * @return void
 313          */
 314         public function enableCompressCss() {
 315                 $this->compressCss = TRUE;
 316         }
 317
 318         /**
 319         /**
 320          * Enables concatenation of js/css files
 321          *
 322          * @param void
 323          * @return void
 324          */
 325         public function enableConcatenateFiles() {
 326                 $this->concatenateFiles = TRUE;
 327         }
 328
 329         /**
 330          * Sets removal of all line breaks in template
 331          *
 332          * @param void
 333          * @return void
 334          */
 335         public function enableRemoveLineBreaksFromTemplate() {
 336                 $this->removeLineBreaksFromTemplate = TRUE;
 337         }
 338
 339         /*****************************************************/
 340         /*                                                   */
 341         /*  Public Getters                                   */
 342         /*                                                   */
 343         /*                                                   */
 344         /*****************************************************/
 345
 346         /**
 347          * Gets the title
 348          *
 349          * @return string $title                title of webpage
 350          */
 351         public function getTitle() {
 352                 return $this->title;
 353         }
 354
 355         /**
 356          * Gets the charSet
 357          *
 358          * @return string $charSet
 359          */
 360         public function getCharSet() {
 361                 return $this->charSet;
 362         }
 363
 364         /**
 365          * Gets html tag
 366          *
 367          * @return string $htmlTag      html tag
 368          */
 369         public function getHtmlTag() {
 370                 return $this->htmlTag;
 371         }
 372
 373         /**
 374          * Gets head tag
 375          *
 376          * @return string $tag  head tag
 377          */
 378         public function getHeadTag() {
 379                 return $this->headTag;
 380         }
 381
 382         /**
 383          * Gets favicon
 384          *
 385          * @return string $favIcon
 386          */
 387         public function getFavIcon() {
 388                 return $this->favIcon;
 389         }
 390
 391         /**
 392          * Gets icon mime type
 393          *
 394          * @return string $iconMimeType
 395          */
 396         public function getIconMimeType() {
 397                 return $this->iconMimeType;
 398         }
 399
 400         /**
 401          * Gets base url
 402          *
 403          * @return string $url
 404          */
 405         public function getBaseUrl() {
 406                 return $this->baseUrl;
 407         }
 408
 409         /**
 410          * Gets template file
 411          *
 412          * @return string $file
 413          */
 414         public function getTemplateFile($file) {
 415                 return $this->templateFile;
 416         }
 417
 418         /**
 419          * Gets MoveJsFromHeaderToFooter
 420          *
 421          * @return boolean
 422          */
 423         public function getMoveJsFromHeaderToFooter() {
 424                 return $this->moveJsFromHeaderToFooter;
 425         }
 426
 427         /**
 428          * Gets compress of javascript
 429          *
 430          * @return boolean
 431          */
 432         public function getCompressJavascript() {
 433                 return $this->compressJavascript;
 434         }
 435
 436         /**
 437          * Gets compress of css
 438          *
 439          * @return boolean
 440          */
 441         public function getCompressCss() {
 442                 return $this->compressCss;
 443         }
 444
 445         /**
 446          * Gets concatenate of files
 447          *
 448          * @return boolean
 449          */
 450         public function getConcatenateFiles() {
 451                 return $this->concatenateFiles;
 452         }
 453
 454         /**
 455          * Gets remove of empty lines from template
 456          *
 457          * @return boolean
 458          */
 459         public function getRemoveLineBreaksFromTemplate() {
 460                 return $this->removeLineBreaksFromTemplate;
 461         }
 462
 463         /**
 464          * Gets content for body
 465          *
 466          * @return string
 467          */
 468         public function getBodyContent() {
 469                 return $this->bodyContent;
 470         }
 471
 472         /*****************************************************/
 473         /*                                                   */
 474         /*  Public Function to add Data                      */
 475         /*                                                   */
 476         /*                                                   */
 477         /*****************************************************/
 478
 479         /**
 480          * Adds meta data
 481          *
 482          * @param string $meta  meta data (complete metatag)
 483          * @return void
 484          */
 485         public function addMetaTag($meta) {
 486                 if (!in_array($meta, $this->metaTags)) {
 487                         $this->metaTags[] = $meta;
 488                 }
 489         }
 490
 491         /**
 492          * Adds inline HTML comment
 493          *
 494          * @param string $comment
 495          * @return void
 496          */
 497         public function addInlineComment($comment) {
 498                 if (!in_array($comment, $this->inlineComments)) {
 499                         $this->inlineComments[] = $comment;
 500                 }
 501         }
 502
 503         /**
 504          * Adds header data
 505          *
 506          * @param string $data  free header data for HTML header
 507          * @return void
 508          */
 509         public function addHeaderData($data) {
 510                 if (!in_array($data, $this->headerData)) {
 511                         $this->headerData[] = $data;
 512                 }
 513         }
 514
 515         /**
 516          * Adds footer data
 517          *
 518          * @param string $data  free header data for HTML header
 519          * @return void
 520          */
 521         public function addFooterData($data) {
 522                 if (!in_array($data, $this->footerData)) {
 523                         $this->footerData[] = $data;
 524                 }
 525         }
 526
 527         /* Javascript Files */
 528
 529         /**
 530          * Adds JS Library. JS Library block is rendered on top of the JS files.
 531          *
 532          * @param string $name
 533          * @param string $file
 534          * @param string $type
 535          * @param boolean $compressed   flag if library is compressed
 536          * @param boolean $forceOnTop   flag if added library should be inserted at begin of this block
 537          * @param string $allWrap
 538          * @return void
 539          */
 540         public function addJsLibrary($name, $file, $type = 'text/javascript', $compressed = TRUE, $forceOnTop = FALSE, $allWrap = '') {
 541                 if (!in_array(strtolower($name), $this->jsLibs)) {
 542                         $this->jsLibs[strtolower($name)] = array (
 543                                 'file'        => $file,
 544                                 'type'        => $type,
 545                                 'section'     => self::PART_HEADER,
 546                                 'compressed'  => $compressed,
 547                                 'forceOnTop'  => $forceOnTop,
 548                                 'allWrap'     => $allWrap
 549                         );
 550                 }
 551
 552         }
 553
 554         /**
 555          * Adds JS Library to Footer. JS Library block is rendered on top of the Footer JS files.
 556          *
 557          * @param string $name
 558          * @param string $file
 559          * @param string $type
 560          * @param boolean $compressed   flag if library is compressed
 561          * @param boolean $forceOnTop   flag if added library should be inserted at begin of this block
 562          * @param string $allWrap
 563          * @return void
 564          */
 565         public function addJsFooterLibrary($name, $file, $type = 'text/javascript', $compressed = TRUE, $forceOnTop = FALSE, $allWrap = '') {
 566                 if (!in_array(strtolower($name), $this->jsLibs)) {
 567                         $this->jsLibs[strtolower($name)] = array (
 568                                 'file'        => $file,
 569                                 'type'        => $type,
 570                                 'section'     => self::PART_FOOTER,
 571                                 'compressed'  => $compressed,
 572                                 'forceOnTop'  => $forceOnTop,
 573                                 'allWrap'     => $allWrap
 574                         );
 575                 }
 576
 577         }
 578
 579         /**
 580          * Adds JS file
 581          *
 582          * @param string $file
 583          * @param string $type
 584          * @param boolean $compressed
 585          * @param boolean $forceOnTop
 586          * @param string $allWrap
 587          * @return void
 588          */
 589         public function addJsFile($file, $type = 'text/javascript', $compressed = FALSE, $forceOnTop = FALSE, $allWrap = '') {
 590                 if (!isset($this->jsFiles[$file])) {
 591                         $this->jsFiles[$file] = array (
 592                                 'type'        => $type,
 593                                 'section'     => self::PART_HEADER,
 594                                 'compressed'  => $compressed,
 595                                 'forceOnTop'  => $forceOnTop,
 596                                 'allWrap'     => $allWrap
 597                         );
 598                 }
 599         }
 600
 601         /**
 602          * Adds JS file to footer
 603          *
 604          * @param string $file
 605          * @param string $type
 606          * @param boolean $compressed
 607          * @param boolean $forceOnTop
 608          * @return void
 609          */
 610         public function addJsFooterFile($file, $type = 'text/javascript', $compressed = FALSE, $forceOnTop = FALSE, $allWrap = '') {
 611                 if (!isset($this->jsFiles[$file])) {
 612                         $this->jsFiles[$file] = array (
 613                                 'type'        => $type,
 614                                 'section'     => self::PART_FOOTER,
 615                                 'compressed'  => $compressed,
 616                                 'forceOnTop'  => $forceOnTop,
 617                                 'allWrap'     => $allWrap
 618                         );
 619                 }
 620         }
 621
 622         /*Javascript Inline Blocks */
 623
 624         /**
 625          * Adds JS inline code
 626          *
 627          * @param string $name
 628          * @param string $block
 629          * @param boolean $compressed
 630          * @param boolean $forceOnTop
 631          * @return void
 632          */
 633         public function addJsInlineCode($name, $block, $compressed = FALSE, $forceOnTop = FALSE) {
 634                 if (!isset($this->jsInline[$name])) {
 635                         $this->jsInline[$name] = array (
 636                                 'code'        => $block . chr(10),
 637                                 'section'     => self::PART_HEADER,
 638                                 'compressed'  => $compressed,
 639                                 'forceOnTop'  => $forceOnTop
 640                         );
 641                 }
 642         }
 643
 644         /**
 645          * Adds JS inline code to footer
 646          *
 647          * @param string $name
 648          * @param string $block
 649          * @param boolean $compressed
 650          * @param boolean $forceOnTop
 651          * @return void
 652          */
 653         public function addJsFooterInlineCode($name, $block, $compressed = FALSE, $forceOnTop = FALSE) {
 654                 if (!isset($this->jsInline[$name])) {
 655                         $this->jsInline[$name] = array (
 656                                 'code'        => $block . chr(10),
 657                                 'section'     => self::PART_FOOTER,
 658                                 'compressed'  => $compressed,
 659                                 'forceOnTop'  => $forceOnTop
 660                         );
 661                 }
 662         }
 663
 664         /**
 665          * Adds Ext.onready code, which will be wrapped in Ext.onReady(function() {...});
 666          *
 667          * @param string $block
 668          * @return void
 669          */
 670         public function addExtOnReadyCode($block) {
 671                 if (!in_array($block, $this->extOnReadyCode)) {
 672                         $this->extOnReadyCode[] = $block;
 673                 }
 674         }
 675
 676         /* CSS Files */
 677
 678         /**
 679          * Adds CSS file
 680          *
 681          * @param string $file
 682          * @param string $rel
 683          * @param string $media
 684          * @param string $title
 685          * @param boolean $compressed
 686          * @param boolean $forceOnTop
 687          * @return void
 688          */
 689         public function addCssFile($file, $rel = 'stylesheet', $media = 'screen', $title = '', $compressed = FALSE, $forceOnTop = FALSE, $allWrap = '') {
 690                 if (!isset($this->cssFiles[$file])) {
 691                         $this->cssFiles[$file] = array ('rel' => $rel, 'media' => $media, 'title' => $title, 'compressed' => $compressed, 'forceOnTop' => $forceOnTop, 'allWrap' => $allWrap);
 692                 }
 693         }
 694
 695         /*CSS Inline Blocks */
 696
 697         /**
 698          * Adds CSS inline code
 699          *
 700          * @param string $name
 701          * @param string $block
 702          * @param boolean $compressed
 703          * @param boolean $forceOnTop
 704          * @return void
 705          */
 706         public function addCssInlineBlock($name, $block, $compressed = FALSE, $forceOnTop = FALSE) {
 707                 if (!isset($this->cssInline[$name])) {
 708                         $this->cssInline[$name] = array ('code' => $block, 'compressed' => $compressed, 'forceOnTop' => $forceOnTop);
 709                 }
 710         }
 711
 712         /* JS Libraries */
 713
 714         /**
 715          *  call function if you need the prototype library
 716          *
 717          * @return void
 718          */
 719         public function loadPrototype() {
 720                 $this->addPrototype = TRUE;
 721         }
 722
 723         /**
 724          * call function if you need the Scriptaculous library
 725          *
 726          * @param string $modules   add modules you need. use "all" if you need complete modules
 727          * @return void
 728          */
 729         public function loadScriptaculous($modules = '') {
 730                 // Scriptaculous require prototype, so load prototype too.
 731                 $this->addPrototype = TRUE;
 732                 $this->addScriptaculous = TRUE;
 733                 if ($modules) {
 734                         if ($modules == 'all') {
 735                                 foreach ($this->addScriptaculousModules as $key => $value) {
 736                                         $this->addScriptaculousModules[$key] = TRUE;
 737                                 }
 738                         } else {
 739                                 $mods = t3lib_div::trimExplode(',', $modules);
 740                                 foreach ($mods as $mod) {
 741                                         if (isset($this->addScriptaculousModules[strtolower($mod)])) {
 742                                                 $this->addScriptaculousModules[strtolower($mod)] = TRUE;
 743                                         }
 744                                 }
 745                         }
 746                 }
 747         }
 748
 749         /**
 750          * call this function if you need the extJS library
 751          *
 752          * @param boolean $css flag, if set the ext-css will be loaded
 753          * @param boolean $theme flag, if set the ext-theme "grey" will be loaded
 754          * @param string $adapter choose alternative adapter, possible values: yui, prototype, jquery
 755          * @return void
 756          */
 757         public function loadExtJS($css = TRUE, $theme = TRUE, $adapter = '') {
 758                 if ($adapter) {
 759                         // empty $adapter will always load the ext adapter
 760                         switch (t3lib_div::strtolower(trim($adapter))) {
 761                                 case self::EXTJS_ADAPTER_YUI :
 762                                         $this->extJSadapter = 'yui/ext-yui-adapter.js';
 763                                         break;
 764                                 case self::EXTJS_ADAPTER_PROTOTYPE :
 765                                         $this->extJSadapter = 'prototype/ext-prototype-adapter.js';
 766                                         break;
 767                                 case self::EXTJS_ADAPTER_JQUERY :
 768                                         $this->extJSadapter = 'jquery/ext-jquery-adapter.js';
 769                                         break;
 770                         }
 771                 }
 772                 if (!$this->addExtJS) {
 773                         $this->addExtJS = TRUE;
 774                         if ($theme) {
 775                                 if (isset($GLOBALS['TBE_STYLES']['extJS']['theme'])) {
 776                                         $this->addCssFile($this->backPath . $GLOBALS['TBE_STYLES']['extJS']['theme'], 'stylesheet', 'screen', '', FALSE, TRUE);
 777                                 } else {
 778                                         $this->addCssFile($this->backPath . 'contrib/extjs/resources/css/xtheme-blue.css', 'stylesheet', 'screen', '', FALSE, TRUE);
 779                                 }
 780                         }
 781                         if ($css) {
 782                                 if (isset($GLOBALS['TBE_STYLES']['extJS']['all'])) {
 783                                         $this->addCssFile($this->backPath . $GLOBALS['TBE_STYLES']['extJS']['all'], 'stylesheet', 'screen', '', FALSE, TRUE);
 784                                 } else {
 785                                         $this->addCssFile($this->backPath . 'contrib/extjs/resources/css/ext-all-notheme.css', 'stylesheet', 'screen', '', FALSE, TRUE);
 786                                 }
 787                         }
 788
 789                 }
 790         }
 791
 792         /**
 793          * Enables ExtJs QuickTips
 794          * Need extJs loaded
 795          *
 796          * @return void
 797          *
 798          */
 799         public function enableExtJSQuickTips() {
 800                 $this->enableExtJSQuickTips = TRUE;
 801         }
 802
 803
 804         /**
 805          * call function if you need the ExtCore library
 806          *
 807          * @return void
 808          */
 809         public function loadExtCore() {
 810                 $this->addExtCore = TRUE;
 811         }
 812
 813         /**
 814          * call this function to load debug version of ExtJS. Use this for development only
 815          *
 816          */
 817         public function enableExtJsDebug() {
 818                 $this->enableExtJsDebug = TRUE;
 819         }
 820
 821         /**
 822          * call this function to load debug version of ExtCore. Use this for development only
 823          *
 824          * @return void
 825          */
 826         public function enableExtCoreDebug() {
 827                 $this->enableExtCoreDebug = TRUE;
 828         }
 829
 830         /**
 831          * Adds Javascript Inline Label. This will occur in TYPO3.lang - object
 832          * The label can be used in scripts with TYPO3.lang.<key>
 833          * Need extJs loaded
 834          *
 835          * @param string $key
 836          * @param string $value
 837          * @return void
 838          */
 839         public function addInlineLanguageLabel($key, $value) {
 840                 $this->inlineLanguageLabels[$key] = $value;
 841         }
 842
 843         /**
 844          * Adds Javascript Inline Label Array. This will occur in TYPO3.lang - object
 845          * The label can be used in scripts with TYPO3.lang.<key>
 846          * Array will be merged with existing array.
 847          * Need extJs loaded
 848          *
 849          * @param array $array
 850          * @return void
 851          */
 852         public function addInlineLanguageLabelArray(array $array) {
 853                 $this->inlineLanguageLabels = array_merge($this->inlineLanguageLabels, $array);
 854         }
 855
 856         /**
 857          * Adds Javascript Inline Setting. This will occur in TYPO3.settings - object
 858          * The label can be used in scripts with TYPO3.setting.<key>
 859          * Need extJs loaded
 860          *
 861          * @param string $namespace
 862          * @param string $key
 863          * @param string $value
 864          * @return void
 865          */
 866         public function addInlineSetting($namespace, $key, $value) {
 867                 if ($namespace) {
 868                         if (strpos($namespace, '.')) {
 869                                 $parts = explode('.', $namespace);
 870                                 $a = &$this->inlineSettings;
 871                                 foreach ($parts as $part) {
 872                                         $a = &$a[$part];
 873                                 }
 874                                 $a[$key] = $value;
 875                         } else {
 876                                 $this->inlineSettings[$namespace][$key] = $value;
 877                         }
 878                 } else {
 879                         $this->inlineSettings[$key] = $value;
 880                 }
 881         }
 882
 883         /**
 884          * Adds Javascript Inline Setting. This will occur in TYPO3.settings - object
 885          * The label can be used in scripts with TYPO3.setting.<key>
 886          * Array will be merged with existing array.
 887          * Need extJs loaded
 888          *
 889          * @param string $namespace
 890          * @param array $array
 891          * @return void
 892          */
 893         public function addInlineSettingArray($namespace, array $array) {
 894                 if ($namespace) {
 895                         if (strpos($namespace, '.')) {
 896                                 $parts = explode('.', $namespace);
 897                                 $a = &$this->inlineSettings;
 898                                 foreach ($parts as $part) {
 899                                         $a = &$a[$part];
 900                                 }
 901                                 $a = array_merge((array) $a, $array);
 902                         } else {
 903                                 $this->inlineSettings[$namespace] = array_merge((array) $this->inlineSettings[$namespace], $array);
 904                         }
 905                 } else {
 906                         $this->inlineSettings = array_merge($this->inlineSettings, $array);
 907                 }
 908         }
 909
 910         /**
 911          * Adds content to body content
 912          *
 913          * @param string $content
 914          * @return void
 915          */
 916         public function addBodyContent($content) {
 917                 $this->bodyContent .= $content;
 918         }
 919
 920         /*****************************************************/
 921         /*                                                   */
 922         /*  Render Functions                                 */
 923         /*                                                   */
 924         /*                                                   */
 925         /*****************************************************/
 926
 927         /**
 928          * render the section (Header or Footer)
 929          *
 930          * @param int $part     section which should be rendered: self::PART_COMPLETE, self::PART_HEADER or self::PART_FOOTER
 931          * @return string       content of rendered section
 932          */
 933         public function render($part = self::PART_COMPLETE) {
 934
 935                 $jsFiles = '';
 936                 $cssFiles = '';
 937                 $cssInline = '';
 938                 $jsInline = '';
 939                 $jsFooterInline = '';
 940                 $jsFooterLibs = '';
 941                 $jsFooterFiles = '';
 942                 $noJS = FALSE;
 943
 944                 $jsLibs = $this->renderJsLibraries();
 945
 946                 if ($this->compressCss || $this->compressJavascript) {
 947                                 // do the file compression
 948                         $this->doCompress();
 949                 }
 950                 if ($this->concatenateFiles) {
 951                                 // do the file concatenation
 952                         $this->doConcatenate();
 953                 }
 954
 955                 $metaTags = implode(chr(10), $this->metaTags);
 956
 957                 if (count($this->cssFiles)) {
 958                         foreach ($this->cssFiles as $file => $properties) {
 959                                 $tag = '<link rel="' . $properties['rel'] . '" type="text/css" href="' . $file . '" media="' . $properties['media'] . '"' . ($properties['title'] ? ' title="' . $properties['title'] . '"' : '') . ' />';
 960                                 if ($properties['allWrap'] && strpos($properties['allWrap'], '|') !== FALSE) {
 961                                         $tag = str_replace('|', $tag, $properties['allWrap']);
 962                                 }
 963                                 if ($properties['forceOnTop']) {
 964                                         $cssFiles = $tag . chr(10) . $cssFiles;
 965                                 } else {
 966                                         $cssFiles .= chr(10) . $tag;
 967                                 }
 968                         }
 969                 }
 970
 971                 if (count($this->cssInline)) {
 972
 973                         foreach ($this->cssInline as $name => $properties) {
 974                                 if ($properties['forceOnTop']) {
 975                                         $cssInline = '/*' . htmlspecialchars($name) . '*/' . chr(10) . $properties['code'] . chr(10) . $cssInline;
 976                                 } else {
 977                                         $cssInline .= '/*' . htmlspecialchars($name) . '*/' . chr(10) . $properties['code'] . chr(10);
 978                                 }
 979                         }
 980                         $cssInline = $this->inlineCssWrap[0] . $cssInline . $this->inlineCssWrap[1];
 981
 982                 }
 983
 984                 if (count($this->jsLibs)) {
 985                         foreach ($this->jsLibs as $name => $properties) {
 986                                 $tag = '<script src="' . $properties['file'] . '" type="' . $properties['type'] . '"></script>';
 987                                 if ($properties['allWrap'] && strpos($properties['allWrap'], '|') !== FALSE) {
 988                                         $tag = str_replace('|', $tag, $properties['allWrap']);
 989                                 }
 990                                 if ($properties['forceOnTop']) {
 991                                         if ($properties['section'] === self::PART_HEADER) {
 992                                                 $jsLibs = $tag . chr(10) . $jsLibs;
 993                                         } else {
 994                                                 $jsFooterLibs = $tag . chr(10) . $jsFooterLibs;
 995                                         }
 996                                 } else {
 997                                         if ($properties['section'] === self::PART_HEADER) {
 998                                                 $jsLibs .= chr(10) . $tag;
 999                                         } else {
1000                                                 $jsFooterLibs .= chr(10) . $tag;
1001                                         }
1002                                 }
1003
1004                         }
1005                 }
1006
1007                 if (count($this->jsFiles)) {
1008                         foreach ($this->jsFiles as $file => $properties) {
1009                                         $tag = '<script src="' . $file . '" type="' . $properties['type'] . '"></script>';
1010                                         if ($properties['allWrap'] && strpos($properties['allWrap'], '|') !== FALSE) {
1011                                                 $tag = str_replace('|', $tag, $properties['allWrap']);
1012                                         }
1013                                         if ($properties['forceOnTop']) {
1014                                                 if ($properties['section'] === self::PART_HEADER) {
1015                                                         $jsFiles = $tag . chr(10) . $jsFiles;
1016                                                 } else {
1017                                                         $jsFooterFiles = $tag . chr(10) . $jsFooterFiles;
1018                                                 }
1019                                         } else {
1020                                                 if ($properties['section'] === self::PART_HEADER) {
1021                                                         $jsFiles .= chr(10) . $tag;
1022                                                 } else {
1023                                                         $jsFooterFiles .= chr(10) . $tag;
1024                                                 }
1025                                         }
1026                         }
1027                 }
1028
1029                 if (count($this->jsInline)) {
1030                         foreach ($this->jsInline as $name => $properties) {
1031                                 if ($properties['forceOnTop']) {
1032                                         if ($properties['section'] === self::PART_HEADER) {
1033                                                 $jsInline = '/*' . htmlspecialchars($name) . '*/' . chr(10) . $properties['code'] . chr(10) . $jsInline;
1034                                         } else {
1035                                                 $jsFooterInline = '/*' . htmlspecialchars($name) . '*/' . chr(10) . $properties['code'] . chr(10) . $jsFooterInline;
1036                                         }
1037                                 } else {
1038                                         if ($properties['section'] === self::PART_HEADER) {
1039                                                 $jsInline .= '/*' . htmlspecialchars($name) . '*/' . chr(10) . $properties['code'] . chr(10);
1040                                         } else {
1041                                                 $jsFooterInline .= '/*' . htmlspecialchars($name) . '*/' . chr(10) . $properties['code'] . chr(10);
1042                                         }
1043                                 }
1044                         }
1045                 }
1046
1047
1048                 if ($jsInline) {
1049                         $jsInline = $this->inlineJavascriptWrap[0] . $jsInline . $this->inlineJavascriptWrap[1];
1050                 }
1051
1052                 if ($jsFooterInline) {
1053                         $jsFooterInline = $this->inlineJavascriptWrap[0] . $jsFooterInline . $this->inlineJavascriptWrap[1];
1054                 }
1055
1056
1057                         // get template
1058                 $templateFile = t3lib_div::getFileAbsFileName($this->templateFile, TRUE);
1059                 $template = t3lib_div::getURL($templateFile);
1060
1061                 if ($this->removeEmptyLinesFromTemplate) {
1062                         $template = strtr($template, array(chr(10) => '', chr(13) => ''));
1063                 }
1064                 if ($part != self::PART_COMPLETE) {
1065                         $templatePart = explode('###BODY###', $template);
1066                         $template = $templatePart[$part - 1];
1067                 }
1068
1069                 if ($this->moveJsFromHeaderToFooter) {
1070                         $jsFooterLibs = $jsLibs . chr(10) . $jsFooterLibs;
1071                         $jsLibs = '';
1072                         $jsFooterFiles = $jsFiles . chr(10) . $jsFooterFiles;
1073                         $jsFiles = '';
1074                         $jsFooterInline = $jsInline . chr(10) . $jsFooterInline;
1075                         $jsInline = '';
1076                 }
1077
1078                 $markerArray = array(
1079                         'XMLPROLOG_DOCTYPE' => $this->xmlPrologAndDocType,
1080                         'HTMLTAG'           => $this->htmlTag,
1081                         'HEADTAG'           => $this->headTag,
1082                         'METACHARSET'       => $this->charSet ? str_replace('|', htmlspecialchars($this->charSet), $this->metaCharsetTag) : '',
1083                         'INLINECOMMENT'     => $this->inlineComments ? chr(10) . chr(10) . '<!-- ' . chr(10) . implode(chr(10), $this->inlineComments) . '-->' . chr(10) . chr(10) : '',
1084                         'BASEURL'           => $this->baseUrl ? str_replace('|', $this->baseUrl, $this->baseUrlTag) : '',
1085                         'SHORTCUT'          => $this->favIcon ? sprintf($this->shortcutTag, htmlspecialchars($this->favIcon), $this->iconMimeType) : '',
1086                         'CSS_INCLUDE'       => $cssFiles,
1087                         'CSS_INLINE'        => $cssInline,
1088                         'JS_INLINE'         => $jsInline,
1089                         'JS_INCLUDE'        => $jsFiles,
1090                         'JS_LIBS'               => $jsLibs,
1091                         'TITLE'             => $this->title ? str_replace('|', htmlspecialchars($this->title), $this->titleTag) : '',
1092                         'META'              => $metaTags,
1093                         'HEADERDATA'        => $this->headerData ? implode(chr(10), $this->headerData) : '',
1094                         'FOOTERDATA'        => $this->footerData ? implode(chr(10), $this->footerData) : '',
1095                         'JS_LIBS_FOOTER'        => $jsFooterLibs,
1096                         'JS_INCLUDE_FOOTER' => $jsFooterFiles,
1097                         'JS_INLINE_FOOTER'  => $jsFooterInline,
1098                         'BODY'                          => $this->bodyContent,
1099                 );
1100
1101                 $markerArray = array_map('trim', $markerArray);
1102
1103                 $this->reset();
1104                 return trim(t3lib_parsehtml::substituteMarkerArray($template, $markerArray, '###|###'));
1105         }
1106
1107         /**
1108          * helper function for render the javascript libraries
1109          *
1110          * @return string       content with javascript libraries
1111          */
1112         protected function renderJsLibraries() {
1113                 $out = '';
1114
1115                 if ($this->addPrototype) {
1116                         $out .= '<script src="' . $this->backPath . 'contrib/prototype/prototype.js" type="text/javascript"></script>' . chr(10);
1117                         unset($this->jsFiles[$this->backPath . 'contrib/prototype/prototype.js']);
1118                 }
1119
1120                 if ($this->addScriptaculous) {
1121                         $mods = array ();
1122                         foreach ($this->addScriptaculousModules as $key => $value) {
1123                                 if ($this->addScriptaculousModules[$key]) {
1124                                         $mods[] = $key;
1125                                 }
1126                         }
1127                                 // resolve dependencies
1128                         if (in_array('dragdrop', $mods) || in_array('controls', $mods)) {
1129                                 $mods = array_merge(array('effects'), $mods);
1130                         }
1131
1132                         if (count($mods)) {
1133                                 $moduleLoadString = '?load=' . implode(',', $mods);
1134                         }
1135
1136                         $out .= '<script src="' . $this->backPath . 'contrib/scriptaculous/scriptaculous.js' . $moduleLoadString . '" type="text/javascript"></script>' . chr(10);
1137                         unset($this->jsFiles[$this->backPath . 'contrib/scriptaculous/scriptaculous.js' . $moduleLoadString]);
1138                 }
1139
1140                         // include extCore
1141                 if ($this->addExtCore) {
1142                         $out .= '<script src="' . $this->backPath . 'contrib/extjs/ext-core' . ($this->enableExtCoreDebug ? '-debug' : '') . '.js" type="text/javascript"></script>' . chr(10);
1143                         unset($this->jsFiles[$this->backPath . 'contrib/extjs/ext-core' . ($this->enableExtCoreDebug ? '-debug' : '') . '.js']);
1144                 }
1145
1146                         // include extJS
1147                 if ($this->addExtJS) {
1148                                 // use the base adapter all the time
1149                         $out .= '<script src="' . $this->backPath . 'contrib/extjs/adapter/' . $this->extJSadapter . '" type="text/javascript"></script>' . chr(10);
1150                         $out .= '<script src="' . $this->backPath . 'contrib/extjs/ext-all' . ($this->enableExtJsDebug ? '-debug' : '') . '.js" type="text/javascript"></script>' . chr(10);
1151
1152                                 // add extJS localization
1153                         $localeMap = $this->csConvObj->isoArray; // load standard ISO mapping and modify for use with ExtJS
1154                         $localeMap[''] = 'en';
1155                         $localeMap['default'] = 'en';
1156                         $localeMap['gr'] = 'el_GR'; // Greek
1157                         $localeMap['no'] = 'no_BO'; // Norwegian Bokmaal
1158                         $localeMap['se'] = 'se_SV'; // Swedish
1159
1160
1161                         $extJsLang = isset($localeMap[$this->lang]) ? $localeMap[$this->lang] : $this->lang;
1162                                 // TODO autoconvert file from UTF8 to current BE charset if necessary!!!!
1163                         $extJsLocaleFile = 'contrib/extjs/locale/ext-lang-' . $extJsLang . '-min.js';
1164                         if (file_exists(PATH_typo3 . $extJsLocaleFile)) {
1165                                 $out .= '<script src="' . $this->backPath . $extJsLocaleFile . '" type="text/javascript"></script>' . chr(10);
1166                         }
1167
1168
1169                                 // remove extjs from JScodeLibArray
1170                         unset(
1171                                 $this->jsFiles[$this->backPath . 'contrib/extjs/ext-all.js'], $this->jsFiles[$this->backPath . 'contrib/extjs/ext-all-debug.js']
1172                         );
1173                 }
1174                 if ($this->addExtCore || $this->addExtJS) {
1175                                 // set clear.gif, move it on top, add handler code
1176                         $code = '';
1177                         if (count($this->extOnReadyCode)) {
1178                                 foreach ($this->extOnReadyCode as $block) {
1179                                         $code .= $block;
1180                                 }
1181                         }
1182
1183                         $out .= $this->inlineJavascriptWrap[0] . '
1184                                 Ext.ns("TYPO3");
1185                                 Ext.BLANK_IMAGE_URL = "' . htmlspecialchars(t3lib_div::locationHeaderUrl($this->backPath . 'gfx/clear.gif')) . '";' . chr(10) .
1186                                 'TYPO3.lang = ' . json_encode($this->inlineLanguageLabels) . ';' . 'TYPO3.settings = ' . json_encode($this->inlineSettings) . ';' .
1187                                 'Ext.onReady(function() {' .
1188                                 ($this->enableExtJSQuickTips ? 'Ext.QuickTips.init();' . chr(10) : '') . $code .
1189                                 ' });' . $this->inlineJavascriptWrap[1];
1190                         unset ($this->extOnReadyCode);
1191                 }
1192
1193                 return $out;
1194         }
1195
1196         /*****************************************************/
1197         /*                                                   */
1198         /*  Tools                                            */
1199         /*                                                   */
1200         /*                                                   */
1201         /*****************************************************/
1202
1203         /**
1204          * concatenate files into one file
1205          * registered handler
1206          * TODO: implement own method
1207          *
1208          * @return void
1209          */
1210         protected function doConcatenate() {
1211                 // traverse the arrays, concatenate in one file
1212                 // then remove concatenated files from array and add the concatenated file
1213
1214
1215                         // extern concatination
1216                 if ($this->concatenateFiles && $GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['concatenateHandler']) {
1217                         // use extern concatenate routine
1218                         $params = array (
1219                                 'jsLibs'         => &$this->jsLibs,
1220                                 'jsFiles'        => &$this->jsFiles,
1221                                 'jsFooterFiles'  => &$this->jsFiles,
1222                                 'cssFiles'       => &$this->cssFiles,
1223                         );
1224                         t3lib_div::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['concatenateHandler'], $params, $this);
1225                 } else {
1226                         // own method, nothing implemented atm
1227
1228
1229                 }
1230         }
1231
1232         /**
1233          * compress inline code
1234          *
1235          */
1236         protected function doCompress() {
1237
1238                 if ($this->compressJavascript && $GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsCompressHandler']) {
1239                         // use extern compress routine
1240                         $params = array (
1241                                 'jsInline'        => &$this->jsInline,
1242                                 'jsFooterInline'  => &$this->jsFooterInline
1243                         );
1244                         t3lib_div::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['jsCompressHandler'], $params, $this);
1245                 } else {
1246                                 // traverse the arrays, compress files
1247                         $this->compressError = '';
1248
1249                         if ($this->compressJavascript) {
1250                                 if (count($this->jsInline)) {
1251                                         foreach ($this->jsInline as $name => $properties) {
1252                                                 if (!$properties['compressed']) {
1253                                                         $error = '';
1254                                                         $this->jsInline[$name]['code'] = t3lib_div::minifyJavaScript($properties['code'], $error);
1255                                                         if ($error) {
1256                                                                 $this->compressError .= 'Error with minify JS Inline Block "' . $name . '": ' . $error . chr(10);
1257                                                         }
1258                                                 }
1259                                         }
1260                                 }
1261                         }
1262                 }
1263
1264                 if ($this->compressCss && $GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssCompressHandler']) {
1265                                 // use extern compress routine
1266                         $params = array (
1267                                 'cssInline' => &$this->cssInline
1268                         );
1269                         t3lib_div::callUserFunction($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['cssCompressHandler'], $params, $this);
1270                 } else {
1271                         if ($this->compressCss) {
1272                                 // own method, nothing implemented atm
1273                         }
1274                 }
1275         }
1276
1277 }
1278
1279 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagerenderer.php']) {
1280         include_once ($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagerenderer.php']);
1281 }
1282 ?>