phpDocumentor Converters
PDFdefault
[ class tree: Converters ] [ index: Converters ] [ all elements ]
Converters
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Source for file PDFdefaultConverter.inc

Documentation is available at PDFdefaultConverter.inc

  1. <?php
  2. /**
  3.  * Outputs documentation in PDF format
  4.  *
  5.  * phpDocumentor :: automatic documentation generator
  6.  * 
  7.  * PHP versions 4 and 5
  8.  *
  9.  * Copyright (c) 2002-2006 Gregory Beaver
  10.  * 
  11.  * LICENSE:
  12.  * 
  13.  * This library is free software; you can redistribute it
  14.  * and/or modify it under the terms of the GNU Lesser General
  15.  * Public License as published by the Free Software Foundation;
  16.  * either version 2.1 of the License, or (at your option) any
  17.  * later version.
  18.  * 
  19.  * This library is distributed in the hope that it will be useful,
  20.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22.  * Lesser General Public License for more details.
  23.  * 
  24.  * You should have received a copy of the GNU Lesser General Public
  25.  * License along with this library; if not, write to the Free Software
  26.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27.  *
  28.  * @package    Converters
  29.  * @subpackage PDFdefault
  30.  * @author     Greg Beaver <[email protected]>
  31.  * @copyright  2002-2006 Gregory Beaver
  32.  * @license    http://www.opensource.org/licenses/lgpl-license.php LGPL
  33.  * @version    CVS: $Id: PDFdefaultConverter.inc,v 1.3 2006/04/30 22:18:14 cellog Exp $
  34.  * @filesource
  35.  * @link       http://www.phpdoc.org
  36.  * @link       http://pear.php.net/PhpDocumentor
  37.  * @since      1.2
  38.  */
  39. /**
  40.  * The Cezpdf class library
  41.  */
  42. include_once('phpDocumentor/Converters/PDF/default/class.phpdocpdf.php');
  43. /**
  44.  * PDF output converter.
  45.  * This Converter takes output from the {@link Parser} and converts it to PDF-ready output for use with {@link Cezpdf}.
  46.  * This is now beta code
  47.  *
  48.  * @package Converters
  49.  * @subpackage PDFdefault
  50.  * @author Greg Beaver <[email protected]>
  51.  * @since 1.1
  52.  * @version $Id: PDFdefaultConverter.inc,v 1.3 2006/04/30 22:18:14 cellog Exp $
  53.  * @todo Implement links to conflicts/inheritance
  54.  */
  55. class PDFdefaultConverter extends Converter
  56. {
  57.     /**
  58.      * default PDF Converter wants elements sorted by type as well as alphabetically
  59.      * @see Converter::$sort_page_contents_by_type
  60.      * @var boolean 
  61.      */
  62.     var $sort_absolutely_everything = true;
  63.     var $leftindex = array('classes' => false, 'pages' => false, 'functions' => false, 'defines' => false, 'globals' => false);
  64.     var $pagepackage_pagenums = array();
  65.     var $classpackage_pagenums = array();
  66.     /** @var string always PDF */
  67.     var $outputformat = 'PDF';
  68.     /** @var string always default */
  69.     var $name = 'default';
  70.     var $curpagepackage = false;
  71.     var $curclasspackage = false;
  72.     var $smarty_dir;
  73.     /**
  74.      * @var Cezpdf 
  75.      */
  76.     var $pdf = false;
  77.     var $ric_set = array();
  78.     /**
  79.      * Source files for appendix C are stored here
  80.      *
  81.      * Format: array(array(package => packagename, code => array(highlightedsource code 1, ...)))
  82.      * @var array 
  83.      */
  84.     var $_sourcecode;
  85.     /**
  86.      * @see Converter::Converter()
  87.      */
  88.     function PDFdefaultConverter(&$allp, &$packp, &$classes, &$procpages, $po, $pp, $qm, $targetDir, $templateDir, $title)
  89.     {
  90.         Converter::Converter($allp, $packp, $classes, $procpages, $po, $pp, $qm, $targetDir, $templateDir, $title);
  91.         $this->pdf =& new phpdocpdf($this, $this->getConverterDir() . PATH_DELIMITER .'templates/fonts/','letter');
  92.         $this->pdf->selectFont($this->getConverterDir() . PATH_DELIMITER .'templates/fonts/Helvetica.afm');
  93. // put a line top and bottom on all the pages
  94.         $this->pdf->ezSetMargins(50,70,50,50);
  95.         $template = &$this->newSmarty();
  96.         $this->pdf->ezText($template->fetch('footer.tpl'));
  97.         $template->assign('title',$title);
  98.         if (file_exists($this->templateDir . 'templates' . PATH_DELIMITER . 'media'. PATH_DELIMITER .'logo.jpg'))
  99.         {
  100.             $template->assign('logo',$this->templateDir . 'templates' . PATH_DELIMITER . 'media'. PATH_DELIMITER .'logo.jpg');
  101.         }
  102.         $this->pdf->ezText($template->fetch('title_page.tpl'));
  103.         unset($template);
  104.     }
  105.     
  106.     function writeSource($path, $value)
  107.     {
  108.         $templ = &$this->newSmarty();
  109.         $pathinfo = $this->proceduralpages->getPathInfo($path, $this);
  110.         $templ->assign('source',$value);
  111.         $templ->assign('package',$pathinfo['package']);
  112.         $templ->assign('subpackage',$pathinfo['subpackage']);
  113.         $templ->assign('name',$pathinfo['name']);
  114.         $templ->assign('source_loc',$pathinfo['source_loc']);
  115.         $templ->assign('docs',$pathinfo['docs']);
  116.         $templ->assign('dest', $this->getFileSourceName($path));
  117.         $this->setSourcePaths($path);
  118.         $this->_sourcecode[$pathinfo['package']][] = $templ->fetch('filesource.tpl');
  119.     }
  120.     
  121.     function postProcess($text)
  122.     {
  123.         return htmlspecialchars($text);
  124.     }
  125.     
  126.     function writeExample($title, $path, $source)
  127.     {
  128.         $templ = &$this->newSmarty();
  129.         $templ->assign('source',$source);
  130.         if (empty($title))
  131.         {
  132.             $title = 'example';
  133.             addWarning(PDERROR_EMPTY_EXAMPLE_TITLE, $path, $title);
  134.         }
  135.         $templ->assign('title',$title);
  136.         $templ->assign('file',$path);
  137.         $this->pdf->ezText($templ->fetch('examplesource.tpl'));
  138.     }
  139.     
  140.     function getExampleLink($path, $title)
  141.     {
  142.         return '';
  143.         return $this->returnLink('../__examplesource' . PATH_DELIMITER . 'exsource_'.$path.'.html',$title);
  144.     }
  145.     
  146.     function getSourceLink($path)
  147.     {
  148. //        var_dump(htmlentities('<c:ilink:'.$this->getFileSourceName($path).'>Source Code for this file</c:ilink>'));
  149.         return '<c:ilink:'.$this->getFileSourceName($path).'>Source Code for this file</c:ilink>';
  150.     }
  151.     
  152.     function getFileSourceName($path, $anchor = '')
  153.     {
  154.         return urlencode($anchor . parent::getFileSourceName($path));
  155.     }
  156.     
  157.     /**
  158.      * Retrieve a Converter-specific anchor to a segment of a source code file
  159.      * parsed via a {@tutorial tags.filesource.pkg} tag.
  160.      * @param string full path to source file
  161.      * @param string name of anchor
  162.      * @param string link text, if this is a link
  163.      * @param boolean returns either a link or a destination based on this
  164.      *                 parameter
  165.      * @return string link to an anchor, or the anchor
  166.      */
  167.     function getSourceAnchor($sourcefile,$anchor,$text = '',$link = false)
  168.     {
  169.         if ($link)
  170.         {
  171.             return '<c:ilink:' . $this->getFileSourceName($sourcefile, $anchor). '>' . $text . '</c:ilink>';
  172.         } else
  173.         {
  174.             return '</text><pdffunction:addDestination arg="'.$this->getFileSourceName($sourcefile, $anchor).'" arg="FitH" arg=$this->y /><text size="8">';
  175.         }
  176.     }
  177.     
  178.     /**
  179.      * Returns a bookmark using Cezpdf 009
  180.      *
  181.      * @param abstractLink a descendant of abstractlink should be passed, and never text
  182.      * @param string text to display in the link
  183.      */
  184.     function returnSee(&$element, $eltext = false)
  185.     {
  186.         if (!$element) return false;
  187.         if (!$eltext)
  188.         {
  189.             $eltext = '';
  190.             switch($element->type)
  191.             {
  192.                 case 'tutorial' :
  193.                 $eltext = $element->title;
  194.                 break;
  195.                 case 'method' :
  196.                 case 'var' :
  197.                 case 'const' :
  198.                 $eltext .= $element->class.'::';
  199.                 case 'page' :
  200.                 case 'define' :
  201.                 case 'class' :
  202.                 case 'function' :
  203.                 case 'global' :
  204.                 default :
  205.                 $eltext .= $element->name;
  206.                 if ($element->type == 'function' || $element->type == 'method') $eltext .= '()';
  207.                 break;
  208.             }
  209.         }
  210.         switch ($element->type)
  211.         {
  212.             case 'tutorial' :
  213.             return '<c:ilink:'.urlencode($element->type.$element->package.$element->subpackage.$element->name.$element->section).'>'.$eltext.'</c:ilink>';
  214.             case 'page' :
  215.             return '<c:ilink:'.urlencode($element->type.$element->package.$element->path).'>'.$eltext.'</c:ilink>';
  216.             case 'define' :
  217.             case 'global' :
  218.             case 'class' :
  219.             case 'function' :
  220.             return '<c:ilink:'.urlencode($element->type.$element->package.$element->name).'>'.$eltext.'</c:ilink>';
  221.             case 'method' :
  222.             case 'var' :
  223.             case 'const' :
  224.             return '<c:ilink:'.urlencode($element->type.$element->package.$element->class.'::'.$element->name).'>'.$eltext.'</c:ilink>';
  225.         }
  226.         return $element;
  227.     }
  228.     
  229.     /**
  230.      * @param string 
  231.      * @param string 
  232.      * @return string <c:alink:$link>$text</c:alink>
  233.      */
  234.     function returnLink($link,$text)
  235.     {
  236.         return "<c:alink:$link>$text</c:alink>";
  237.     }
  238.     
  239.     /**
  240.      * Convert README/INSTALL/CHANGELOG file contents to output format
  241.      * @param README|INSTALL|CHANGELOG
  242.      * @param string contents of the file
  243.      */
  244.     function Convert_RIC($name, $contents)
  245.     {
  246.         $this->ric_set[$name] = $contents;
  247.     }
  248.  
  249.     function convertDocBlock(&$element)
  250.     {
  251.         if (!$element->docblock) return;
  252.         $template = &$this->newSmarty();
  253.         
  254.         $nopackage = true;
  255.         if ($element->type == 'page' || $element->type == 'class') $nopackage = false;
  256.         $tagses = $element->docblock->listTags();
  257.         $tags = array();
  258.         $names = array('staticvar' => 'Static Variable','deprec' => 'Deprecated','abstract' => 'Abstract Element','todo' => 'TODO');
  259.         if (!$nopackage)
  260.         {
  261.             $tags[] = array('keyword' => 'Package','data' => $element->docblock->package);
  262.             if (!empty($element->docblock->subpackage)) $tags[] = array('keyword' => 'Sub-Package','data' => $element->docblock->subpackage);
  263.         }
  264.         if ($element->docblock->var)
  265.         {
  266.             $a = $element->docblock->var->Convert($this);
  267.             if (!empty($a))
  268.             $tags[] = array('keyword' => 'Var', 'data' => $a);
  269.         }
  270.         if ($element->docblock->funcglobals)
  271.         foreach($element->docblock->funcglobals as $global => $val)
  272.         {
  273.             if ($a = $this->getGlobalLink($global,$element->docblock->package))
  274.             {
  275.                 $global = $a;
  276.             }
  277.             $b = Converter::getLink($val[0]);
  278.             if (is_object($b) && phpDocumentor_get_class($b) == 'classlink')
  279.             {
  280.                 $val[0] = $this->returnSee($b);
  281.             }
  282.             $tags[] = array('keyword' => 'Global Variable Used','data' => $val[0].' '.$global.': '.$val[1]->Convert($this));
  283.         }
  284.         if ($element->docblock->statics)
  285.         foreach($element->docblock->statics as $static => $val)
  286.         {
  287.             $a = $val->Convert($this);
  288.             $tags[] = array('keyword' => 'Static Variable Used','data' => $val->converted_returnType.' '.$static.': '.$a);
  289.         }
  290.         foreach($tagses as $tag)
  291.         {
  292.             if (isset($names[$tag->keyword])) $tag->keyword = $names[$tag->keyword];
  293.             $tags[] = array("keyword" => ucfirst($tag->keyword),"data" => $tag->Convert($this));
  294.         }
  295.         $utags = array();
  296.         foreach($element->docblock->unknown_tags as $keyword => $t)
  297.         {
  298.             foreach($t as $tag)
  299.             $utags[] = array('keyword' => $keyword, 'data' => $tag->Convert($this));
  300.         }
  301.         if ($element->type == 'packagepage') return;
  302.         $sdesc = $element->docblock->getSDesc($this);
  303.         $desc = $element->docblock->getDesc($this);
  304.         $template->assign('utags',$utags);
  305.         $template->assign('tags',$tags);
  306.         $template->assign('sdesc',$sdesc);
  307.         $template->assign('desc',$desc);
  308.         if (false) // $element->type != 'page')
  309.         {
  310.             if ($element->type != 'var' && $element->type != 'method')
  311.             {
  312.                 $this->pdf->addDestination(urlencode($element->type.$element->docblock->package.$element->name),'FitH',$this->pdf->y);
  313.             } else
  314.             {
  315.                 $this->pdf->addDestination(urlencode($element->type.$element->docblock->package.$element->class.'::'.$element->name),'FitH',$this->pdf->y);
  316.             }
  317.         } elseif (false)
  318.         {
  319.             $this->pdf->addDestination(urlencode('page'.$element->parent->package.$element->parent->getPath()),'FitH',$this->pdf->y);
  320.         }
  321.         $this->convertParams($element);
  322.         $this->pdf->ezText($template->fetch('docblock.tpl'));
  323.     }
  324.     
  325.     function convertParams(&$element)
  326.     {
  327.         if ($element->type != 'function' && $element->type != 'method') return;
  328.         if (count($element->docblock->params))
  329.         {
  330.             $template = &$this->newSmarty();
  331.             $params = array();
  332.             if (count($element->docblock->params))
  333.             foreach($element->docblock->params as $param => $val)
  334.             {
  335.                 $a = $val->Convert($this);
  336.                 $params[] = array("name" => $param,"type" => $val->converted_returnType,"description" => $a);
  337.             }
  338.             $template->assign('params',$params);
  339.             $this->pdf->ezText($template->fetch('params.tpl'));
  340.         }
  341.     }
  342.     
  343.     function convertGlobal(&$element)
  344.     {
  345.         $sdesc = '';
  346.         if ($element->docblock->sdesc)
  347.         {
  348.             $sdesc = $element->docblock->sdesc->Convert($this);
  349.         }
  350.         $template = &$this->newSmarty();
  351.         $template->assign('linenumber',$element->getLineNumber());
  352.         if ($this->hasSourceCode($element->getPath()))
  353.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  354.         else
  355.         $template->assign('slink', false);
  356.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->name));
  357.         $template->assign('type',$element->getDataType($this));
  358.         $template->assign('name',$element->name);
  359.         $template->assign('value',$this->getGlobalValue($element->getValue()));
  360.         $template->assign('sdesc',$sdesc);
  361.         $this->pdf->ezText($template->fetch('global.tpl'));
  362.         $this->convertDocBlock($element);
  363.     }
  364.     
  365.     function getGlobalValue($value)
  366.     {
  367.         return parent::getGlobalValue(htmlspecialchars($value));
  368.     }
  369.     
  370.     function convertMethod(&$element)
  371.     {
  372.         $sdesc = '';
  373.         if ($element->docblock->sdesc)
  374.         {
  375.             $sdesc = $element->docblock->sdesc->Convert($this);
  376.         }
  377.         $params = array();
  378.         if (count($element->docblock->params))
  379.         foreach($element->docblock->params as $param => $val)
  380.         {
  381.             $a = $val->Convert($this);
  382.             $params[$param] = array("var" => $param,"datatype" => $val->converted_returnType,"data" => $a);
  383.         }
  384.         if ($element->docblock->return)
  385.         {
  386.             if (!$element->docblock->return->returnType) $element->docblock->return->returnType = 'void';
  387.         }
  388.         $template = &$this->newSmarty();
  389.         $template->assign('class',$this->class);
  390.         $template->assign('constructor',$element->isConstructor);
  391.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->class.'::'.$element->name));
  392.         $template->assign('linenumber',$element->getLineNumber());
  393.         if ($this->hasSourceCode($element->getPath()))
  394.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  395.         else
  396.         $template->assign('slink',false);
  397.         $ret = 'void';
  398.         if (isset($element->docblock->return))
  399.         {
  400.             $ret = $element->docblock->return->returnType;
  401.         }
  402.         $template->assign('return',$ret);
  403.         $template->assign('functioncall',$element->getFunctionCall());
  404.         $template->assign('intricatefunctioncall',$element->getIntricateFunctionCall($this,$params));
  405.         $template->assign('sdesc',$sdesc);
  406.         $this->pdf->ezText($template->fetch('method.tpl'));
  407.         $this->convertDocBlock($element);
  408.     }
  409.     
  410.     function convertVar(&$element)
  411.     {
  412.         $sdesc = '';
  413.         if ($element->docblock->sdesc)
  414.         {
  415.             $sdesc = $element->docblock->sdesc->Convert($this);
  416.         }
  417.         $template = &$this->newSmarty();
  418.         $template->assign('class',$this->class);
  419.         $template->assign('linenumber',$element->getLineNumber());
  420.         if ($this->hasSourceCode($element->getPath()))
  421.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  422.         else
  423.         $template->assign('slink',false);
  424.         $template->assign('type',$element->docblock->var->returnType);
  425.         $template->assign('name',$element->name);
  426.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->class.'::'.$element->name));
  427.         $template->assign('value',$element->value);
  428.         $template->assign('sdesc',$sdesc);
  429.         $this->pdf->ezText($template->fetch('var.tpl'));
  430.         $this->convertDocBlock($element);
  431.     }
  432.     
  433.     function convertConst(&$element)
  434.     {
  435.         $sdesc = '';
  436.         if ($element->docblock->sdesc)
  437.         {
  438.             $sdesc = $element->docblock->sdesc->Convert($this);
  439.         }
  440.         $template = &$this->newSmarty();
  441.         $template->assign('class',$this->class);
  442.         $template->assign('linenumber',$element->getLineNumber());
  443.         if ($this->hasSourceCode($element->getPath()))
  444.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  445.         else
  446.         $template->assign('slink',false);
  447.         $template->assign('name',$element->name);
  448.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->class.'::'.$element->name));
  449.         $template->assign('value',$element->value);
  450.         $template->assign('sdesc',$sdesc);
  451.         $this->pdf->ezText($template->fetch('const.tpl'));
  452.         $this->convertDocBlock($element);
  453.     }
  454.     
  455.     function convertClass(&$element)
  456.     {
  457.         $template = &$this->newSmarty();
  458.         if ($this->curclasspackage != $element->docblock->package)
  459.         {
  460.             $template->assign('includeheader',true);
  461.             if (isset($this->package_pages[$element->docblock->package]))
  462.             {
  463.                 $template->assign('ppage',$this->package_pages[$element->docblock->package]);
  464.                 $template->assign('isclass',true);
  465.                 unset($this->package_pages[$element->docblock->package]);
  466.             }
  467.             $template->assign('classeslink',rawurlencode("Package ".$element->docblock->package." Classes"));
  468.         }
  469.         $sdesc = '';
  470.         if ($element->docblock->sdesc)
  471.         {
  472.             $sdesc = $element->docblock->sdesc->Convert($this);
  473.         }
  474.         $this->curclasspackage = $element->docblock->package;
  475.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->name));
  476.         $template->assign('package',$element->docblock->package);
  477.         $template->assign('linenumber',$element->getLineNumber());
  478.         if ($this->hasSourceCode($element->getPath()))
  479.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  480.         else
  481.         $template->assign('slink',false);
  482.         $template->assign('name',$element->name);
  483.         $template->assign('sdesc',$sdesc);
  484.         $this->pdf->ezText($template->fetch('class.tpl'));
  485.         $this->convertDocBlock($element);
  486.     }
  487.     
  488.     function convertInclude(&$element)
  489.     {
  490.         $template = &$this->newSmarty();
  491.         $template->assign('linenumber',$element->getLineNumber());
  492.         if ($this->hasSourceCode($element->getPath()))
  493.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  494.         else
  495.         $template->assign('slink',false);
  496.         $template->assign('name',$element->name);
  497.         $template->assign('value',$this->getIncludeValue($element->getValue(), $element->getPath()));
  498.         $this->pdf->ezText($template->fetch('include.tpl'));
  499.         $this->convertDocBlock($element);
  500.     }
  501.     
  502.     function convertFunction(&$element)
  503.     {
  504.         $sdesc = '';
  505.         if ($element->docblock->sdesc)
  506.         {
  507.             $sdesc = $element->docblock->sdesc->Convert($this);
  508.         }
  509.         $params = array();
  510.         if (count($element->docblock->params))
  511.         foreach($element->docblock->params as $param => $val)
  512.         {
  513.             $a = $val->Convert($this);
  514.             $params[$param] = array("var" => $param,"datatype" => $val->converted_returnType,"data" => $a);
  515.         }
  516.         if ($element->docblock->return)
  517.         {
  518.             if (!$element->docblock->return->returnType) $element->docblock->return->returnType = 'void';
  519.         }
  520.         $template = &$this->newSmarty();
  521.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->name));
  522.         $template->assign('linenumber',$element->getLineNumber());
  523.         if ($this->hasSourceCode($element->getPath()))
  524.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  525.         else
  526.         $template->assign('slink',false);
  527.         $template->assign('return',$element->docblock->return->returnType);
  528.         $template->assign('functioncall',$element->getFunctionCall());
  529.         $template->assign('intricatefunctioncall',$element->getIntricateFunctionCall($this,$params));
  530.         $template->assign('sdesc',$sdesc);
  531.         $this->pdf->ezText($template->fetch('function.tpl'));
  532.         $this->convertDocBlock($element);
  533.     }
  534.     
  535.     function convertDefine(&$element)
  536.     {
  537.         $sdesc = '';
  538.         if ($element->docblock->sdesc)
  539.         {
  540.             $sdesc = $element->docblock->sdesc->Convert($this);
  541.         }
  542.         $template = &$this->newSmarty();
  543.         $template->assign('linenumber',$element->getLineNumber());
  544.         if ($this->hasSourceCode($element->getPath()))
  545.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  546.         else
  547.         $template->assign('slink',false);
  548.         $template->assign('name',$element->name);
  549.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->name));
  550.         $template->assign('value',$element->value);
  551.         $template->assign('sdesc',$sdesc);
  552.         $this->pdf->ezText($template->fetch('define.tpl'));
  553.         $this->convertDocBlock($element);
  554.     }
  555.     
  556.     function convertPage(&$element)
  557.     {
  558.         $template = &$this->newSmarty();
  559.         $template->assign('includeheader',false);
  560.         $sdesc = '';
  561.         if ($element->docblock->sdesc)
  562.         {
  563.             $sdesc = $element->docblock->sdesc->Convert($this);
  564.         }
  565.         if (count($element->elements) || ($sdesc) || count($element->docblock->tags))
  566.         {
  567.             if ($this->curpagepackage != $element->parent->package)
  568.             {
  569.                 $template->assign('includeheader',true);
  570.                 if (isset($this->package_pages[$element->parent->package]))
  571.                 {
  572.                     $template->assign('ppage',$this->package_pages[$element->parent->package]);
  573.                     unset($this->package_pages[$element->parent->package]);
  574.                 }
  575.             }
  576.             $this->curpagepackage = $element->parent->package;
  577.             $template->assign('dest', urlencode('page'.$element->parent->package.$element->parent->getPath()));
  578.             $template->assign('sdesc',$sdesc);
  579.             $template->assign('package',$element->parent->package);
  580.             $template->assign('name',$element->parent->file);
  581.             $this->pdf->ezText($template->fetch('page.tpl'));
  582.             $this->convertDocBlock($element);
  583.         }
  584.     }
  585.     
  586.         
  587.     /**
  588.      * Used to translate an XML DocBook tag from a tutorial by reading the
  589.      * options.ini file for the template.
  590.      * @param string tag name
  591.      * @param string any attributes Format: array(name => value)
  592.      * @param string the tag contents, if any
  593.      * @param string the tag contents, if any, unpost-processed
  594.      * @return string 
  595.      */
  596.     function TranslateTag($name,$attr,$cdata,$unconvertedcdata)
  597.     {
  598.         if ($name == 'example' && @$attr['role'] == 'html')
  599.         {
  600.             $cdata = htmlspecialchars($cdata);
  601.             $unconvertedcdata = htmlspecialchars($unconvertedcdata);
  602.         }
  603.         if ($name == 'programlisting' && @$attr['role'] == 'php')
  604.         {
  605.             $unconvertedcdata = strtr($unconvertedcdata, array_flip(get_html_translation_table(HTML_SPECIALCHARS)));
  606.             $a = parent::TranslateTag($name, $attr, $cdata, $unconvertedcdata);
  607. //            var_dump(htmlspecialchars($cdata), htmlspecialchars($unconvertedcdata), htmlspecialchars($a));
  608.             return $a;
  609.         }
  610.         return parent::TranslateTag($name, $attr, $cdata, $unconvertedcdata);
  611.     }
  612.  
  613.     function getPageName(&$element)
  614.     {
  615.         if (phpDocumentor_get_class($element) == 'parserpage') return $element->getName();
  616.         return $element->parent->getName();
  617.     }
  618.  
  619.     function getTutorialId($package,$subpackage,$tutorial,$id)
  620.     {
  621.         return 'tutorial'.$package.$subpackage.$tutorial.$id;
  622.     }
  623.     
  624.     function getCData($value)
  625.     {
  626.         return str_replace(array('<c:','<C:'),array("&lt;c:","&lt;C:"),$value);
  627.     }
  628.     
  629.     /**
  630.      * @deprecated html package pages just don't work with PDF, use {@tutorial tutorials.pkg}
  631.      */
  632.     function convertPackagepage(&$element)
  633.     {
  634.         $x = $element->Convert($this);
  635.         $x = substr($x,strpos($x,'<body'));
  636.         $this->package_pages[$element->package] = trim(substr($x,strpos($x,'>') + 1,strpos($x,'</body>') - 6));
  637.     }
  638.     
  639.     function convertTutorial(&$element)
  640.     {
  641.         $x = $element->Convert($this, true);
  642.         $template = &$this->newSmarty();
  643.         $template->assign('package',$element->package);
  644.         $template->assign('subpackage',$element->subpackage);
  645.         $template->assign('contents',$x);
  646.         $template->assign('title',$element->getTitle($this));
  647.         $template->assign('child',$element->parent);
  648.         if (isset($element->parent->parent)) $template->assign('hasparent',$element->parent->parent);
  649.         $template->assign('element',$element);
  650.         $this->pdf->ezText($template->fetch('tutorial.tpl'));
  651.     }
  652.     
  653.     /**
  654.      * returns a template-enabled array of class trees
  655.      * 
  656.      * @param    string    $package    package to generate a class tree for
  657.      * @see $roots, getRootTree()
  658.      */
  659.     function generateFormattedClassTrees($package)
  660.     {
  661.         if (!isset($this->roots[$package])) return array();
  662.         $roots = $trees = array();
  663.         $roots = $this->roots[$package];
  664.         for($i=0;$i<count($roots);$i++)
  665.         {
  666.             $trees[] = array('class' => $roots[$i],'class_tree' => "<ul>\n".$this->getRootTree($this->getSortedClassTreeFromClass($roots[$i],$package,''),$package)."</ul>\n");
  667.         }
  668.         return $trees;
  669.     }
  670.     
  671.     /**
  672.      * return formatted class tree for the Class Trees page
  673.      *
  674.      * @param array $tree output from {@link getSortedClassTreeFromClass()}
  675.      * @see Classes::$definitechild, generateFormattedClassTrees()
  676.      * @return string 
  677.      */
  678.     function getRootTree($tree,$package)
  679.     {
  680.         if (!$tree) return '';
  681.         $my_tree = '';
  682.         $cur = '#root';
  683.         $lastcur = array(false);
  684.         $kids = array();
  685.         $dopar = false;
  686.         if ($tree[$cur]['parent'])
  687.         {
  688.             $dopar = true;
  689.             if (!is_object($tree[$cur]['parent']))
  690.             {
  691. //                debug("parent ".$tree[$cur]['parent']." not found");
  692.                 $my_tree .= '<li>' . $tree[$cur]['parent'] .'<ul>';
  693.             }
  694.             else
  695.             {
  696. //                        debug("parent ".$this->returnSee($tree[$cur]['parent'], false, false)." in other package");
  697.                 $my_tree .= '<li>' . $this->returnSee($tree[$cur]['parent'], false, false);
  698.                 if ($tree[$cur]['parent']->package != $package) $my_tree .= ' <b>(Different package)</b><ul>';
  699.             }
  700.         }
  701.         do
  702.         {
  703. //            fancy_debug($cur,$lastcur,$kids);
  704.             if (count($tree[$cur]['children']))
  705.             {
  706. //                debug("$cur has children");
  707.                 if (!isset($kids[$cur]))
  708.                 {
  709. //                    debug("set $cur kids");
  710.                     $kids[$cur] = 1;
  711.                     $my_tree .= '<li>'.$this->returnSee($tree[$cur]['link'], false, false);
  712.                     $my_tree .= '<ul>'."\n";
  713.                 }
  714.                 array_push($lastcur,$cur);
  715.                 list(,$cur) = each($tree[$cur]['children']);
  716. //                var_dump('listed',$cur);
  717.                 if ($cur)
  718.                 {
  719.                     $cur = $cur['package'] . '#' . $cur['class'];
  720. //                    debug("set cur to child $cur");
  721. //                    $my_tree .= '<li>'.$this->returnSee($tree[$cur]['link'], false, false);
  722.                     continue;
  723.                 } else
  724.                 {
  725. //                    debug("end of children for $cur");
  726.                     $cur = array_pop($lastcur);
  727.                     $cur = array_pop($lastcur);
  728.                     $my_tree .= '</ul></li>'."\n";
  729.                     if ($dopar && ($cur == '#root' || !$cur)) $my_tree .= '</ul></li>';
  730.                 }
  731.             } else 
  732.             {
  733. //                debug("$cur has no children");
  734.                 $my_tree .= '<li>'.$this->returnSee($tree[$cur]['link'], false, false)."</li>";
  735.                 if ($dopar && $cur == '#root') $my_tree .= '</ul></li>';
  736.                 $cur = array_pop($lastcur);
  737.             }
  738.         } while ($cur);
  739.         return $my_tree;
  740.     }
  741.     
  742.     /**
  743.      * calls {@link Cezpdf::ezOutput()} and writes documentation.pdf to targetDir
  744.      */
  745.     function Output($title = 'Generated Documentation')
  746.     {
  747.         phpDocumentor_out("Generating PDF file..");
  748.         flush();
  749.         $template = &$this->newSmarty();
  750.         $this->pdf->ezText($template->fetch('appendix_title_page.tpl'));
  751.         $trees = array();
  752.         foreach($this->all_packages as $package => $rest)
  753.         {
  754.             if (!isset($this->pkg_elements[$package])) continue;
  755.             $a = array();
  756.             phpDocumentor_out('.');
  757.             flush();
  758.             $a['package'] = $package;
  759.             $a["trees"] = $this->generateFormattedClassTrees($package);
  760.             $trees[] = $a;
  761.         }
  762.         $template->assign('trees',$trees);
  763.         $this->pdf->ezText($template->fetch('classtree.tpl'));
  764.         phpDocumentor_out('.');
  765.         if (count($this->ric_set))
  766.         $this->pdf->ezText($template->fetch('ric_title_page.tpl'));
  767.         foreach($this->ric_set as $name => $contents)
  768.         {
  769.             $template->assign('contents',$contents);
  770.             $template->assign('name',$name);
  771.             $this->pdf->ezText($template->fetch('ric.tpl'));
  772.         }
  773.         if (count($this->_sourcecode))
  774.         {
  775.             $this->pdf->ezText($template->fetch('source_title_page.tpl'));
  776.             $template->assign('source',$this->_sourcecode);
  777.             $this->pdf->ezText($template->fetch('source_loop.tpl'));
  778.         }
  779.         flush();
  780.         if (count($this->todoList))
  781.         {
  782.             $todolist = array();
  783.             foreach($this->todoList as $package => $alltodos)
  784.             {
  785.                 foreach($alltodos as $todos)
  786.                 {
  787.                     $converted = array();
  788.                     $converted['link'] = $this->returnSee($todos[0]);
  789.                     if (!is_array($todos[1]))
  790.                     {
  791.                         $converted['todos'][] = $todos[1]->Convert($this);
  792.                     } else
  793.                     {
  794.                         foreach($todos[1] as $todo)
  795.                         {
  796.                             $converted['todos'][] = $todo->Convert($this);
  797.                         }
  798.                     }
  799.                     $todolist[$package][] = $converted;
  800.                 }
  801.             }
  802.             $template->assign('todos',$todolist);
  803.             
  804.             $this->pdf->ezText($template->fetch('todolist.tpl'));
  805.         }
  806.         if (false) {
  807.         $fp = @fopen("C:/Documents and Settings/Owner/Desktop/pdfsourceorig.txt",'w');
  808.         if ($fp)
  809.         {
  810.             $a = $this->pdf->ezOutput(true); // debug
  811.             fwrite($fp, $a, strlen($a));
  812.             fclose($fp);
  813.         }
  814.         }
  815.         $this->pdf->setupTOC();
  816.         $template->assign('contents',$this->pdf->reportContents);
  817.         $this->pdf->ezText($template->fetch('toc.tpl'));
  818.         $x = $this->pdf->ezOutput(false, $template);
  819.         phpDocumentor_out("done\n");
  820.         flush();
  821.         $this->writeFile("documentation.pdf", $x, true);
  822.     }
  823.     
  824.     function mystrnatcasecmp($a,$b)
  825.     {
  826.         return strnatcasecmp($a[0],$b[0]);
  827.     }
  828.     
  829.     
  830.     /**
  831.      * @param string name of class
  832.      * @param string package name
  833.      * @param string full path to look in (used in index generation)
  834.      * @return mixed false if not found, or an html a link to the class's documentation
  835.      * @see parent::getClassLink()
  836.      */
  837.     function getClassLink($expr,$package, $file = false,$text = false)
  838.     {
  839.         $a = Converter::getClassLink($expr,$package,$file);
  840.         if (!$a) return false;
  841.         return $this->returnSee($a, $text);
  842.     }
  843.  
  844.     /**
  845.      * @param string name of function
  846.      * @param string package name
  847.      * @param string full path to look in (used in index generation)
  848.      * @param boolean deprecated
  849.      * @return mixed false if not found, or an html a link to the function's documentation
  850.      * @see parent::getFunctionLink()
  851.      */
  852.     function getFunctionLink($expr,$package, $file = false,$text = false)
  853.     {
  854.         $a = Converter::getFunctionLink($expr,$package,$file);
  855.         if (!$a) return false;
  856.         return $this->returnSee($a, $text);
  857.     }
  858.  
  859.     /**
  860.      * @param string name of define
  861.      * @param string package name
  862.      * @param string full path to look in (used in index generation)
  863.      * @param boolean deprecated
  864.      * @return mixed false if not found, or an html a link to the define's documentation
  865.      * @see parent::getDefineLink()
  866.      */
  867.     function getDefineLink($expr,$package, $file = false,$text = false)
  868.     {
  869.         $a = Converter::getDefineLink($expr,$package,$file);
  870.         if (!$a) return false;
  871.         return $this->returnSee($a, $text);
  872.     }
  873.  
  874.     /**
  875.      * @param string name of global variable
  876.      * @param string package name
  877.      * @param string full path to look in (used in index generation)
  878.      * @param boolean deprecated
  879.      * @return mixed false if not found, or an html a link to the global variable's documentation
  880.      * @see parent::getGlobalLink()
  881.      */
  882.     function getGlobalLink($expr,$package, $file = false,$text = false)
  883.     {
  884.         $a = Converter::getGlobalLink($expr,$package,$file);
  885.         if (!$a) return false;
  886.         return $this->returnSee($a, $text);
  887.     }
  888.  
  889.     /**
  890.      * @param string name of procedural page
  891.      * @param string package name
  892.      * @param string full path to look in (used in index generation)
  893.      * @param boolean deprecated
  894.      * @return mixed false if not found, or an html a link to the procedural page's documentation
  895.      * @see parent::getPageLink()
  896.      */
  897.     function getPageLink($expr,$package, $path = false,$text = false)
  898.     {
  899.         $a = Converter::getPageLink($expr,$package,$path);
  900.         if (!$a) return false;
  901.         return $this->returnSee($a, $text);
  902.     }
  903.  
  904.     /**
  905.      * @param string name of method
  906.      * @param string class containing method
  907.      * @param string package name
  908.      * @param string full path to look in (used in index generation)
  909.      * @param boolean deprecated
  910.      * @return mixed false if not found, or an html a link to the method's documentation
  911.      * @see parent::getMethodLink()
  912.      */
  913.     function getMethodLink($expr,$class,$package, $file = false,$text = false)
  914.     {
  915.         $a = Converter::getMethodLink($expr,$class,$package,$file);
  916.         if (!$a) return false;
  917.         return $this->returnSee($a, $text);
  918.     }
  919.  
  920.     /**
  921.      * @param string name of var
  922.      * @param string class containing var
  923.      * @param string package name
  924.      * @param string full path to look in (used in index generation)
  925.      * @param boolean deprecated
  926.      * @param boolean return just the URL, or enclose it in an html a tag
  927.      * @return mixed false if not found, or an html a link to the var's documentation
  928.      * @see parent::getVarLink()
  929.      */
  930.     function getVarLink($expr,$class,$package, $file = false,$text = false)
  931.     {
  932.         $a = Converter::getVarLink($expr,$class,$package,$file);
  933.         if (!$a) return false;
  934.         return $this->returnSee($a, $text);
  935.     }
  936.  
  937.     /**
  938.      * @param string name of class constant
  939.      * @param string class containing class constant
  940.      * @param string package name
  941.      * @param string full path to look in (used in index generation)
  942.      * @param boolean deprecated
  943.      * @param boolean return just the URL, or enclose it in an html a tag
  944.      * @return mixed false if not found, or an html a link to the var's documentation
  945.      * @see parent::getConstLink()
  946.      */
  947.     function getConstLink($expr,$class,$package, $file = false,$text = false)
  948.     {
  949.         $a = Converter::getConstLink($expr,$class,$package,$file);
  950.         if (!$a) return false;
  951.         return $this->returnSee($a, $text);
  952.     }
  953.  
  954.     function setTemplateDir($dir)
  955.     {
  956.         Converter::setTemplateDir($dir);
  957.         $this->smarty_dir = $this->templateDir;
  958.     }
  959.     
  960.     /** @return 1 always the same */
  961.     function getState()
  962.     {
  963.         return 1;
  964.     }
  965.     
  966.     /**
  967.      * @see parent::unmangle()
  968.      */
  969.     function unmangle($notused,$source)
  970.     {
  971. //        $source = str_replace("\n","<mybr>",$source);
  972.         return $source;
  973.     }
  974. }
  975. ?>
Documentation generated on Tue, 24 Oct 2006 09:25:26 -0500 by phpDocumentor 1.3.1