3 * @copyright Copyright (c) 2014 Carsten Brandt
4 * @license https://github.com/cebe/markdown/blob/master/LICENSE
5 * @link https://github.com/cebe/markdown#readme
8 namespace cebe\markdown\block;
11 * Adds the list blocks
16 * @var bool enable support `start` attribute of ordered lists. This means that lists
17 * will start with the number you actually type in markdown and not the HTML generated one.
18 * Defaults to `false` which means that numeration of all ordered lists(<ol>) starts with 1.
20 public $keepListStartNumber = false;
23 * identify a line as the beginning of an ordered list.
25 protected function identifyOl($line)
27 return (($l = $line[0]) > '0' && $l <= '9' || $l === ' ') && preg_match('/^ {0,3}\d+\.[ \t]/', $line);
31 * identify a line as the beginning of an unordered list.
33 protected function identifyUl($line)
36 return ($l === '-' || $l === '+' || $l === '*') && (isset($line[1]) && (($l1 = $line[1]) === ' ' || $l1 === "\t")) ||
37 ($l === ' ' && preg_match('/^ {0,3}[\-\+\*][ \t]/', $line));
41 * Consume lines for an ordered list
43 protected function consumeOl($lines, $current)
45 // consume until newline
53 return $this->consumeList($lines, $current, $block, 'ol');
57 * Consume lines for an unordered list
59 protected function consumeUl($lines, $current)
61 // consume until newline
68 return $this->consumeList($lines, $current, $block, 'ul');
71 private function consumeList($lines, $current, $block, $type)
76 // track the indentation of list markers, if indented more than previous element
77 // a list marker is considered to be long to a lower level
79 $marker = $type === 'ul' ? ltrim($lines[$current])[0] : '';
80 for ($i = $current, $count = count($lines); $i < $count; $i++) {
82 // match list marker on the beginning of the line
83 if (preg_match($type == 'ol' ? '/^( {0,'.$leadSpace.'})(\d+)\.[ \t]+/' : '/^( {0,'.$leadSpace.'})\\'.$marker.'[ \t]+/', $line, $matches)) {
84 if (($len = substr_count($matches[0], "\t")) > 0) {
85 $indent = str_repeat("\t", $len);
86 $line = substr($line, strlen($matches[0]));
88 $len = strlen($matches[0]);
89 $indent = str_repeat(' ', $len);
90 $line = substr($line, $len);
92 if ($i === $current) {
93 $leadSpace = strlen($matches[1]) + 1;
96 if ($type == 'ol' && $this->keepListStartNumber) {
97 // attr `start` for ol
98 if (!isset($block['attr']['start']) && isset($matches[2])) {
99 $block['attr']['start'] = $matches[2];
103 $block['items'][++$item][] = $line;
104 } elseif (ltrim($line) === '') {
105 // next line after empty one is also a list or indented -> lazy list
106 if (isset($lines[$i + 1][0]) && (
107 $this->{'identify' . $type}($lines[$i + 1], $lines, $i + 1) && ($type !== 'ul' || ltrim($lines[$i + 1])[0] === $marker) ||
108 (strncmp($lines[$i + 1], $indent, $len) === 0 || !empty($lines[$i + 1]) && $lines[$i + 1][0] == "\t"))) {
109 $block['items'][$item][] = $line;
110 $block['lazyItems'][$item] = true;
115 if ($line[0] === "\t") {
116 $line = substr($line, 1);
117 } elseif (strncmp($line, $indent, $len) === 0) {
118 $line = substr($line, $len);
120 $block['items'][$item][] = $line;
124 // make last item lazy if item before was lazy
125 if (isset($block['lazyItems'][$item - 1])) {
126 $block['lazyItems'][$item] = true;
129 foreach($block['items'] as $itemId => $itemLines) {
131 if (!isset($block['lazyItems'][$itemId])) {
133 while (!empty($itemLines) && rtrim($itemLines[0]) !== '' && $this->detectLineType($itemLines, 0) === 'paragraph') {
134 $firstPar[] = array_shift($itemLines);
136 $content = $this->parseInline(implode("\n", $firstPar));
138 if (!empty($itemLines)) {
139 $content = array_merge($content, $this->parseBlocks($itemLines));
141 $block['items'][$itemId] = $content;
150 protected function renderList($block)
152 $type = $block['list'];
154 if (!empty($block['attr'])) {
155 $output = "<$type " . $this->generateHtmlAttributes($block['attr']) . ">\n";
157 $output = "<$type>\n";
160 foreach ($block['items'] as $item => $itemLines) {
161 $output .= '<li>' . $this->renderAbsy($itemLines). "</li>\n";
163 return $output . "</$type>\n";
168 * Return html attributes string from [attrName => attrValue] list
169 * @param array $attributes the attribute name-value pairs.
172 private function generateHtmlAttributes($attributes)
174 foreach ($attributes as $name => $value) {
175 $attributes[$name] = "$name=\"$value\"";
177 return implode(' ', $attributes);
180 abstract protected function parseInline($text);
181 abstract protected function renderAbsy($absy);