Source for file HTMLframesConverter.inc

Documentation is available at HTMLframesConverter.inc

<?php
/**
* HTML original framed output converter, modified to use Smarty Template.
* This Converter takes output from the {@link Parser} and converts it to HTML-ready output for use with {@link Smarty}.
*
* phpDocumentor :: automatic documentation generator
*
* PHP versions 4 and 5
*
*
* LICENSE:
*
* This library is free software; you can redistribute it
* and/or modify it under the terms of the GNU Lesser General
* Public License as published by the Free Software Foundation;
* either version 2.1 of the License, or (at your option) any
* later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @package Converters
* @subpackage HTMLframes
* @author Gregory Beaver <cellog@php.net>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version CVS: $Id: HTMLframesConverter.inc,v 1.16 2007/04/19 20:20:57 ashnazg Exp $
* @filesource
* @link http://www.phpdoc.org
* @link http://pear.php.net/PhpDocumentor
* @see parserDocBlock, parserInclude, parserPage, parserClass
* @see parserDefine, parserFunction, parserMethod, parserVar
* @since 1.2
*/
/**
* HTML output converter.
* This Converter takes output from the {@link Parser} and converts it to HTML-ready output for use with {@link Smarty}.
*
* @package Converters
* @subpackage HTMLframes
* @see parserDocBlock, parserInclude, parserPage, parserClass, parserDefine, parserFunction, parserMethod, parserVar
* @author Greg Beaver <cellog@php.net>
* @since 1.2
* @version $Id: HTMLframesConverter.inc,v 1.16 2007/04/19 20:20:57 ashnazg Exp $
*/
class HTMLframesConverter extends Converter
{
/**
* This converter knows about the new root tree processing
* In order to fix PEAR Bug #6389
* @var boolean
*/
var $processSpecialRoots = true;
/**
* Smarty Converter wants elements sorted by type as well as alphabetically
* @see Converter::$sort_page_contents_by_type
* @var boolean
*/
var $sort_page_contents_by_type = true;
/** @var string */
var $outputformat = 'HTML';
/** @var string */
var $name = 'frames';
/**
* indexes of elements by package that need to be generated
* @var array
*/
var $leftindex = array('classes' => true, 'pages' => true, 'functions' => true, 'defines' => false, 'globals' => false);
/**
* output directory for the current procedural page being processed
* @var string
*/
var $page_dir;
/**
* target directory passed on the command-line.
* {@link $targetDir} is malleable, always adding package/ and package/subpackage/ subdirectories onto it.
* @var string
*/
var $base_dir;
/**
* output directory for the current class being processed
* @var string
*/
var $class_dir;
/**
* array of converted package page names.
* Used to link to the package page in the left index
* @var array Format: array(package => 1)
*/
var $package_pages = array();
/**
* controls formatting of parser informative output
*
* Converter prints:
* "Converting /path/to/file.php... Procedural Page Elements... Classes..."
* Since HTMLdefaultConverter outputs files while converting, it needs to send a \n to start a new line. However, if there
* is more than one class, output is messy, with multiple \n's just between class file output. This variable prevents that
* and is purely cosmetic
* @var boolean
*/
var $juststarted = false;
/**
* contains all of the template procedural page element loop data needed for the current template
* @var array
*/
var $current;
/**
* contains all of the template class element loop data needed for the current template
* @var array
*/
var $currentclass;
var $wrote = false;
var $ric_set = array();
/**
* sets {@link $base_dir} to $targetDir
* @see Converter()
*/
function HTMLframesConverter(&$allp, &$packp, &$classes, &$procpages, $po, $pp, $qm, $targetDir, $templateDir, $title)
{
Converter::Converter($allp, $packp, $classes, $procpages,$po, $pp, $qm, $targetDir, $templateDir, $title);
$this->base_dir = $targetDir;
}
/**
* @deprecated in favor of PHP 4.3.0+ tokenizer-based source highlighting
*/
function unmangle($sourcecode)
{
$sourcecode = str_replace('<code>','<pre>',$sourcecode);
$sourcecode = str_replace('</code>','</pre>',$sourcecode);
$sourcecode = str_replace('<br />',"\n",$sourcecode);
$sourcecode = str_replace(' ',' ',$sourcecode);
$sourcecode = str_replace('<','<',$sourcecode);
$sourcecode = str_replace('>','>',$sourcecode);
$sourcecode = str_replace('&','&',$sourcecode);
return $sourcecode;
}
/**
* @param string full path to the source file
* @param string fully highlighted source code
*/
function writeSource($path, $value)
{
$templ = &$this->newSmarty();
$pathinfo = $this->proceduralpages->getPathInfo($path, $this);
$templ->assign('source',$value);
$templ->assign('package',$pathinfo['package']);
$templ->assign('subpackage',$pathinfo['subpackage']);
$templ->assign('name',$pathinfo['name']);
$templ->assign('source_loc',$pathinfo['source_loc']);
$templ->assign('docs',$pathinfo['docs']);
$templ->assign("subdir",'../');
$templ->register_outputfilter('HTMLframes_outputfilter');
$this->setTargetDir($this->getFileSourcePath($this->base_dir));
phpDocumentor_out("\n");
$this->setSourcePaths($path);
$this->writefile($this->getFileSourceName($path).'.html',$templ->fetch('filesource.tpl'));
}
function writeExample($title, $path, $source)
{
$templ = &$this->newSmarty();
$templ->assign('source',$source);
if (empty($title))
{
$title = 'example';
addWarning(PDERROR_EMPTY_EXAMPLE_TITLE, $path, $title);
}
$templ->assign('title',$title);
$templ->assign('file',$path);
$templ->assign("subdir",'../');
$templ->register_outputfilter('HTMLframes_outputfilter');
$this->setTargetDir($this->base_dir . PATH_DELIMITER . '__examplesource');
phpDocumentor_out("\n");
$this->writefile('exsource_'.$path.'.html',$templ->fetch('examplesource.tpl'));
}
function getExampleLink($path, $title)
{
return $this->returnLink('../__examplesource' . PATH_DELIMITER . 'exsource_'.$path.'.html',$title);
}
function getSourceLink($path)
{
return $this->returnLink('../__filesource/' .
$this->getFileSourceName($path).'.html','Source Code for this file');
}
/**
* Retrieve a Converter-specific anchor to a segment of a source code file
* parsed via a {@tutorial tags.filesource.pkg} tag.
* @param string full path to source file
* @param string name of anchor
* @param string link text, if this is a link
* @param boolean returns either a link or a destination based on this
* parameter
* @return string link to an anchor, or the anchor
*/
function getSourceAnchor($sourcefile,$anchor,$text = '',$link = false)
{
if ($link) {
return $this->returnLink('../__filesource/' .
$this->getFileSourceName($sourcefile) . '.html#a' . $anchor, $text);
} else {
return '<a name="a'.$anchor.'"></a>';
}
}
/**
* Return a line of highlighted source code with formatted line number
*
* If the $path is a full path, then an anchor to the line number will be
* added as well
* @param integer line number
* @param string highlighted source code line
* @param false|stringfull path to @filesource file this line is a part of,
* if this is a single line from a complete file.
* @return string formatted source code line with line number
*/
function sourceLine($linenumber, $line, $path = false)
{
$extra = '';
if (strlen(str_replace("\n", '', $line)) == 0) {
$extra = ' ';
}
if ($path)
{
return '<li><div class="src-line">' . $this->getSourceAnchor($path, $linenumber) .
str_replace("\n",'',$line) . $extra .
"</div></li>\n";
} else
{
return '<li><div class="src-line">' . str_replace("\n",'',$line) .
"$extra</div></li>\n";
}
}
/**
* Used to convert the <<code>> tag in a docblock
* @param string
* @param boolean
* @return string
*/
function ProgramExample($example, $tutorial = false, $inlinesourceparse = null/*false*/,
$class = null/*false*/, $linenum = null/*false*/, $filesourcepath = null/*false*/)
{
return '<div class="src-code"><ol>' . parent::ProgramExample($example, $tutorial, $inlinesourceparse, $class, $linenum, $filesourcepath)
.'</ol></div>';
}
/**
* @param string
*/
function TutorialExample($example)
{
$trans = $this->template_options['desctranslate'];
$this->template_options['desctranslate'] = array();
$example = '<ol>' . parent::TutorialExample($example)
.'</ol>';
$this->template_options['desctranslate'] = $trans;
if (!isset($this->template_options['desctranslate'])) return $example;
if (!isset($this->template_options['desctranslate']['code'])) return $example;
$example = $this->template_options['desctranslate']['code'] . $example;
if (!isset($this->template_options['desctranslate']['/code'])) return $example;
return $example . $this->template_options['desctranslate']['/code'];
}
function getCurrentPageLink()
{
return $this->curname . '.html';
}
/**
* Uses htmlspecialchars() on the input
*/
function postProcess($text)
{
if ($this->highlightingSource) {
return str_replace(array(' ',"\t"), array(' ', '   '),
htmlspecialchars($text));
}
return htmlspecialchars($text);
}
/**
* Use the template tutorial_toc.tpl to generate a table of contents for HTML
* @return string table of contents formatted for use in the current output format
* @param array format: array(array('tagname' => section, 'link' => returnsee link, 'id' => anchor name, 'title' => from title tag),...)
*/
function formatTutorialTOC($toc)
{
$template = &$this->newSmarty();
$template->assign('toc',$toc);
return $template->fetch('tutorial_toc.tpl');
}
function &SmartyInit(&$templ)
{
if (!isset($this->package_index))
foreach($this->all_packages as $key => $val)
{
if (isset($this->pkg_elements[$key]))
{
if (!isset($start)) $start = $key;
$this->package_index[] = array('link' => "li_$key.html", 'title' => $key);
}
}
$templ->assign("packageindex",$this->package_index);
$templ->assign("subdir",'');
return $templ;
}
/**
* Writes out the template file of {@link $class_data} and unsets the template to save memory
* @see registerCurrentClass()
* @see parent::endClass()
*/
function endClass()
{
$a = '../';
if (!empty($this->subpackage)) $a .= '../';
if ($this->juststarted)
{
$this->juststarted = false;
phpDocumentor_out("\n");
flush();
}
$this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->class_dir);
$this->class_data->assign("subdir",$a);
$this->class_data->register_outputfilter('HTMLframes_outputfilter');
$this->writefile($this->class . '.html',$this->class_data->fetch('class.tpl'));
unset($this->class_data);
}
/**
* Writes out the template file of {@link $page_data} and unsets the template to save memory
* @see registerCurrent()
* @see parent::endPage()
*/
function endPage()
{
$this->package = $this->curpage->package;
$this->subpackage = $this->curpage->subpackage;
$a = '../';
if (!empty($this->subpackage)) $a .= '../';
$this->setTargetDir($this->base_dir . PATH_DELIMITER . $this->page_dir);
$this->page_data->assign("package",$this->package);
$this->page_data->assign("subdir",$a);
$this->page_data->register_outputfilter('HTMLframes_outputfilter');
$this->writefile($this->page . '.html',$this->page_data->fetch('page.tpl'));
unset($this->page_data);
}
/**
* @param string
* @param string
* @return string <a href="'.$link.'">'.$text.'</a>
*/
function returnLink($link,$text)
{
return '<a href="'.$link.'">'.$text.'</a>';
}
function makeLeft()
{
foreach($this->page_elements as $package => $o1)
{
foreach($o1 as $subpackage => $links)
{
for($i=0;$i<count($links);$i++)
{
$left[$package][$subpackage]['files'][] =
array("link" => $this->getId($links[$i]), "title" => $links[$i]->name);
}
}
}
$interfaces = $classes = false;
foreach($this->class_elements as $package => $o1)
{
foreach($o1 as $subpackage => $links)
{
for($i=0;$i<count($links);$i++)
{
$class = $this->classes->getClassByPackage($links[$i]->name, $links[$i]->package);
$isinterface = $isclass = false;
if ($class->isInterface()) {
$isinterface = true;
$interfaces = true;
} else {
$isclass = true;
$classes = true;
}
if ($class && isset($class->docblock) && $class->docblock->hasaccess) {
$left[$package][$subpackage]['classes'][] =
array("link" => $this->getId($links[$i]),
"title" => $links[$i]->name,
'is_interface' => $isinterface,
'is_class' => $isclass,
"access" => $class->docblock->tags['access'][0]->value,
"abstract" => isset ($class->docblock->tags['abstract'][0]));
} else {
$left[$package][$subpackage]['classes'][] =
array("link" => $this->getId($links[$i]),
"title" => $links[$i]->name,
'is_interface' => $isinterface,
'is_class' => $isclass,
"access" => 'public',
"abstract" => isset ($class->docblock->tags['abstract'][0]));
}
}
}
}
foreach($this->function_elements as $package => $o1)
{
foreach($o1 as $subpackage => $links)
{
for($i=0;$i<count($links);$i++)
{
$left[$package][$subpackage]['functions'][] =
array("link" => $this->getId($links[$i]), "title" => $links[$i]->name);
}
}
}
$ret = array();
foreach($left as $package => $r)
{
$pd = 'blank';
if (isset($this->package_pages[$package])) $pd = $package.'/package_'.$package.'.html';
if (!isset($r['']))
{
$pt = false;
$ptnoa = false;
&n