Converters
[ class tree: Converters ] [ index: Converters ] [ all elements ]
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
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 <cellog@php.net>
  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.7 2007/05/31 02:02:42 ashnazg 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 <cellog@php.net>
  51.  * @since 1.1
  52.  * @version $Id: PDFdefaultConverter.inc,v 1.7 2007/05/31 02:02:42 ashnazg 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.         if ($element->docblock->properties)
  291.         foreach($element->docblock->properties as $property => $val)
  292.         {
  293.             $a = $val->Convert($this);
  294.             $tags[] = array('keyword' => ucfirst($val->keyword),'data' => $val->converted_returnType.' '.$property.': '.$a);
  295.         }
  296.         foreach($tagses as $tag)
  297.         {
  298.             if (isset($names[$tag->keyword])) $tag->keyword = $names[$tag->keyword];
  299.             $tags[] = array("keyword" => ucfirst($tag->keyword),"data" => $tag->Convert($this));
  300.         }
  301.         $utags = array();
  302.         foreach($element->docblock->unknown_tags as $keyword => $t)
  303.         {
  304.             foreach($t as $tag)
  305.             $utags[] = array('keyword' => $keyword, 'data' => $tag->Convert($this));
  306.         }
  307.         if ($element->type == 'packagepage') return;
  308.         $sdesc = $element->docblock->getSDesc($this);
  309.         $desc = $element->docblock->getDesc($this);
  310.         $template->assign('utags',$utags);
  311.         $template->assign('tags',$tags);
  312.         $template->assign('sdesc',$sdesc);
  313.         $template->assign('desc',$desc);
  314.         if (false) // $element->type != 'page')
  315.         {
  316.             if ($element->type != 'var' && $element->type != 'method')
  317.             {
  318.                 $this->pdf->addDestination(urlencode($element->type.$element->docblock->package.$element->name),'FitH',$this->pdf->y);
  319.             } else
  320.             {
  321.                 $this->pdf->addDestination(urlencode($element->type.$element->docblock->package.$element->class.'::'.$element->name),'FitH',$this->pdf->y);
  322.             }
  323.         } elseif (false)
  324.         {
  325.             $this->pdf->addDestination(urlencode('page'.$element->parent->package.$element->parent->getPath()),'FitH',$this->pdf->y);
  326.         }
  327.         $this->convertParams($element);
  328.         $this->pdf->ezText($template->fetch('docblock.tpl'));
  329.     }
  330.     
  331.     function convertParams(&$element)
  332.     {
  333.         if ($element->type != 'function' && $element->type != 'method') return;
  334.         if (count($element->docblock->params))
  335.         {
  336.             $template = &$this->newSmarty();
  337.             $params = array();
  338.             if (count($element->docblock->params))
  339.             foreach($element->docblock->params as $param => $val)
  340.             {
  341.                 $a = $val->Convert($this);
  342.                 $params[] = array("name" => $param,"type" => $val->converted_returnType,"description" => $a);
  343.             }
  344.             $template->assign('params',$params);
  345.             $this->pdf->ezText($template->fetch('params.tpl'));
  346.         }
  347.     }
  348.     
  349.     function convertGlobal(&$element)
  350.     {
  351.         $sdesc = '';
  352.         if ($element->docblock->sdesc)
  353.         {
  354.             $sdesc = $element->docblock->sdesc->Convert($this);
  355.         }
  356.         $template = &$this->newSmarty();
  357.         $template->assign('linenumber',$element->getLineNumber());
  358.         if ($this->hasSourceCode($element->getPath()))
  359.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  360.         else
  361.         $template->assign('slink', false);
  362.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->name));
  363.         $template->assign('type',$element->getDataType($this));
  364.         $template->assign('name',$element->name);
  365.         $template->assign('value',$this->getGlobalValue($element->getValue()));
  366.         $template->assign('sdesc',$sdesc);
  367.         $this->pdf->ezText($template->fetch('global.tpl'));
  368.         $this->convertDocBlock($element);
  369.     }
  370.     
  371.     function getGlobalValue($value)
  372.     {
  373.         return parent::getGlobalValue(htmlspecialchars($value));
  374.     }
  375.     
  376.     function convertMethod(&$element)
  377.     {
  378.         $sdesc = '';
  379.         if ($element->docblock->sdesc)
  380.         {
  381.             $sdesc = $element->docblock->sdesc->Convert($this);
  382.         }
  383.         $params = array();
  384.         if (count($element->docblock->params))
  385.         foreach($element->docblock->params as $param => $val)
  386.         {
  387.             $a = $val->Convert($this);
  388.             $params[$param] = array("var" => $param,"datatype" => $val->converted_returnType,"data" => $a);
  389.         }
  390.         if ($element->docblock->return)
  391.         {
  392.             if (!$element->docblock->return->returnType) $element->docblock->return->returnType = 'void';
  393.         }
  394.         $template = &$this->newSmarty();
  395.         $template->assign('class',$this->class);
  396.         $template->assign('constructor',$element->isConstructor);
  397.         $template->assign('dest', urlencode($element->type.$element->docblock->package.$element->class.'::'.$element->name));
  398.         $template->assign('linenumber',$element->getLineNumber());
  399.         if ($this->hasSourceCode($element->getPath()))
  400.         $template->assign('slink',$this->getSourceAnchor($element->getPath(),$element->getLineNumber(),$element->getLineNumber(),true));
  401.         else
  402.         $template->assign('slink',false