Namespaces

Classes

Interfaces

1: <?php
2:
3: /*
4: * The MIT License (MIT)
5: *
6: * Copyright (c) 2013 Jonathan Vollebregt (jnvsor@gmail.com), Rokas Šleinius (raveren@gmail.com)
7: *
8: * Permission is hereby granted, free of charge, to any person obtaining a copy of
9: * this software and associated documentation files (the "Software"), to deal in
10: * the Software without restriction, including without limitation the rights to
11: * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
12: * the Software, and to permit persons to whom the Software is furnished to do so,
13: * subject to the following conditions:
14: *
15: * The above copyright notice and this permission notice shall be included in all
16: * copies or substantial portions of the Software.
17: *
18: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
20: * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
21: * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
22: * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23: * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24: */
25:
26: namespace Kint\Renderer\Rich;
27:
28: use Kint\Kint;
29: use Kint\Object\Representation\DocstringRepresentation;
30: use Kint\Object\Representation\Representation;
31:
32: class DocstringPlugin extends Plugin implements TabPluginInterface
33: {
34: public function renderTab(Representation $r)
35: {
36: if (!($r instanceof DocstringRepresentation)) {
37: return false;
38: }
39:
40: $docstring = array();
41: foreach (\explode("\n", $r->contents) as $line) {
42: $docstring[] = \trim($line);
43: }
44:
45: $docstring = \implode("\n", $docstring);
46:
47: $location = array();
48:
49: if ($r->class) {
50: $location[] = 'Inherited from '.$this->renderer->escape($r->class);
51: }
52: if ($r->file && $r->line) {
53: $location[] = 'Defined in '.$this->renderer->escape(Kint::shortenPath($r->file)).':'.((int) $r->line);
54: }
55:
56: $location = \implode("\n", $location);
57:
58: if ($location) {
59: if (\strlen($docstring)) {
60: $docstring .= "\n\n";
61: }
62:
63: $location = '<small>'.$location.'</small>';
64: } elseif (0 === \strlen($docstring)) {
65: return '';
66: }
67:
68: return '<pre>'.$this->renderer->escape($docstring).$location.'</pre>';
69: }
70: }
71:
API documentation generated by ApiGen v7.0.0-alpha.6