-
Notifications
You must be signed in to change notification settings - Fork 31
/
RendererInterface.php
154 lines (136 loc) · 3.02 KB
/
RendererInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
namespace Ciconia\Renderer;
use Ciconia\Common\Tag;
use Ciconia\Common\Text;
/**
* RendererInterface must be implemented by classes that renders result of Markdown
*
* @author Kazuyuki Hayashi <hayashi@valnur.net>
*/
interface RendererInterface
{
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderParagraph($content, array $options = array());
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderHeader($content, array $options = array());
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderCodeBlock($content, array $options = array());
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderCodeSpan($content, array $options = array());
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderLink($content, array $options = array());
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderBlockQuote($content, array $options = array());
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderList($content, array $options = array());
/**
* @api
*
* @param string|Text $content
* @param array $options
*
* @return string
*/
public function renderListItem($content, array $options = array());
/**
* @api
*
* @param array $options
*
* @return string
*/
public function renderHorizontalRule(array $options = array());
/**
* @api
*
* @param string $src
* @param array $options
*
* @return string
*/
public function renderImage($src, array $options = array());
/**
* @api
*
* @param string|Text $text
* @param array $options
*
* @return string
*/
public function renderBoldText($text, array $options = array());
/**
* @api
*
* @param string|Text $text
* @param array $options
*
* @return string
*/
public function renderItalicText($text, array $options = array());
/**
* @api
*
* @param array $options
*
* @return string
*/
public function renderLineBreak(array $options = array());
/**
* @param string $tagName
* @param string $content
* @param string $tagType
* @param array $options
*
* @return mixed
*/
public function renderTag($tagName, $content, $tagType = Tag::TYPE_BLOCK, array $options = array());
}