This commit was manufactured by cvs2svn to create tag
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / media / scripts / plaintextLib.inc
index 4e8345d..7f2affe 100644 (file)
@@ -1,22 +1,22 @@
 <?php
 /***************************************************************
 *  Copyright notice
-*  
-*  (c) 1999-2003 Kasper Skårhøj (kasper@typo3.com)
+*
+*  (c) 1999-2004 Kasper Skaarhoj (kasper@typo3.com)
 *  All rights reserved
 *
-*  This script is part of the TYPO3 project. The TYPO3 project is 
+*  This script is part of the TYPO3 project. The TYPO3 project 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.
-* 
+*
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
-*  A copy is found in the textfile GPL.txt and important notices to the license 
+*  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
-* 
+*
 *  This script 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
 ***************************************************************/
 /**
  * Generating plain text content of content elements for Direct Mails
- * 
- * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ * $Id$
+ * Revised for TYPO3 3.6 June/2003 by Kasper Skaarhoj
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  */
 /**
  * [CLASS/FUNCTION INDEX of SCRIPT]
  *
  *
  *
- *  120: class user_plaintext 
- *  134:     function main_plaintext($content,$conf)   
- *  206:     function getMenuSitemap() 
- *  217:     function getShortcut()    
- *  228:     function getHTML($str=array())    
- *  238:     function getHeader()      
- *  248:     function getImages()      
- *  259:     function parseBody($str)  
- *  281:     function renderUploads($str,$upload_path='uploads/media/')        
- *  299:     function renderHeader($str,$type=0)       
- *  350:     function pad($lines,$preLineChar,$len)    
- *  366:     function breakContent($str)       
- *  382:     function breakBulletlist($str)    
- *  413:     function breakTable($str) 
- *  469:     function addDiv($messure,$content,$divChar,$joinChar,$cols)       
- *  485:     function traverseTable($tableLines)       
- *  512:     function renderImages($str,$links,$caption,$upload_path='uploads/pics/')  
- *  551:     function getLink($ll)     
- *  568:     function breakLines($str,$implChar="\n",$charWidth=0)     
- *  580:     function getString($str)  
- *  592:     function userProcess($mConfKey,$passVar)  
- *  610:     function atag_to_http($content,$conf)     
- *  629:     function typolist($content,$conf) 
- *  644:     function typohead($content,$conf) 
- *  663:     function typocode($content,$conf) 
+ *  123: class user_plaintext
+ *  137:     function main_plaintext($content,$conf)
+ *  209:     function getMenuSitemap()
+ *  220:     function getShortcut()
+ *  231:     function getHTML($str=array())
+ *  241:     function getHeader()
+ *  251:     function getImages()
+ *  262:     function parseBody($str)
+ *  284:     function renderUploads($str,$upload_path='uploads/media/')
+ *  302:     function renderHeader($str,$type=0)
+ *  353:     function pad($lines,$preLineChar,$len)
+ *  369:     function breakContent($str)
+ *  385:     function breakBulletlist($str)
+ *  416:     function breakTable($str)
+ *  472:     function addDiv($messure,$content,$divChar,$joinChar,$cols)
+ *  488:     function traverseTable($tableLines)
+ *  515:     function renderImages($str,$links,$caption,$upload_path='uploads/pics/')
+ *  554:     function getLink($ll)
+ *  571:     function breakLines($str,$implChar="\n",$charWidth=0)
+ *  583:     function getString($str)
+ *  595:     function userProcess($mConfKey,$passVar)
+ *  613:     function atag_to_http($content,$conf)
+ *  632:     function typolist($content,$conf)
+ *  647:     function typohead($content,$conf)
+ *  666:     function typocode($content,$conf)
  *
  * TOTAL FUNCTIONS: 24
  * (This index is automatically created/updated by the extension "extdeveval")
  *
  */
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 /**
  * Alternative rendering of content elements for Plain Text emails. That means text-only output. No HTML at all. Used by the Direct Mail extension.
- * Normally the plain text output should appear with type=99. 
+ * Normally the plain text output should appear with type=99.
  * To use this library you can include the static template "plugin.alt.plaintext"
- * 
+ *
  * ## Insert DMailer Boundaries for all elements.
  * config.insertDmailerBoundaries = 1
  * includeLibs.plaintextLib = media/scripts/plaintextLib.inc
- * 
+ *
  * ## Set up page/type number:
  * alt_plaintext >
  * alt_plaintext = PAGE
  *   marks.DATE.data = date:U
  *   marks.DATE.strftime = %e. %B %Y
  * }
- * 
+ *
  * (And then also "lib.alt_plaintext.renderObj" is configured extensively - basically with the TypoScript options passed to this class. See the static template "plugin.alt.plaintext")
- * 
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @package TYPO3
+ * @subpackage tslib
  * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=398&cHash=e3024de334
  */
 class user_plaintext {
        var $cObj;
        var $conf=array();
        var $charWidth=76;
-       
+
        /**
         * Main function, called from TypoScript
         * A content object that renders "tt_content" records. See the comment to this class for TypoScript example of how to trigger it.
         * This detects the CType of the current content element and renders it accordingly. Only wellknown types are rendered.
-        * 
+        *
         * @param       string          Empty, ignore.
         * @param       array           TypoScript properties for this content object/function call
         * @return      string          Plain text content
@@ -192,7 +195,7 @@ class user_plaintext {
 
                $lines[]='';    // First break.
                $content = implode(chr(10),$lines);
-               
+
                        // User processing:
                $content=$this->userProcess('userProc',$content);
                return $content;
@@ -200,7 +203,7 @@ class user_plaintext {
 
        /**
         * Creates a menu/sitemap
-        * 
+        *
         * @return      string          Content
         */
        function getMenuSitemap()       {
@@ -210,8 +213,8 @@ class user_plaintext {
        }
 
        /**
-        * Creates a shortcut
-        * 
+        * Creates a shortcut ("Insert Records")
+        *
         * @return      string          Content
         */
        function getShortcut()  {
@@ -221,7 +224,7 @@ class user_plaintext {
 
        /**
         * Creates an HTML element (stripping tags of course)
-        * 
+        *
         * @param       string          HTML content to process. If not passed along, the bodytext field is used.
         * @return      string          Content
         */
@@ -230,8 +233,8 @@ class user_plaintext {
        }
 
        /**
-        * Creates a header
-        * 
+        * Creates a header (used for most elements)
+        *
         * @return      string          Content
         * @see renderHeader()
         */
@@ -241,8 +244,8 @@ class user_plaintext {
        }
 
        /**
-        * Get images
-        * 
+        * Get images found in the "image" field of "tt_content"
+        *
         * @return      string          Content
         */
        function getImages()    {
@@ -251,8 +254,8 @@ class user_plaintext {
        }
 
        /**
-        * Parsing the bodytext field content, removing typical entities and <br> tags.
-        * 
+        * Parsing the bodytext field content, removing typical entities and <br /> tags.
+        *
         * @param       string          Field content from "bodytext"
         * @return      string          Processed content
         */
@@ -273,7 +276,7 @@ class user_plaintext {
 
        /**
         * Creates a list of links to uploaded files.
-        * 
+        *
         * @param       string          List of uploaded filenames from "uploads/media/" (or $upload_path)
         * @param       string          Alternative path value
         * @return      string          Content
@@ -291,7 +294,7 @@ class user_plaintext {
 
        /**
         * Renders a content element header, observing the layout type giving different header formattings
-        * 
+        *
         * @param       string          The header string
         * @param       integer         The layout type of the header (in the content element)
         * @return      string          Content
@@ -304,19 +307,19 @@ class user_plaintext {
                        if (!$type)     $type=$defaultType;
                        if ($type!=6)   {       // not hidden
                                $tConf = $hConf[$type.'.'];
-               
+
                                $lines=array();
-               
+
                                $blanks = t3lib_div::intInRange($tConf['preBlanks'],0,1000);
                                if ($blanks)    {
-                                       $lines[]=str_pad('', $blanks-1, chr(10)); 
+                                       $lines[]=str_pad('', $blanks-1, chr(10));
                                }
-                               
+
                                $lines=$this->pad($lines,$tConf['preLineChar'],$tConf['preLineLen']);
-       
+
                                $blanks = t3lib_div::intInRange($tConf['preLineBlanks'],0,1000);
                                if ($blanks)    {$lines[]=str_pad('', $blanks-1, chr(10));}
-       
+
                                if ($this->cObj->data['date'])          {$lines[] = $this->getString($hConf['datePrefix']).date($hConf['date']?$hConf['date']:'d-m-Y',$this->cObj->data['date']);}
                                $prefix='';
                                $str=$this->getString($tConf['prefix']).$str;
@@ -325,22 +328,22 @@ class user_plaintext {
                                if ($this->cObj->data['header_position']=='center')     {$prefix=str_pad(' ',floor(($this->charWidth-strlen($str))/2));}
                                $lines[]=$this->cObj->stdWrap($prefix.$str,$tConf['stdWrap.']);
                                if ($this->cObj->data['header_link'])           {$lines[] = $this->getString($hConf['linkPrefix']).$this->getLink($this->cObj->data['header_link']);}
-               
+
                                $blanks = t3lib_div::intInRange($tConf['postLineBlanks'],0,1000);
                                if ($blanks)    {$lines[]=str_pad('', $blanks-1, chr(10));}
-       
+
                                $lines=$this->pad($lines,$tConf['postLineChar'],$tConf['postLineLen']);
-               
+
                                $blanks = t3lib_div::intInRange($tConf['postBlanks'],0,1000);
                                if ($blanks)    {$lines[]=str_pad('', $blanks-1, chr(10));}
                                return implode(chr(10),$lines);
                        }
-               }               
+               }
        }
 
        /**
         * Function used to repeat a char pattern in head lines (like if you want "********" above/below a header)
-        * 
+        *
         * @param       array           Array of existing lines to which the new char-pattern should be added
         * @param       string          The character pattern to repeat. Default is "-"
         * @param       integer         The length of the line. $preLineChar will be repeated to fill in this length.
@@ -351,14 +354,14 @@ class user_plaintext {
                $strPad = t3lib_div::intInRange($len,0,1000);
                $strPadChar = $preLineChar?$preLineChar:'-';
                if ($strPad)    {
-                       $lines[]=str_pad('', $strPad, $strPadChar); 
+                       $lines[]=str_pad('', $strPad, $strPadChar);
                }
                return $lines;
        }
 
        /**
         * Function used to wrap the bodytext field content (or image caption) into lines of a max length of
-        * 
+        *
         * @param       string          The content to break
         * @return      string          Processed value.
         * @see main_plaintext(), breakLines()
@@ -375,7 +378,7 @@ class user_plaintext {
 
        /**
         * Breaks content lines into a bullet list
-        * 
+        *
         * @param       string          Content string to make into a bullet list
         * @return      string          Processed value
         */
@@ -384,7 +387,7 @@ class user_plaintext {
                $type=t3lib_div::intInRange($type,0,3);
 
                $tConf = $this->conf['bulletlist.'][$type.'.'];
-               
+
                $cParts = explode(chr(10),$str);
                reset($cParts);
                $lines=array();
@@ -395,7 +398,7 @@ class user_plaintext {
                        $bLen=strlen($bullet);
                        $bullet = substr(str_replace('#',$c,$bullet),0,$bLen);
                        $secondRow = substr($tConf['secondRow']?$this->getString($tConf['secondRow']):str_pad('',strlen($bullet),' '),0,$bLen);
-                       
+
                        $lines[]=$bullet.$this->breakLines($substrs,chr(10).$secondRow,$this->charWidth-$bLen);
 
                        $blanks = t3lib_div::intInRange($tConf['blanks'],0,1000);
@@ -406,7 +409,7 @@ class user_plaintext {
 
        /**
         * Formatting a table in plain text (based on the paradigm of lines being content rows and cells separated by "|")
-        * 
+        *
         * @param       string          Content string
         * @return      string          Processed value
         */
@@ -421,20 +424,20 @@ class user_plaintext {
                        if (trim($substrs))     {
                                $lineParts=explode('|',$substrs);
                                if (!$cols)     $cols=count($lineParts);
-                               
+
                                for ($a=0;$a<$cols;$a++)        {
-                                       $jdu = explode(chr(10),$this->breakLines($lineParts[$a],chr(10),ceil($this->charWidth/$cols)));                         
+                                       $jdu = explode(chr(10),$this->breakLines($lineParts[$a],chr(10),ceil($this->charWidth/$cols)));
                                        $lines[$c][$a]=$jdu;
                                }
                        }
                }
                $messure = $this->traverseTable($lines);
-               
-               
+
+
                $divChar='-';
                $joinChar='+';
                $colChar='|';
-               
+
                // Make table:
                $outLines = array();
                $outLines[]=$this->addDiv($messure,'',$divChar,$joinChar,$cols);
@@ -456,9 +459,9 @@ class user_plaintext {
 
        /**
         * Subfunction for breakTable(): Adds a divider line between table rows.
-        * 
+        *
         * @param       array           Some information about sizes
-        * @param       string          Empty.
+        * @param       string          Empty string.
         * @param       string          Character to use for the divider line, typically "-"
         * @param       string          Join character, typically "+"
         * @param       integer         Number of table columns
@@ -476,7 +479,7 @@ class user_plaintext {
 
        /**
         * Traverses the table lines/cells and creates arrays with statistics for line numbers and lengths
-        * 
+        *
         * @param       array           Array with [table rows] [table cells] [lines in cell]
         * @return      array           Statistics (max lines/lengths)
         * @access private
@@ -496,12 +499,12 @@ class user_plaintext {
                                if (count($vv)>intval($maxLines[$k]))   $maxLines[$k]=count($vv);
                        }
                }
-               return array($maxLen,$maxLines); 
+               return array($maxLen,$maxLines);
        }
 
        /**
         * Render block of images - which means creating lines with links to the images.
-        * 
+        *
         * @param       string          List of image filenames (from "image" field in tt_content records)
         * @param       string          Link value from the "image_link" field in tt_content records
         * @param       string          Caption text
@@ -523,7 +526,7 @@ class user_plaintext {
                                } else {
                                        $ll=$linksArr[0];
                                }
-                               
+
                                $theLink = $this->getLink($ll);
                                if ($theLink)   {$lines[]=$this->getString($this->conf['images.']['linkPrefix']).$theLink;}
                        }
@@ -538,13 +541,13 @@ class user_plaintext {
                        if ($cHeader)           $lines[]=$cHeader;
                        $lines[]=$this->breakContent($caption);
                }
-               
+
                return implode(chr(10),$lines);
        }
 
        /**
         * Returns a typolink URL based on input.
-        * 
+        *
         * @param       string          Parameter to typolink
         * @return      string          The URL returned from $this->cObj->getTypoLink_URL(); - possibly it prefixed with the URL of the site if not present already
         */
@@ -553,12 +556,12 @@ class user_plaintext {
                if (substr($theLink,0,4)!='http')       {
                        $theLink=$this->siteUrl.$theLink;
                }
-               return $theLink;                
+               return $theLink;
        }
-       
+
        /**
         * Breaking lines into fixed length lines, using t3lib_div::breakLinesForEmail()
-        * 
+        *
         * @param       string          The string to break
         * @param       string          Line break character
         * @param       integer         Length of lines, default is $this->charWidth
@@ -572,7 +575,7 @@ class user_plaintext {
        /**
         * Explodes a string with "|" and if the second part is found it will return this, otherwise the first part.
         * Used for many TypoScript properties used in this class since they need preceeding whitespace to be preserved.
-        * 
+        *
         * @param       string          Input string
         * @return      string          Output string
         * @access private
@@ -584,7 +587,7 @@ class user_plaintext {
 
        /**
         * Calls a user function for processing of data
-        * 
+        *
         * @param       string          TypoScript property name, pointing to the definition of the user function to call (from the TypoScript array internally in this class). This array is passed to the user function. Notice that "parentObj" property is a reference to this class ($this)
         * @param       mixed           Variable to process
         * @return      mixed           The processed $passVar as returned by the function call
@@ -599,9 +602,9 @@ class user_plaintext {
        }
 
        /**
-        * Function used by TypoScript "parseFunc" to process links in the bodytext. 
+        * Function used by TypoScript "parseFunc" to process links in the bodytext.
         * Extracts the link and shows it in plain text in a parathesis next to the link text. If link was relative the site URL was prepended.
-        * 
+        *
         * @param       string          Empty, ignore.
         * @param       array           TypoScript parameters
         * @return      string          Processed output.
@@ -621,12 +624,12 @@ class user_plaintext {
 
        /**
         * User function (called from TypoScript) for generating a bullet list (used in parsefunc)
-        * 
+        *
         * @param       string          Empty, ignore.
         * @param       array           TypoScript parameters
         * @return      string          Processed output.
         */
-       function typolist($content,$conf)       {       
+       function typolist($content,$conf)       {
                $this->conf = $this->cObj->mergeTSRef($conf,'bulletlist');
                $this->siteUrl=$conf['siteUrl'];
                $str = trim($this->cObj->getCurrentVal());
@@ -636,12 +639,12 @@ class user_plaintext {
 
        /**
         * User function (called from TypoScript) for generating a typo header tag (used in parsefunc)
-        * 
+        *
         * @param       string          Empty, ignore.
         * @param       array           TypoScript parameters
         * @return      string          Processed output.
         */
-       function typohead($content,$conf)       {       
+       function typohead($content,$conf)       {
                $this->conf = $this->cObj->mergeTSRef($conf,'header');
 
                $this->siteUrl=$conf['siteUrl'];
@@ -655,12 +658,12 @@ class user_plaintext {
 
        /**
         * User function (called from TypoScript) for generating a code listing (used in parsefunc)
-        * 
+        *
         * @param       string          Empty, ignore.
         * @param       array           TypoScript parameters
         * @return      string          Processed output.
         */
-       function typocode($content,$conf)       {       
+       function typocode($content,$conf)       {
                        // Nothing is really done here...
                $this->conf = $conf;
                $this->siteUrl=$conf['siteUrl'];