|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Lichtenwallner (https://lichtenwallner.at) |
|
4
|
|
|
* |
|
5
|
|
|
* @see https://github.com/jolicht/markdown-cms for the canonical source repository |
|
6
|
|
|
* @license https://github.com/jolicht/markdown-cms/blob/master/LICENSE MIT |
|
7
|
|
|
* @copyright Copyright (c) Johannes Lichtenwallner |
|
8
|
|
|
*/ |
|
9
|
|
|
declare(strict_types = 1); |
|
10
|
|
|
namespace Jolicht\MarkdownCms\Markdown\Renderer; |
|
11
|
|
|
|
|
12
|
|
|
use League\CommonMark\ElementRendererInterface; |
|
13
|
|
|
use League\CommonMark\HtmlElement; |
|
14
|
|
|
use League\CommonMark\Inline\Renderer\InlineRendererInterface; |
|
15
|
|
|
use League\CommonMark\Inline\Element\AbstractInline; |
|
16
|
|
|
|
|
17
|
|
|
class ImageRenderer implements InlineRendererInterface |
|
18
|
|
|
{ |
|
19
|
|
|
/** |
|
20
|
|
|
* Image caption renderer |
|
21
|
|
|
* |
|
22
|
|
|
* @var ImageCaptionRenderer |
|
23
|
|
|
*/ |
|
24
|
|
|
private $captionRenderer; |
|
25
|
|
|
|
|
26
|
|
|
/** |
|
27
|
|
|
* Url Translation |
|
28
|
|
|
* |
|
29
|
|
|
* @var array |
|
30
|
|
|
*/ |
|
31
|
|
|
private $urlTranslation; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* Images base url |
|
35
|
|
|
* |
|
36
|
|
|
* @var string |
|
37
|
|
|
*/ |
|
38
|
|
|
private $imagesBaseUrl; |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* Images config |
|
42
|
|
|
* |
|
43
|
|
|
* @var array |
|
44
|
|
|
*/ |
|
45
|
|
|
private $imagesConfig; |
|
46
|
|
|
|
|
47
|
|
|
/** |
|
48
|
|
|
* Constructor |
|
49
|
|
|
* |
|
50
|
|
|
* @param ImageCaptionRenderer $imageCaptionRenderer |
|
|
|
|
|
|
51
|
|
|
* @param array $urlTranslation |
|
52
|
|
|
* @param string $imagesBaseUrl |
|
53
|
|
|
* @param array $imagesConfig |
|
54
|
|
|
*/ |
|
55
|
|
|
public function __construct(ImageCaptionRenderer $captionRenderer, array $urlTranslation, string $imagesBaseUrl, |
|
56
|
|
|
array $imagesConfig) |
|
57
|
|
|
{ |
|
58
|
|
|
$this->captionRenderer = $captionRenderer; |
|
59
|
|
|
$this->urlTranslation = $urlTranslation; |
|
60
|
|
|
$this->imagesBaseUrl = rtrim($imagesBaseUrl, '/'); |
|
61
|
|
|
$this->imagesConfig = $imagesConfig; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* Get caption renderer |
|
66
|
|
|
* |
|
67
|
|
|
* @return ImageCaptionRenderer |
|
68
|
|
|
*/ |
|
69
|
|
|
public function getCaptionRenderer() : ImageCaptionRenderer |
|
70
|
|
|
{ |
|
71
|
|
|
return $this->captionRenderer; |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
75
|
|
|
* Get url translation |
|
76
|
|
|
* |
|
77
|
|
|
* @return array |
|
78
|
|
|
*/ |
|
79
|
|
|
public function getUrlTranslation() : array |
|
80
|
|
|
{ |
|
81
|
|
|
return $this->urlTranslation; |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
/** |
|
85
|
|
|
* Get images base url |
|
86
|
|
|
* |
|
87
|
|
|
* @return string |
|
88
|
|
|
*/ |
|
89
|
|
|
public function getImagesBaseUrl() : string |
|
90
|
|
|
{ |
|
91
|
|
|
return $this->imagesBaseUrl; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* Get images config |
|
96
|
|
|
* |
|
97
|
|
|
* @return array |
|
98
|
|
|
*/ |
|
99
|
|
|
public function getImagesConfig() : array |
|
100
|
|
|
{ |
|
101
|
|
|
return $this->imagesConfig; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* Render image |
|
106
|
|
|
* |
|
107
|
|
|
* {@inheritDoc} |
|
108
|
|
|
* @see \League\CommonMark\Inline\Renderer\InlineRendererInterface::render() |
|
109
|
|
|
*/ |
|
110
|
|
|
public function render(AbstractInline $inline, ElementRendererInterface $htmlRenderer) |
|
111
|
|
|
{ |
|
112
|
|
|
$src = $inline->getUrl(); |
|
|
|
|
|
|
113
|
|
|
$id = substr($src, strlen($this->getImagesBaseUrl()) + 1); |
|
114
|
|
|
|
|
115
|
|
|
$imagesConfig = $this->getImagesConfig(); |
|
116
|
|
|
$params = $imagesConfig[$id]; |
|
117
|
|
|
|
|
118
|
|
|
|
|
119
|
|
|
$imgAttributes = [ |
|
120
|
|
|
'src' => strtr($inline->getUrl(), $this->getUrlTranslation()), |
|
|
|
|
|
|
121
|
|
|
'layout' => 'responsive', |
|
122
|
|
|
'alt' => $inline->firstChild()->getContent(), |
|
|
|
|
|
|
123
|
|
|
'width' => $params['width'], |
|
124
|
|
|
'height' => $params['height'] |
|
125
|
|
|
]; |
|
126
|
|
|
|
|
127
|
|
|
$figureContents = []; |
|
128
|
|
|
$figureContents[] = new HtmlElement('amp-img', $imgAttributes); |
|
129
|
|
|
|
|
130
|
|
|
if (isset($params['caption'])) { |
|
131
|
|
|
// $figureContents[] = new HtmlElement('figcaption', [], $params['caption']); |
|
|
|
|
|
|
132
|
|
|
$figureContents[] = $this->getCaptionRenderer()->__invoke($params); |
|
133
|
|
|
} |
|
134
|
|
|
|
|
135
|
|
|
$figure = new HtmlElement('figure', [], $figureContents); |
|
136
|
|
|
return $figure; |
|
137
|
|
|
} |
|
138
|
|
|
|
|
139
|
|
|
/** |
|
140
|
|
|
* Render image |
|
141
|
|
|
* |
|
142
|
|
|
* {@inheritDoc} |
|
143
|
|
|
* @see \League\CommonMark\Inline\Renderer\InlineRendererInterface::render() |
|
144
|
|
|
*/ |
|
145
|
|
|
public function renderOld(AbstractInline $inline, ElementRendererInterface $htmlRenderer) |
|
|
|
|
|
|
146
|
|
|
{ |
|
147
|
|
|
$altContent = $inline->firstChild()->getContent(); |
|
|
|
|
|
|
148
|
|
|
$attributes = [ |
|
149
|
|
|
'src' => strtr($inline->getUrl(), $this->getUrlTranslation()), |
|
|
|
|
|
|
150
|
|
|
'alt' => $altContent, |
|
151
|
|
|
]; |
|
152
|
|
|
|
|
153
|
|
|
$caption = null; |
|
154
|
|
|
|
|
155
|
|
|
$posJsonOpen = strpos($altContent, '{'); |
|
156
|
|
|
$posJsonClose = strpos($altContent, '}'); |
|
157
|
|
|
if ((false !== $posJsonOpen) and (false !== $posJsonClose)) { |
|
|
|
|
|
|
158
|
|
|
$json = substr($altContent, $posJsonOpen, $posJsonClose); |
|
159
|
|
|
$data = json_decode($json, true); |
|
160
|
|
|
if (is_array($data)) { |
|
161
|
|
|
if (isset($data['caption'])) { |
|
162
|
|
|
$caption = $data['caption']; |
|
163
|
|
|
unset($data['caption']); |
|
164
|
|
|
} |
|
165
|
|
|
$attributes = array_merge($attributes, $data); |
|
166
|
|
|
} |
|
167
|
|
|
$attributes['alt'] = substr($altContent, 0, $posJsonOpen); |
|
168
|
|
|
} |
|
169
|
|
|
|
|
170
|
|
|
if (isset($attributes['id'])) { |
|
171
|
|
|
$imagesConfig = $this->getImagesConfig(); |
|
172
|
|
|
$config = $imagesConfig[$attributes['id']]; |
|
173
|
|
|
if (isset($config['width'])) { |
|
174
|
|
|
$attributes['width'] = $config['width']; |
|
175
|
|
|
} |
|
176
|
|
|
if (isset($config['height'])) { |
|
177
|
|
|
$attributes['height'] = $config['height']; |
|
178
|
|
|
} |
|
179
|
|
|
if (isset($config['caption'])) { |
|
180
|
|
|
$caption = $config['caption']; |
|
181
|
|
|
} |
|
182
|
|
|
} |
|
183
|
|
|
|
|
184
|
|
|
if (!isset($attributes['layout'])) { |
|
185
|
|
|
$attributes['layout'] = 'responsive'; |
|
186
|
|
|
} |
|
187
|
|
|
|
|
188
|
|
|
$figureContents = []; |
|
189
|
|
|
$figure = new HtmlElement('figure'); |
|
|
|
|
|
|
190
|
|
|
$figureContents[] = new HtmlElement('amp-img', $attributes); |
|
191
|
|
|
if (null !== $caption) { |
|
192
|
|
|
$figureContents[] = new HtmlElement('figcaption', [], $caption); |
|
193
|
|
|
} |
|
194
|
|
|
return new HtmlElement('figure', [], $figureContents); |
|
195
|
|
|
} |
|
196
|
|
|
} |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.
Consider the following example. The parameter
$irelandis not defined by the methodfinale(...).The most likely cause is that the parameter was changed, but the annotation was not.