';
} else {
if ($inPackageSynopsis) {
return '}';
}
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_packagesynopsis($open, $name, $attrs, $props) {
if ($open) {
$this->cchunk["packagesynopsis"] = true;
return '
';
}
$this->cchunk["packagesynopsis"] = false;
return '
';
}
public function format_packagesynopsis_package($open, $name, $attrs, $props) {
if ($open) {
return '
namespace ';
}
return ';
';
}
public function format_enumsynopsis($open, $name, $attrs, $props) {
$inPackageSynopsis = $this->cchunk["packagesynopsis"] ?? false;
if ($open) {
if ($inPackageSynopsis) {
return '
';
}
return '
';
} else {
if ($inPackageSynopsis) {
return '}';
}
return '}
';
}
}
public function format_enumsynopsis_enumname($open, $name, $attrs, $props): string {
if ($open) {
/** Actual enum name in bold */
return '
enum ';
//return 'enum ';
}
//return "
{
";
return "{
";
}
public function format_enumitem($open, $name, $attrs, $props) {
if ($open) {
return '
';
}
return '
';
}
public function format_enumidentifier($open, $name, $attrs, $props) {
if ($open) {
return '
case ';
}
return '';
}
public function format_enumvalue($open, $name, $attrs, $props) {
if ($open) {
return ' = ';
}
return '';
}
public function format_enumitemdescription($open, $name, $attrs, $props) {
if ($open) {
return '; //';
}
return "
";
}
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) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
$this->pushRole($attrs[Reader::XMLNS_DOCBOOK]["role"]);
}
return '
';
}
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
$this->popRole();
}
return ";
\n";
}
public function format_fieldsynopsis_modifier_text($value, $tag) {
$this->cchunk["fieldsynopsis"]["modifier"] = trim($value);
if ($this->getRole() === "attribute") {
$attribute = trim(strtolower($value), "#[]\\");
$href = Format::getFilename("class.$attribute");
if ($href) {
return '
' .$value. ' ';
}
return false;
}
return $this->TEXT($value);
}
public function format_modifier($open, $name, $attrs, $props) {
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
$this->pushRole($attrs[Reader::XMLNS_DOCBOOK]["role"]);
return '
';
}
return '';
}
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
if ($attrs[Reader::XMLNS_DOCBOOK]["role"] === "attribute") {
return '
';
}
$this->popRole();
}
return '';
}
public function format_methodparam_modifier($open, $name, $attrs, $props) {
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
$this->pushRole($attrs[Reader::XMLNS_DOCBOOK]["role"]);
return '
';
}
return '';
}
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
$this->popRole();
}
return '';
}
public function format_modifier_text($value, $tag) {
if ($this->getRole() === "attribute") {
$attribute = trim(strtolower($value), "#[]\\");
$href = Format::getFilename("class.$attribute");
if ($href) {
return '' .$value. ' ';
}
}
return false;
}
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 = "";
if ($this->params["paramCount"] > 3) {
$content .= "
";
}
$content .= ")";
$content .= "\n";
return $content;
}
public function format_methodparam_parameter($open, $name, $attrs, $props)
{
if ($props["empty"]) {
return '';
}
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]["role"])) {
return '
&' . $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 (isset($props['sibling']) && $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"];
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 "";
}
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 '';
}
public function format_callout($open, $name, $attrs) {
if ($open) {
return '| ' .str_repeat("*", ++$this->cchunk["callouts"]). ' | ';
}
return " |
\n";
}
public function format_manvolnum($open, $name, $attrs) {
if ($open) {
return '(';
}
return ")";
}
public function format_segmentedlist($open, $name, $attrs) {
$this->cchunk["segmentedlist"] = $this->dchunk["segmentedlist"];
if ($open) {
return '';
}
public function format_segtitle_text($value, $tag) {
$html = '';
if (!$this->cchunk["segmentedlist"]["segtitleopened"]) {
$html .= '';
}
$html .= '| '.$this->TEXT($value).' | ';
$this->cchunk["segmentedlist"]["segtitleopened"] = true;
// Don't close the row; we'll have to do that in the first seglistitem.
return $html;
}
public function format_seglistitem($open, $name, $attrs) {
if ($open) {
$html = '';
if (!$this->cchunk["segmentedlist"]["segtitleclosed"]) {
$html .= '
';
$this->cchunk["segmentedlist"]["segtitleclosed"] = true;
}
$html .= '';
return $html;
}
return '
';
}
public function format_seg($open, $name, $attrs) {
if ($open) {
return '';
}
return ' | ';
}
public function format_procedure($open, $name, $attrs) {
$this->cchunk["procedure"] = false;
if ($open) {
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->pushRole($attrs[Reader::XMLNS_DOCBOOK]["role"]);
}
$classStr = $headerStr = $idStr = '';
if (isset($attrs[Reader::XMLNS_XML]["id"])) {
$idStr = ' id="' . $attrs[Reader::XMLNS_XML]["id"] . '"';
}
if ($this->getRole() === 'constant_list') {
$tagName = 'table';
$classStr = ' class="doctable table"';
$headerStr = "\n" . $this->indent($props["depth"] + 1) . "\n"
. $this->indent($props["depth"] + 2) . "| "
. $this->autogen('Constants', $props['lang']) . " | \n"
. $this->indent($props["depth"] + 2) . ""
. $this->autogen('Description', $props['lang']) . " | \n"
. $this->indent($props["depth"] + 1) . "
";
} else {
$tagName = 'dl';
}
return '<' . $tagName . $idStr . $classStr . '>' . $headerStr;
}
$tagName = ($this->getRole() === 'constant_list') ? 'table' : 'dl';
$this->popRole();
return "";
}
public function format_varlistentry($open, $name, $attrs) {
if ($open) {
if (isset($attrs[Reader::XMLNS_XML]["id"])) {
$this->cchunk['varlistentry']['id'] = $attrs[Reader::XMLNS_XML]["id"];
} else {
unset($this->cchunk['varlistentry']['id']);
}
return ($this->getRole() === 'constant_list') ? '' : '';
}
return ($this->getRole() === 'constant_list') ? '
' : '';
}
public function format_varlistentry_term($open, $name, $attrs, $props) {
$tagName = ($this->getRole() === 'constant_list') ? 'td' : 'dt';
if ($open) {
if (isset($this->cchunk['varlistentry']['id'])) {
$id = $this->cchunk['varlistentry']['id'];
unset($this->cchunk['varlistentry']['id']);
return '<' . $tagName . ' id="' . $id . '">';
} else {
return "<" . $tagName . ">";
}
}
return "";
}
public function format_varlistentry_listitem($open, $name, $attrs) {
$tagName = ($this->getRole() === 'constant_list') ? 'td' : 'dd';
if ($open) {
return "<" . $tagName . ">";
}
return "";
}
public function format_term($open, $name, $attrs, $props) {
if ($open) {
if ($props["sibling"] == $name) {
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 '";
}
public function format_programlisting($open, $name, $attrs) {
$hasAnnotations = array_key_exists('annotations', $attrs[Reader::XMLNS_DOCBOOK]);
if ($open) {
$this->pushRole($attrs[Reader::XMLNS_DOCBOOK]["role"] ?? null);
if ($hasAnnotations) {
$this->pushAnnotations($attrs[Reader::XMLNS_DOCBOOK]["annotations"]);
}
return '';
}
if ($hasAnnotations) {
$this->popAnnotations();
}
$this->popRole();
return "
\n";
}
public function format_programlisting_text($value, $tag) {
return $this->CDATA($value);
}
public function format_screen($open, $name, $attrs) {
if ($open) {
if ($this->getRole() !== "examples"
&& $this->getRole() !== "description"
&& $this->getRole() !== "notes"
&& $this->getRole() !== "returnvalues"
&& $this->getRole() !== "parameters") {
$this->pushRole('');
}
return '';
}
if ($this->getRole() !== "examples"
&& $this->getRole() !== "description"
&& $this->getRole() !== "notes"
&& $this->getRole() !== "returnvalues"
&& $this->getRole() !== "parameters") {
$this->popRole();
}
return '
';
}
public function format_constant($open, $name, $attrs, $props)
{
if ($open) {
if (str_contains($props["innerXml"], 'pushRole("constant_group");
$this->cchunk["constant"] = $props["innerXml"];
}
return "";
}
if ($this->getRole() === "constant_group") {
$this->popRole();
$value = str_replace(
["", ""],
["", ""],
strip_tags($this->cchunk["constant"], "")
);
$link = $this->createReplaceableConstantLink(strip_tags($this->cchunk["constant"], ""));
$this->cchunk["constant"] = "";
if ($link === "") {
return $value . '';
}
return '' . $value . '';
}
return "";
}
/**
* Creates a link to the first constant in the index
* that matches the pattern of a constant containing a tag
* or returns an empty string if no match was found.
*
* This works only with one set of tags in a constant
* e.g. CURLE_* or DOM_*_NODE
*/
private function createReplaceableConstantLink(string $constant): string {
$pattern = "/" . preg_replace(
"//",
".*",
str_replace(
".",
"\.",
$this->convertConstantNameToId($constant)
)
) ."/";
$matchingConstantId = "";
foreach ($this->indexes as $index) {
if (preg_match($pattern, $index["docbook_id"])) {
$matchingConstantId = $index["docbook_id"];
break;
}
}
return $matchingConstantId === "" ? "" : $this->createLink($matchingConstantId);
}
private function convertConstantNameToId(string $constantName): string {
$tempLinkValue = str_replace(
array("\\", "_"),
array("-", "-"),
trim($this->normalizeFQN($constantName), "_")
);
if (str_contains($constantName, '::')) {
// class constant
list($extensionAndClass, $constant) = explode("::", $tempLinkValue);
$normalizedLinkFormat = $extensionAndClass . ".constants." . trim($constant, "-");
} else {
$normalizedLinkFormat = 'constant.' . $tempLinkValue;
}
return $normalizedLinkFormat;
}
public function format_constant_text($value, $tag) {
if ($this->getRole() === "constant_group") {
return "";
}
$normalizedLinkFormat = $this->convertConstantNameToId($value);
$link = $this->createLink($normalizedLinkFormat);
if ($link === null) {
return $value;
}
return '' . $value . '';
}
public function format_replaceable($open, $name, $attrs, $props) {
if ($this->getRole() === "constant_group") {
return "";
}
return false;
}
public function format_property_text($value, $tag) {
if (! str_contains($value, '::')) {
return $value;
}
$tempLinkValue = str_replace(
["\\", "_", "$"],
["-", "-", ""],
trim($this->normalizeFQN($value), "_")
);
list($extensionAndClass, $property) = explode("::", $tempLinkValue);
$normalizedLinkFormat = $extensionAndClass . ".props." . trim($property, "-");
$link = $this->createLink($normalizedLinkFormat);
if ($link === null || $link === "") {
return $value;
}
return '' . $value . '';
}
protected function normalizeFQN(string $fqn): string {
return \ltrim(\strtolower($fqn), "\\");
}
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 '
';
}
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 '
'.$this->admonition_title("note", $props["lang"]). ': ';
}
return "
";
}
public function format_note_title($open, $name, $attrs)
{
if ($open) {
return '
';
}
return '';
}
public function format_example($open, $name, $attrs, $props) {
if ($open) {
++$this->exampleCounter;
if (isset($props["id"])) {
return '
';
}
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_variablelist_title($open, $name, $attrs, $props) {
if ($open) {
return ($this->getRole() === 'constant_list') ? "
" : "";
}
return ($this->getRole() === 'constant_list') ? "" : "";
}
public function format_mediaobject($open, $name, $attrs) {
$this->cchunk["mediaobject"] = $this->dchunk["mediaobject"];
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) {
$this->outputHandler->v('Missing %s attribute for %s', (!$width ? 'width' : 'height'), $file, VERBOSE_MISSING_ATTRIBUTES);
}
if (false === $this->cchunk["mediaobject"]["alt"]) {
$this->outputHandler->v('Missing alt attribute for %s', $file, VERBOSE_MISSING_ATTRIBUTES);
}
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);
$str .= $this->format_row(true, "footnote", $opts);
$str .= $this->format_entry(true, "footnote", $opts, $props+array("colspan" => $this->getColCount()));
foreach ($this->cchunk["tablefootnotes"] as $k => $noteid) {
$str .= '\n";
}
$str .= $this->format_entry(false, "footnote", $opts, $props);
$str .= $this->format_row(false, "footnote", $opts);
$str .= $this->format_tbody(false, "footnote", $opts);
$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 '';
}
/* noop */
}
public function format_th($open, $name, $attrs)
{
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]['valign'])) {
return '<' . $name . ' style="vertical-align: '
. $attrs[Reader::XMLNS_DOCBOOK]['valign'] . ';">';
} else {
return '<' . $name . '>';
}
}
return "\n";
}
public function format_tbody($open, $name, $attrs)
{
if ($open) {
if (isset($attrs[Reader::XMLNS_DOCBOOK]['valign'])) {
return '';
} else {
return '';
}
}
return "";
}
public function format_row($open, $name, $attrs)
{
if ($open) {
$idstr = '';
if (isset($attrs[Reader::XMLNS_XML]['id'])) {
$idstr = ' id="'. $attrs[Reader::XMLNS_XML]['id']. '"';
}
Format::initRow();
if (isset($attrs[Reader::XMLNS_DOCBOOK]['valign'])) {
return '';
} 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) {
$xml = "" . $props["innerXml"] . "";
$doc = new \DOMDocument;
$doc->loadXml($xml);
$xp = new \DOMXPath($doc);
$xp->registerNamespace("db", Reader::XMLNS_DOCBOOK);
$questions = $xp->query("//db:qandaentry/db:question");
$retval = '';
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 .= '- '.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 "
";
}
/**
* 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 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 '' . $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 '';
}
public function format_simplelist($open, $name, $attrs, $props) {
if ($open) {
$this->cchunk["simplelist"]["type"] = $attrs[Reader::XMLNS_DOCBOOK]["type"] ?? "";
$this->cchunk["simplelist"]["columns"] = $attrs[Reader::XMLNS_DOCBOOK]["columns"] ?? 1;
if ($this->cchunk["simplelist"]["columns"] < 1) {
$this->cchunk["simplelist"]["columns"] = 1;
}
if ($this->cchunk["simplelist"]["type"] === "inline") {
return '';
}
if ($this->cchunk["simplelist"]["type"] === "vert"
|| $this->cchunk["simplelist"]["type"] === "horiz") {
return '' . "\n" . $this->indent($props["depth"] + 1) . "\n";
}
return '';
}
$list = match ($this->cchunk["simplelist"]["type"]) {
"inline" => $this->simplelist_format_inline(),
"horiz" => $this->simplelist_format_horizontal($props["depth"])
. $this->indent($props["depth"] + 1) . "
\n"
. $this->indent($props["depth"]) . "
",
"vert" => $this->simplelist_format_vertical($props["depth"])
. $this->indent($props["depth"] + 1) . "
\n"
. $this->indent($props["depth"]) . "",
default => "",
};
$this->cchunk["simplelist"] = $this->dchunk["simplelist"];
return $list;
}
private function indent($depth): string {
return $depth > 0 ? str_repeat(' ', $depth) : '';
}
private function simplelist_format_inline() {
return implode(", ", $this->cchunk["simplelist"]["members"]) . '';
}
private function simplelist_format_horizontal($depth) {
return $this->chunkReduceTable(
$this->processTabular(
$this->cchunk["simplelist"]["members"],
$this->cchunk["simplelist"]["columns"],
$depth),
$this->cchunk["simplelist"]["columns"],
$depth
);
}
/** Return formatted rows */
private function chunkReduceTable(array $members, int $cols, int $depth): string
{
$trPadding = $this->indent($depth + 2);
return array_reduce(
array_chunk(
$members,
$cols,
),
fn (string $carry, array $entry) => $carry . $trPadding . "\n" . implode('', $entry) . $trPadding . "
\n",
''
);
}
/** Pads $members so that number of members = columns x rows */
private function processTabular(array $members, int $cols, int $depth): array
{
$tdPadding = $this->indent($depth + 3);
return array_map(
fn (string $member) => $tdPadding . "$member | \n",
/** The padding is done by getting the additive modular inverse which is
* ``-\count($members) % $cols`` but because PHP gives us the mod in negative we need to
* add $cols back to get the positive
*/
[...$members, ...array_fill(0, (-\count($members) % $cols) + $cols, '')]
);
}
private function simplelist_format_vertical($depth) {
$members = $this->processTabular(
$this->cchunk["simplelist"]["members"],
$this->cchunk["simplelist"]["columns"],
$depth
);
// Sort elements so that we get each correct element for the rows to display vertically
uksort(
$members,
fn (int $l, int $r) => $l % $this->cchunk["simplelist"]["columns"] <=> $r % $this->cchunk["simplelist"]["columns"]
);
return $this->chunkReduceTable($members, $this->cchunk["simplelist"]["columns"], $depth);
}
public function format_member($open, $name, $attrs, $props) {
if ($this->cchunk["simplelist"]["type"] === "inline"
|| $this->cchunk["simplelist"]["type"] === "vert"
|| $this->cchunk["simplelist"]["type"] === "horiz") {
$this->appendToBuffer = $open;
if (! $open) {
$this->cchunk["simplelist"]["members"][] = $this->buffer;
}
$this->buffer = '';
return '';
}
if ($open) {
return '';
}
return '';
}
public function format_member_text($value, $tag) {
return $value;
}
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") {
trigger_error(vsprintf('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;
}
if (
$elementStack[$currentDepth - 1] === "simplelist"
&& ($this->cchunk["simplelist"]["type"] === "inline"
|| $this->cchunk["simplelist"]["type"] === "vert"
|| $this->cchunk["simplelist"]["type"] === "horiz")
) {
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;
}
public function format_caption($open, $name, $attrs, $props) {
return $open ? '' : '
';
}
public function getGeneratedExampleID($index)
{
$originalId = parent::getGeneratedExampleID($index);
if (! $this->exampleCounterIsPerPage) {
return $originalId;
}
if (preg_match('/^example\-[0-9]+$/', $originalId)) {
$this->perPageExampleCounter++;
$this->perPageExampleIds[$originalId] = 'example-' . $this->perPageExampleCounter;
return $this->perPageExampleIds[$originalId];
}
return $originalId;
}
public function onNewPage(): void
{
$this->perPageExampleCounter = 0;
}
}