Page MenuHomec4science
Files F68321918

PhutilRemarkupEngineRemarkupHeaderBlockRule.php
No OneTemporary
Actions

File Metadata

Created
Wed, Jun 26, 21:31

PhutilRemarkupEngineRemarkupHeaderBlockRule.php
View Options

<?php
/**
* @group markup
*/
final class PhutilRemarkupEngineRemarkupHeaderBlockRule
extends PhutilRemarkupEngineBlockRule {
const KEY_HEADER_TOC = 'headers.toc';
public function getBlockPattern() {
// Acceptable styles are "=== Header" or "Header\n===".
return '/^(?:(={1,5})[^\n]+|([^\n]+)\n[-=]{2,}\s*)$/';
}
public function shouldMergeBlocks() {
return false;
}
public function markupText($text) {
$text = trim($text);
$lines = phutil_split_lines($text);
if (count($lines) > 1) {
$level = ($lines[1][0] == '=') ? 1 : 2;
$text = trim($lines[0]);
} else {
$level = 0;
for ($ii = 0; $ii < min(5, strlen($text)); $ii++) {
if ($text[$ii] == '=') {
++$level;
} else {
break;
}
}
$text = trim($text, ' =');
}
$engine = $this->getEngine();
if ($engine->isTextMode()) {
$char = ($level == 1) ? '=' : '-';
return $text."\n".str_repeat($char, phutil_utf8_strlen($text));
}
$use_anchors = $engine->getConfig('header.generate-toc');
$anchor = null;
if ($use_anchors) {
$anchor = $this->generateAnchor($level, $text);
}
$text = phutil_tag(
'h'.($level + 1),
array(),
array($anchor, $this->applyRules($text)));
return $text;
}
private function generateAnchor($level, $text) {
$anchor = strtolower($text);
$anchor = preg_replace('/[^a-z0-9]/', '-', $anchor);
$anchor = preg_replace('/--+/', '-', $anchor);
$anchor = trim($anchor, '-');
$anchor = substr($anchor, 0, 24);
$anchor = trim($anchor, '-');
$base = $anchor;
$key = self::KEY_HEADER_TOC;
$engine = $this->getEngine();
$anchors = $engine->getTextMetadata($key, array());
$suffix = 1;
while (!strlen($anchor) || isset($anchors[$anchor])) {
$anchor = $base.'-'.$suffix;
$anchor = trim($anchor, '-');
$suffix++;
}
// When a document contains a link inside a header, like this:
//
// = [[ http://wwww.example.com/ | example ]] =
//
// ...we want to generate a TOC entry with just "example", but link the
// header itself. We push the 'toc' state so all the link rules generate
// just names.
$engine->pushState('toc');
$text = $this->applyRules($text);
$text = $engine->restoreText($text);
$anchors[$anchor] = array($level, $text);
$engine->popState('toc');
$engine->setTextMetadata($key, $anchors);
return phutil_tag(
'a',
array(
'name' => $anchor,
),
'');
}
public static function renderTableOfContents(PhutilRemarkupEngine $engine) {
$key = self::KEY_HEADER_TOC;
$anchors = $engine->getTextMetadata($key, array());
if (count($anchors) < 2) {
// Don't generate a TOC if there are no headers, or if there's only
// one header (since such a TOC would be silly).
return null;
}
$depth = 0;
$toc = array();
foreach ($anchors as $anchor => $info) {
list($level, $name) = $info;
while ($depth < $level) {
$toc[] = hsprintf('<ul>');
$depth++;
}
while ($depth > $level) {
$toc[] = hsprintf('</ul>');
$depth--;
}
$toc[] = phutil_tag(
'li',
array(),
phutil_tag(
'a',
array(
'href' => '#'.$anchor,
),
$name));
}
while ($depth > 0) {
$toc[] = hsprintf('</ul>');
$depth--;
}
return phutil_implode_html("\n", $toc);
}
}

Event Timeline

c4science · Help