';
}
return $this->createToc(
$attrs[Reader::XMLNS_PHD]['element'],
'phd-toc',
$props,
isset($attrs[Reader::XMLNS_PHD]['toc-depth'])
? (int)$attrs[Reader::XMLNS_PHD]['toc-depth'] : 1,
false
) . "
\n";
}
public function createLink($for, &$desc = null, $type = Format::SDESC) {
$retval = null;
if (isset($this->indexes[$for])) {
$rsl = $this->indexes[$for];
$retval = $rsl["filename"] . $this->ext;
if ($rsl["filename"] != $rsl["docbook_id"]) {
$retval .= '#' . $rsl["docbook_id"];
}
$desc = $rsl["sdesc"] ?: $rsl["ldesc"];
}
return $retval;
}
protected function createCSSLinks() {
$cssLinks = '';
foreach ((array)$this->stylesheets as $css) {
if ($this->isChunked()) {
$cssLinks .= "\n";
} else {
$cssLinks .= "\n";
}
}
return $cssLinks;
}
protected function fetchStylesheet($name = null) {
if (!$this->isChunked()) {
foreach ((array)Config::css() as $css) {
if ($style = file_get_contents($css)) {
$this->stylesheets[] = $style;
} else {
v("Stylesheet %s not fetched.", $css, E_USER_WARNING);
}
}
return;
}
$stylesDir = $this->getOutputDir();
if (!$stylesDir) {
$stylesDir = Config::output_dir();
}
$stylesDir .= 'styles/';
if (file_exists($stylesDir)) {
if (!is_dir($stylesDir)) {
v("The styles/ directory is a file?", E_USER_ERROR);
}
} else {
if (!mkdir($stylesDir, 0777, true)) {
v("Can't create the styles/ directory.", E_USER_ERROR);
}
}
foreach ((array)Config::css() as $css) {
$basename = basename($css);
$dest = md5(substr($css, 0, -strlen($basename))) . '-' . $basename;
if (@copy($css, $stylesDir . $dest)) {
$this->stylesheets[] = $dest;
} else {
v('Impossible to copy the %s file.', $css, E_USER_WARNING);
}
}
}
/* Functions format_* */
public function format_suppressed_tags($open, $name, $attrs, $props) {
/* Ignore it */
return "";
}
public function format_suppressed_text($value, $tag) {
/* Suppress any content */
return "";
}
public function format_link($open, $name, $attrs, $props) {
$link = null;
if ($open) {
$link = $class = $content = "";
if (isset($attrs[Reader::XMLNS_DOCBOOK]["linkend"])) {
$link = $this->createLink($attrs[Reader::XMLNS_DOCBOOK]["linkend"]);
}
elseif (isset($attrs[Reader::XMLNS_XLINK]["href"])) {
$link = $attrs[Reader::XMLNS_XLINK]["href"];
$class = " external";
$content = "» ";
}
if ($props["empty"]) {
$content .= $link ."";
}
return '' . $content;
}
return "";
}
public function format_xref($open, $name, $attrs, $props) {
if ($open) {
$desc = "";
$link = $this->createLink($attrs[Reader::XMLNS_DOCBOOK]["linkend"], $desc);
$ret = '' .$desc;
if ($props["empty"]) {
return $ret. "";
}
return $ret;
}
return "";
}
public function format_option($open, $name, $attrs) {
if ($open) {
if(!isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
$attrs[Reader::XMLNS_DOCBOOK]["role"] = "unknown";
}
$this->role = $role = $attrs[Reader::XMLNS_DOCBOOK]["role"];
return '';
}
$this->role = null;
return "";
}
public function format_literal($open, $name, $attrs)
{
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
$this->role = $attrs[Reader::XMLNS_DOCBOOK]["role"];
} else {
$this->role = false;
}
return '';
}
$this->role = false;
return '';
}
public function format_literal_text($value, $tag) {
switch ($this->role) {
case 'infdec':
$value = (float)$value;
$p = strpos($value, '.');
$str = substr($value, 0, $p + 1);
$str .= '';
$str .= substr($value, $p + 1);
$str .= '';
return $str;
default:
return $this->TEXT($value);
}
}
public function format_copyright($open, $name, $attrs) {
if ($open) {
return '© ';
}
return '
';
}
public function format_author($open, $name, $attrs, $props) {
if ($open) {
return '';
}
return "
";
}
public function format_personname($open, $name, $attrs, $props) {
if ($open) {
return '';
}
return "";
}
public function format_name($open, $name, $attrs) {
if ($open) {
$class = "";
switch($name) {
case "firstname":
$class = " given-name";
break;
case "surname":
$class = " family-name";
break;
case "othername":
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
/* We might want to add support for other roles */
switch($attrs[Reader::XMLNS_DOCBOOK]["role"]) {
case "nickname":
$class = " nickname";
break;
}
}
break;
}
return ' ';
}
return ' ';
}
public function format_container_chunk_top($open, $name, $attrs, $props) {
$this->cchunk = $this->dchunk;
$this->cchunk["name"] = $name;
if(isset($attrs[Reader::XMLNS_XML]["id"])) {
$id = $attrs[Reader::XMLNS_XML]["id"];
} else {
$id = uniqid("phd");
}
if ($open) {
$this->CURRENT_CHUNK = $id;
$this->notify(Render::CHUNK, Render::OPEN);
return '';
}
$this->CURRENT_CHUNK = $id;
$this->notify(Render::CHUNK, Render::CLOSE);
$toc = "";
if (!in_array($id, $this->TOC_WRITTEN ?? [])) {
$toc = $this->createTOC($id, $name, $props);
}
return $toc."
";
}
public function format_container_chunk_top_title($open, $name, $attrs, $props) {
if ($open) {
return ''; } $id = $this->CURRENT_CHUNK; $toc = $this->createTOC($id, $name, $props, 2); $this->TOC_WRITTEN[] = $id; return '
'.$toc; } public function format_container_chunk_below($open, $name, $attrs, $props) { $this->cchunk = $this->dchunk; $this->cchunk["name"] = $name; if(isset($attrs[Reader::XMLNS_XML]["id"])) { $id = $attrs[Reader::XMLNS_XML]["id"]; } else { /* FIXME: This will obviously not exist in the db.. */ $id = uniqid("phd"); } if ($open) { $this->CURRENT_CHUNK = $id; $this->notify(Render::CHUNK, Render::OPEN); return '';
}
$toc = '
';
}
public function format_exception_chunk($open, $name, $attrs, $props) {
return $this->format_container_chunk_below($open, "reference", $attrs, $props);
}
public function format_section_chunk($open, $name, $attrs, $props) {
if ($open) {
if (!isset($attrs[Reader::XMLNS_XML]["id"])) {
$this->isSectionChunk[] = false;
return $this->transformFromMap($open, "div", $name, $attrs, $props);
}
$this->isSectionChunk[] = true;
return $this->format_chunk($open, $name, $attrs, $props);
}
if (array_pop($this->isSectionChunk)) {
return $this->format_chunk($open, $name, $attrs, $props);
}
return $this->transformFromMap($open, "div", $name, $attrs, $props);
}
public function format_chunk($open, $name, $attrs, $props) {
if ($open) {
$this->cchunk = $this->dchunk;
if(isset($attrs[Reader::XMLNS_XML]["id"])) {
$id = $attrs[Reader::XMLNS_XML]["id"];
} else {
$id = uniqid("phd");
}
$class = $name;
if ($name === "refentry") {
//$class .= " -rel-posting";
}
$this->CURRENT_CHUNK = $id;
$this->CURRENT_LANG = $props["lang"];
$this->notify(Render::CHUNK, Render::OPEN);
return '- ';
$desc = "";
if (!in_array($id, $this->TOC_WRITTEN ?? [])) {
$toc = $this->createTOC($id, $name, $props);
}
$toc .= "
';
}
$this->notify(Render::CHUNK, Render::CLOSE);
$str = "";
foreach ($this->cchunk["footnote"] as $k => $note) {
$str .= '
";
}
public function format_refsect1_para($open, $name, $attrs, $props) {
if ($open) {
switch ($props["sibling"]) {
case "methodsynopsis":
case "constructorsynopsis":
case "destructorsynopsis":
return '';
$str .= '[' .($k + 1). ']';
$str .= $note["str"];
$str .= "
\n";
}
$this->cchunk = $this->dchunk;
return $str. "'; break; default: return '
'; } } return '
'; } public function format_refsect($open, $name, $attrs) { static $role = 0; if ($open) { if(!isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) { $attrs[Reader::XMLNS_DOCBOOK]["role"] = "unknown-" . ++$role; } $this->role = $role = $attrs[Reader::XMLNS_DOCBOOK]["role"]; if (isset($attrs[Reader::XMLNS_XML]["id"])) { $id = $attrs[Reader::XMLNS_XML]["id"]; } else { $id = $name. "-" . $this->CURRENT_CHUNK . "-" . $role; } return '';
}
$this->role = null;
return "
\n";
}
/** Legacy rendering functions for class synopsis tags that wraps the definition in a class synopsis info tag */
public function format_classsynopsisinfo_oointerface($open, $name, $attrs) {
if ($open) {
if ($this->cchunk["classsynopsisinfo"]["ooclass"] === false) {
return '';
}
if ($this->cchunk["classsynopsisinfo"]["implements"] === false) {
$this->cchunk["classsynopsisinfo"]["implements"] = true;
if ($this->cchunk["classsynopsis"]["interface"]) {
return 'extends ';
}
return 'implements ';
}
return ', ';
}
return "";
}
public function format_classsynopsisinfo_ooclass_classname($open, $name, $attrs)
{
if ($open) {
if ($this->cchunk["classsynopsisinfo"]["ooclass"] === false) {
$this->cchunk["classsynopsisinfo"]["ooclass"] = true;
if ($this->cchunk["classsynopsis"]["interface"]) {
return 'interface ';
}
return 'class ';
}
return ' ';
}
if ($this->cchunk["classsynopsisinfo"]["ooclass"] === true) {
$this->cchunk["classsynopsisinfo"]["ooclass"] = null;
}
return "";
}
public function format_classsynopsisinfo_oointerface_interfacename($open, $name, $attrs)
{
if ($open) {
if ($this->cchunk["classsynopsisinfo"]["ooclass"] === false) {
$this->cchunk["classsynopsisinfo"]["ooclass"] = true;
return 'interface ';
}
return ' ';
}
if ($this->cchunk["classsynopsisinfo"]["ooclass"] === true) {
$this->cchunk["classsynopsisinfo"]["ooclass"] = null;
}
return "";
}
public function format_classsynopsisinfo($open, $name, $attrs)
{
$this->cchunk["classsynopsisinfo"] = $this->dchunk["classsynopsisinfo"];
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"]) && $attrs[Reader::XMLNS_DOCBOOK]["role"] == "comment") {
return '/* ';
}
return '
';
}
/** This method is common between both legacy and new rendering for setting up the classname in the current chunk */
public function format_classsynopsis_ooclass_classname_text($value, $tag) {
/** If this is not defined this is the first ooclass/oointerface/ooexception and thus needs to
* set the class name to be able to remove it from the methods
*/
if (!$this->cchunk["classsynopsis"]["classname"]) {
$this->cchunk["classsynopsis"]["classname"] = $value;
}
// Do not render outside ooclass class name in legacy rendering.
if ($this->cchunk["classsynopsis"]["legacy"]) {
return '';
}
return $this->TEXT($value);
}
/** Class synopsis rendering for new/better markup */
public function format_classsynopsis_oo_name_text($value, $tag) {
/** If this is not defined this is the first ooclass/oointerface/ooexception and thus needs to
* set the class name to be able to remove it from the methods
*/
if (!$this->cchunk["classsynopsis"]["classname"]) {
$this->cchunk["classsynopsis"]["classname"] = $value;
}
return $this->TEXT($value);
}
public function format_classsynopsis_oointerface_interfacename($open, $name, $attrs, $props)
{
if ($this->cchunk["classsynopsis"]["legacy"] === true) {
return $this->transformFromMap($open, 'strong', $name, $attrs, $props);
}
if ($open) {
/* If there has been a class prior this means that we are the first implementing interface
* thus mark the oointerface as already been rendered as the primary tag */
if ($this->cchunk["classsynopsis"]["ooclass"] === true) {
$this->cchunk["classsynopsis"]["oointerface"] = true;
}
/** Actual interface name in bold */
if ($this->cchunk["classsynopsis"]["oointerface"] === false) {
return 'interface ' . $this->transformFromMap($open, 'strong', $name, $attrs, $props);
}
/* Whitespace for next word */
return ' ';
}
/** Actual interface name in bold */
if ($this->cchunk["classsynopsis"]["oointerface"] === false) {
$this->cchunk["classsynopsis"]["oointerface"] = true;
return '';
}
/** We don't wrap extended interface in a tag */
if ($this->cchunk["classsynopsis"]['nb_list'] > 1) {
return ',';
}
return '';
}
public function format_classsynopsis_ooclass_classname($open, $name, $attrs, $props)
{
if ($this->cchunk["classsynopsis"]["legacy"] === true) {
return $this->transformFromMap($open, 'strong', $name, $attrs, $props);
}
if ($open) {
/** Actual class name in bold */
if ($this->cchunk["classsynopsis"]["ooclass"] === false) {
/** We force the name: parameter to 'classname' to not break CSS expectations for exceptionanme tags */
return 'class ' . $this->transformFromMap($open, 'strong', 'classname', $attrs, $props);
}
/* Whitespace for next word */
return ' ';
}
/** Actual class name in bold */
if ($this->cchunk["classsynopsis"]["ooclass"] === false) {
$this->cchunk["classsynopsis"]["ooclass"] = true;
return '';
}
/** We don't wrap extended class in a tag */
return '';
}
public function format_classsynopsis_generic_oo_tag($open, $name, $attrs, $props)
{
if ($this->cchunk["classsynopsis"]["legacy"] === true) {
return $this->transformFromMap($open, 'span', $name, $attrs, $props);
}
/* Close list of classes + interfaces by "opening" class def with { */
if (!$open) {
if (--$this->cchunk["classsynopsis"]['nb_list'] === 0) {
return ' {';
}
}
return '';
}
public function format_classsynopsis($open, $name, $attrs, $props) {
$this->cchunk["classsynopsis"] = $this->dchunk["classsynopsis"];
/** Legacy presentation does not use the class attribute */
$this->cchunk["classsynopsis"]['legacy'] = !isset($attrs[Reader::XMLNS_DOCBOOK]["class"]);
if ($this->cchunk["classsynopsis"]['legacy']) {
if ($open) {
// Think this just needs to be set on open and it will persist
// Will remove comment after review
if (
isset($attrs[Reader::XMLNS_DOCBOOK]["class"]) &&
$attrs[Reader::XMLNS_DOCBOOK]["class"] == "interface"
) {
$this->cchunk["classsynopsis"]["interface"] = true;
}
return '';
}
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"]) && $attrs[Reader::XMLNS_DOCBOOK]["role"] == "comment") {
return ' */
';
}
assert($this->cchunk["classsynopsis"]["legacy"] === true);
$this->cchunk["classsynopsis"]["close"] = true;
return ' {';
}
/* Just always force the ending } to close the class as an opening { should always be present
if ($this->cchunk["classsynopsis"]["close"] === true) {
$this->cchunk["classsynopsis"]["close"] = false;
return "}
";
}
return "";
*/
return "}";
}
/* New rendering for more sensible markup:
* We open a fake classsynopsisinfo div to not break the CSS expectations */
if ($open) {
$occurrences = substr_count($props['innerXml'], '')
+ substr_count($props['innerXml'], '')
+ substr_count($props['innerXml'], '');
$this->cchunk["classsynopsis"]['nb_list'] = $occurrences;
return '';
} else {
return '}
';
}
}
public function format_classsynopsis_methodsynopsis_methodname_text($value, $tag) {
$value = $this->TEXT($value);
if ($this->cchunk["classsynopsis"]["classname"] === false) {
return $value;
}
if (strpos($value, '::')) {
$explode = '::';
} elseif (strpos($value, '->')) {
$explode = '->';
} elseif (strpos($value, '->')) {
$explode = '->';
} else {
return $value;
}
list($class, $method) = explode($explode, $value);
if ($class !== $this->cchunk["classsynopsis"]["classname"]) {
return $value;
}
return $method;
}
public function format_emphasis($open, $name, $attrs)
{
$name = "em";
if (isset($attrs[Reader::XMLNS_DOCBOOK]['role'])) {
$role = $attrs[Reader::XMLNS_DOCBOOK]['role'];
if ( $role == "strong" || $role == "bold" ) {
$name = "strong";
}
}
if ($open) {
return "<{$name}>";
} else {
return "";
}
}
public function format_fieldsynopsis($open, $name, $attrs) {
$this->cchunk["fieldsynopsis"] = $this->dchunk["fieldsynopsis"];
if ($open) {
return '';
}
return ";
\n";
}
public function format_fieldsynopsis_modifier_text($value, $tag) {
$this->cchunk["fieldsynopsis"]["modifier"] = trim($value);
return $this->TEXT($value);
}
public function format_methodsynopsis($open, $name, $attrs, $props) {
if ($open) {
$this->params = array(
"count" => 0,
"opt" => false,
"init" => false,
"content" => "",
"ellipsis" => '',
"paramCount" => substr_count($props["innerXml"], ""; } $content .= ")"; $content .= "
&' . $this->params["ellipsis"] . '$';
}
return ' ' . $this->params["ellipsis"] . '$';
}
return "";
}
public function format_initializer($open, $name, $attrs) {
if ($open) {
$this->params["init"] = true;
return ' = ';
}
return '';
}
public function format_parameter($open, $name, $attrs, $props)
{
if ($props["empty"]) {
return '';
}
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
return '&';
}
return '';
}
return "";
}
public function format_void($open, $name, $attrs, $props) {
if ($props['sibling'] == 'methodname') {
return '(';
} else {
return 'void';
}
}
public function format_methodparam($open, $name, $attrs) {
if ($open) {
$content = '';
if ($this->params["count"] === 0) {
$content .= "(";
if ($this->params["paramCount"] > 3) {
$content .= "
";
}
}
if (isset($attrs[Reader::XMLNS_DOCBOOK]["choice"]) && $attrs[Reader::XMLNS_DOCBOOK]["choice"] == "opt") {
$this->params["opt"] = true;
} else {
$this->params["opt"] = false;
}
if ($this->params["count"]) {
$content .= ",";
if ($this->params["paramCount"] > 3) {
$content .= "
";
} else {
$content .= " ";
}
}
$content .= '';
++$this->params["count"];
if (isset($attrs[Reader::XMLNS_DOCBOOK]["rep"]) && $attrs[Reader::XMLNS_DOCBOOK]["rep"] == "repeat") {
$this->params["ellipsis"] = '...';
} else {
$this->params["ellipsis"] = '';
}
return $content;
}
if ($this->params["opt"] && !$this->params["init"]) {
return ' = ?';
}
$this->params["init"] = false;
return "";
}
public function format_methodname($open, $name, $attr) {
if ($open) {
return ' ';
}
return '';
}
public function format_varname($open, $name, $attrs) {
if ($open) {
return '$';
}
return "";
}
public function format_fieldsynopsis_varname($open, $name, $attrs) {
if ($open) {
if ($this->cchunk["fieldsynopsis"]["modifier"] === "const") {
return '';
}
return '$';
}
return '';
}
public function format_footnoteref($open, $name, $attrs, $props) {
if ($open) {
$linkend = $attrs[Reader::XMLNS_DOCBOOK]["linkend"];
$found = false;
foreach($this->cchunk["footnote"] as $k => $note) {
if ($note["id"] === $linkend) {
return '[' .($k + 1). ']';
}
}
trigger_error("footnoteref ID '$linkend' not found", E_USER_WARNING);
return "";
}
}
public function format_footnote($open, $name, $attrs, $props) {
if ($open) {
$count = count($this->cchunk["footnote"]);
$noteid = isset($attrs[Reader::XMLNS_XML]["id"]) ? $attrs[Reader::XMLNS_XML]["id"] : $count + 1;
$note = array("id" => $noteid, "str" => "");
$this->cchunk["footnote"][$count] = $note;
if ($this->cchunk["table"]) {
$this->cchunk["tablefootnotes"][$count] = $noteid;
}
return '[' .($count + 1). ']';
}
return "";
}
/* {{{ FIXME: These are crazy workarounds :( */
public function format_footnote_constant($open, $name, $attrs, $props) {
$k = count($this->cchunk["footnote"]) - 1;
$this->cchunk["footnote"][$k]["str"] .= self::format_constant($open, $name, $attrs, $props);
return "";
}
public function format_footnote_constant_text($value, $tag) {
$k = count($this->cchunk["footnote"]) - 1;
$this->cchunk["footnote"][$k]["str"] .= $value;
return "";
}
public function format_footnote_para($open, $name, $attrs, $props) {
$k = count($this->cchunk["footnote"]) - 1;
if ($open) {
$this->cchunk["footnote"][$k]["str"] .= '';
return "";
}
$this->cchunk["footnote"][$k]["str"] .= "";
return "";
}
public function format_footnote_para_text($value, $tag) {
$k = count($this->cchunk["footnote"]) - 1;
$this->cchunk["footnote"][$k]["str"] .= $value;
return "";
}
/* }}} */
public function format_co($open, $name, $attrs, $props) {
if (($open || $props["empty"]) && isset($attrs[Reader::XMLNS_XML]["id"])) {
$co = ++$this->cchunk["co"];
return '' .str_repeat("*", $co) .'';
}
/* Suppress closing tag if any */
return "";
}
public function format_calloutlist($open, $name, $attrs) {
if ($open) {
$this->cchunk["callouts"] = 0;
return '';
}
return '
';
}
public function format_step($open, $name, $attrs) {
if ($open) {
$ret = "";
if ($this->cchunk["procedure"] === false) {
$this->cchunk["procedure"] = true;
$ret = '- ';
}
return $ret . "
- "; } return ' '; } public function format_variablelist($open, $name, $attrs, $props) { if ($open) { if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) { $this->role = $attrs[Reader::XMLNS_DOCBOOK]["role"]; } $classStr = $headerStr = $idStr = ''; if (isset($attrs[Reader::XMLNS_XML]["id"])) { $idStr = ' id="' . $attrs[Reader::XMLNS_XML]["id"] . '"'; } if ($this->role === 'constant_list') { $tagName = 'table'; $classStr = ' class="doctable table"'; $headerStr = "\n
- '.htmlentities($node->textContent, ENT_QUOTES, "UTF-8").' '; } $retval .= "
- '; } return ' '; } public function format_phd_question($open, $name, $attrs, $props) { if ($open) { $href = $this->createLink($attrs[Reader::XMLNS_XML]["id"]); return '
- '; } return ' '; } public function format_citation($open, $name, $attrs, $props) { if ($open) { return '['; } return ']'; } public function format_email_text($value) { return '<' . $value . '>'; } public function format_bold_paragraph($open, $name, $attrs, $props) { if ($props["empty"]) { return ""; } if ($open) { return "
'; } return ''; } return ""; } public function format_trademark($open, $name, $attrs, $props) { if ($open) { return ''; } return '®'; } public function format_userinput($open, $name, $attrs) { if ($open) { return '
';
}
return "";
}
public function format_systemitem($open, $name, $attrs) {
if ($open) {
$val = isset($attrs[Reader::XMLNS_DOCBOOK]["role"]) ? $attrs[Reader::XMLNS_DOCBOOK]["role"] : null;
switch($val) {
case "directive":
/* FIXME: Different roles should probably be handled differently */
default:
return '';
}
}
return "";
}
public function format_example_content($open, $name, $attrs) {
if ($open) {
return ''; } return "
';
}
$this->role = false;
return "
\n";
}
public function format_programlisting_text($value, $tag) {
return $this->CDATA($value);
}
public function format_screen($open, $name, $attrs) {
if ($open) {
return '';
}
return '
';
}
public function format_constant($open, $name, $attrs)
{
if ($open) {
return "";
}
return "";
}
public function admonition_title($title, $lang)
{
return '' .($this->autogen($title, $lang)). '';
}
public function format_admonition($open, $name, $attrs, $props) {
if ($open) {
return '' .$this->admonition_title($name, $props["lang"]);
}
return "
";
}
public function format_authorgroup_author($open, $name, $attrs, $props) {
if ($open) {
if ($props["sibling"] !== $name) {
return '' .$this->admonition_title("by", $props["lang"]). ':
'; } return '
'; } public function format_example($open, $name, $attrs, $props) { static $n = 0; if ($open) { ++$n; if (isset($props["id"])) { return '
'; } return '
';
}
return "
\n";
}
public function format_editor($open, $name, $attrs, $props) {
if ($open) {
return '' .$this->admonition_title("editedby", $props["lang"]). ': ';
}
return "
\n";
}
public function format_note($open, $name, $attrs, $props) {
if ($open) {
return '"; } public function format_note_title($open, $name, $attrs) { if ($open) { return ''; } return ''.$this->admonition_title("note", $props["lang"]). ': '; } return "
'; } public function format_example($open, $name, $attrs, $props) { static $n = 0; if ($open) { ++$n; if (isset($props["id"])) { return '
';
}
return '";
}
return " ";
}
public function format_variablelist_title($open, $name, $attrs, $props) {
if ($open) {
return ($this->role === 'constant_list') ? "" : "";
}
return ($this->role === 'constant_list') ? " " : "";
}
public function format_mediaobject($open, $name, $attrs) {
$this->cchunk["mediaobject"] = $this->dchunk["mediaobject"];
if ($open) {
return '
';
} else {
return '';
}
}
public function format_table($open, $name, $attrs, $props) {
if ($open) {
$this->cchunk["table"] = true;
// Initialize an empty tgroup in case we never process such element
Format::tgroup(array());
$idstr = '';
if (isset($attrs[Reader::XMLNS_XML]["id"])) {
$idstr = ' id="' . $attrs[Reader::XMLNS_XML]["id"] . '"';
}
return '';
}
$this->cchunk["table"] = false;
$str = "";
if (isset($this->cchunk["tablefootnotes"]) && $this->cchunk["tablefootnotes"]) {
$opts = array(Reader::XMLNS_DOCBOOK => array());
$str = $this->format_tbody(true, "footnote", $opts, $props);
$str .= $this->format_row(true, "footnote", $opts, $props);
$str .= $this->format_entry(true, "footnote", $opts, $props+array("colspan" => $this->getColCount()));
foreach ($this->cchunk["tablefootnotes"] as $k => $noteid) {
$str .= '';
} else {
return '';
}
}
return "\n";
}
public function format_th_entry($open, $name, $attrs, $props) {
if ($props["empty"]) {
return ' ';
}
if ($open) {
$colspan = Format::colspan($attrs[Reader::XMLNS_DOCBOOK]);
if ($colspan == 1) {
return '';
} else {
return ' ';
}
}
return ' ';
}
public function format_entry($open, $name, $attrs, $props) {
if ($props["empty"]) {
return ' ';
}
if ($open) {
$dbattrs = (array)Format::getColspec($attrs[Reader::XMLNS_DOCBOOK]);
$retval = "";
if (isset($dbattrs["colname"])) {
for($i=Format::getEntryOffset($dbattrs); $i>0; --$i) {
$retval .= ' ';
}
}
/*
* "colspan" is *not* an standard prop, only used to overwrite the
* colspan for s in tables
*/
if (isset($props["colspan"])) {
$colspan = $props["colspan"];
} else {
$colspan = Format::colspan($dbattrs);
}
$rowspan = Format::rowspan($dbattrs);
$moreattrs = self::parse_table_entry_attributes($dbattrs);
$sColspan = $colspan == 1 ? '' : ' colspan="' .((int)$colspan) . '"';
$sRowspan = $rowspan == 1 ? '' : ' rowspan="' .((int)$rowspan). '"';
return $retval. '';
}
return "";
}
public function format_qandaset($open, $name, $attrs, $props) {
if ($open) {
$node = ReaderKeeper::getReader()->expand();
$doc = new \DOMDocument;
$doc->appendChild($node);
$xp = new \DOMXPath($doc);
$xp->registerNamespace("db", Reader::XMLNS_DOCBOOK);
$questions = $xp->query("//db:qandaentry/db:question");
$retval = '";
return $retval;
}
}
public function format_question($open, $name, $attrs, $props) {
if ($open) {
return ' tag.
*
* @return string HTML code
*/
public function format_tag($open, $name, $attrs, $props) {
static $arFixes = array(
'attribute' => array('', ''),
'attvalue' => array('"', '"'),
'comment' => array('<!--', '-->'),
'element' => array('', ''),
'emptytag' => array('<', '/>'),
'endtag' => array('</', '>'),
'genentity' => array('&', ';'),
'localname' => array('', ''),
'namespace' => array('', ''),
'numcharref' => array('&#', ';'),
'paramentity' => array('%', ';'),
'pi' => array('<?', '?>'),
'prefix' => array('', ''),
'starttag' => array('<', '>'),
'xmlpi' => array('<?', '?>'),
);
if ($props['empty']) {
return '';
}
$class = 'starttag';
if (isset($attrs['class'])) {
$class = $attrs['class'];
}
if (!isset($arFixes[$class])) {
trigger_error('Unknown tag class "' . $class . '"', E_USER_WARNING);
$class = 'starttag';
}
if (!$open) {
return $arFixes[$class][1] . '';
}
return '
';
}
return '
';
}
public function format_example_title($open, $name, $attrs, $props)
{
if ($props["empty"]) {
return "";
}
if ($open) {
return "" . ($this->autogen('example', $props['lang']) . (isset($this->cchunk["examples"]) ? ++$this->cchunk["examples"] : "")) . " "; } return "
"; } public function format_table_title($open, $name, $attrs, $props) { if ($props["empty"]) { return ""; } if ($open) { return "';
}
return '
';
}
public function format_alt_text($value, $tag) {
$this->cchunk["mediaobject"]["alt"] = $value;
}
public function format_imagedata($open, $name, $attrs) {
$file = $attrs[Reader::XMLNS_DOCBOOK]["fileref"];
if ($newpath = $this->mediamanager->handleFile($file)) {
$curfile = $this->mediamanager->findFile($file);
$width = isset($attrs[Reader::XMLNS_DOCBOOK]["width"]) ? 'width="' . $attrs[Reader::XMLNS_DOCBOOK]["width"] . '"' : '';
$height = isset($attrs[Reader::XMLNS_DOCBOOK]["depth"]) ? 'height="' . $attrs[Reader::XMLNS_DOCBOOK]["depth"] . '"' : '';
$alt = 'alt="' . ($this->cchunk["mediaobject"]["alt"] !== false ? $this->cchunk["mediaobject"]["alt"] : basename($file)) . '"';
// Generate height and width when none are supplied.
if ($curfile && '' === $width . $height) {
list(,,,$dimensions,,,,) = getimagesize($curfile);
} else {
$dimensions = $width . ' ' . $height;
}
// Generate warnings when only 1 dimension supplied or alt is not supplied.
if (!$width xor !$height) {
v('Missing %s attribute for %s', (!$width ? 'width' : 'height'), $file, VERBOSE_MISSING_ATTRIBUTES);
}
if (false === $this->cchunk["mediaobject"]["alt"]) {
v('Missing alt attribute for %s', $file, VERBOSE_MISSING_ATTRIBUTES);
}
return '';
$str .= '[' .($k + 1). ']' .$this->cchunk["footnote"][$k]["str"];
unset($this->cchunk["footnote"][$k]);
$str .= "
\n";
}
$str .= $this->format_entry(false, "footnote", $opts, $props);
$str .= $this->format_row(false, "footnote", $opts, $props);
$str .= $this->format_tbody(false, "footnote", $opts, $props);
$this->cchunk["tablefootnotes"] = $this->dchunk["tablefootnotes"];
}
return "$str\n";
}
public function format_tgroup($open, $name, $attrs) {
if ($open) {
Format::tgroup($attrs[Reader::XMLNS_DOCBOOK]);
return '';
}
return '';
}
private static function parse_table_entry_attributes($attrs)
{
$style = array();
$retval = '';
if (!empty($attrs['align'])) {
if ('char' != $attrs['align']) {
$style[] = 'text-align: ' . $attrs['align'];
} elseif (isset($attrs['char'])) {
// There's no analogue in CSS, but as this stuff isn't supported
// in any browser, it is unlikely to appear in DocBook anyway
$retval .= ' align="char" char="'
. htmlspecialchars($attrs["char"], ENT_QUOTES) . '"';
if (isset($attrs['charoff'])) {
$retval .= ' charoff="'
. htmlspecialchars($attrs["charoff"], ENT_QUOTES) . '"';
}
}
}
if (isset($attrs["valign"])) {
$style[] = 'vertical-align: ' . $attrs["valign"];
}
if (isset($attrs["colwidth"])) {
if (preg_match('/^\\d+\\*$/', $attrs['colwidth'])) {
// relative_length measure has no analogue in CSS and is
// unsupported in browsers, leave as is
$retval .= ' width="' . $attrs['colwidth'] . '"';
} else {
// probably fixed width, use inline styles
$style[] = 'width: ' . $attrs['colwidth'];
}
}
return $retval . (empty($style) ? '' : ' style="' . implode('; ', $style) . ';"');
}
public function format_colspec($open, $name, $attrs)
{
if ($open) {
$str = self::parse_table_entry_attributes(Format::colspec($attrs[Reader::XMLNS_DOCBOOK]));
return '- ';
foreach($questions as $node) {
$id = $xp->evaluate("ancestor::db:qandaentry", $node)->item(0)->getAttributeNs(Reader::XMLNS_XML, "id");
/* FIXME: No ID? How can we create an anchor for it then? */
if (!$id) {
$id = uniqid("phd");
}
$retval .= '
"; } return "
"; } /** * Functions from the old XHTMLPhDFormat */ public function format_legalnotice_chunk($open, $name, $attrs) { if ($open) { return '';
}
return "
\n";
}
public function format_div($open, $name, $attrs, $props) {
if ($open) {
return '';
}
return '
';
}
public function format_screen_text($value, $tag) {
return nl2br($this->TEXT($value));
}
/**
* Renders a ' . $arFixes[$class][0];
}
public function format_dl($open, $name, $attrs, $props) {
if ($open) {
return '';
}
return '
';
}
public function format_itemizedlist($open, $name, $attrs, $props) {
if ($open) {
return '';
}
return '
';
}
public function format_orderedlist($open, $name, $attrs, $props) {
if ($open) {
$numeration = "1";
if (isset($attrs[Reader::XMLNS_DOCBOOK]["numeration"])) {
switch($attrs[Reader::XMLNS_DOCBOOK]["numeration"]) {
case "upperalpha":
$numeration = "A";
break;
case "loweralpha":
$numeration = "a";
break;
case "upperroman":
$numeration = "I";
break;
case "lowerroman":
$numeration = "i";
break;
}
}
return '';
}
return '
';
}
/* Support for key inputs is coded like junk */
public function format_keycap($open, $name, $attrs, $props) {
if ($open) {
$content = '';
if ($props['sibling']) {
$content = '+';
}
return $content . '';
}
return '';
}
public function format_keycombo($open, $name, $attrs, $props) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["action"])) {
if ($attrs[Reader::XMLNS_DOCBOOK]["action"] !== "simul") {
v('No support for keycombo action = %s', $attrs[Reader::XMLNS_DOCBOOK]["action"], E_USER_WARNING);
}
}
if ($open) {
return '';
}
return '';
}
public function format_whitespace($whitespace, $elementStack, $currentDepth) {
/* The following if is to skip unnecessary whitespaces in the parameter list */
if (
in_array($elementStack[$currentDepth - 1], ['methodsynopsis', 'constructorsynopsis', 'destructorsynopsis'], true)
&& (in_array($elementStack[$currentDepth] ?? "", ["methodname", "methodparam", "type", "void"], true)
|| count($elementStack) === $currentDepth)
) {
return false;
}
/* The following if is to skip whitespace before closing semicolon after property/class constant */
if ($elementStack[$currentDepth - 1] === "fieldsynopsis" && (in_array($elementStack[$currentDepth], ["varname", "initializer"], true))) {
return false;
}
/*
TODO: add trim() in type_text handling method and remove the below
as it doesn't work due to XMLReader including all whitespace
inside the tag in the text
hence no separate significant whitespace here
*/
/* The following if is to skip whitespace inside type elements */
if ($elementStack[$currentDepth - 1] === "type") {
return false;
}
/* The following if is to skip unnecessary whitespaces in the implements list */
if (
($elementStack[$currentDepth - 1] === 'classsynopsisinfo' && $elementStack[$currentDepth] === 'oointerface') ||
($elementStack[$currentDepth - 1] === 'oointerface' && $elementStack[$currentDepth] === 'interfacename')
) {
return false;
}
return $whitespace;
}
}