|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* @copyright Copyright (c) 2017 Julius Härtl <[email protected]> |
|
4
|
|
|
* |
|
5
|
|
|
* @author Julius Härtl <[email protected]> |
|
6
|
|
|
* |
|
7
|
|
|
* @license GNU AGPL version 3 or any later version |
|
8
|
|
|
* |
|
9
|
|
|
* This program is free software: you can redistribute it and/or modify |
|
10
|
|
|
* it under the terms of the GNU Affero General Public License as |
|
11
|
|
|
* published by the Free Software Foundation, either version 3 of the |
|
12
|
|
|
* License, or (at your option) any later version. |
|
13
|
|
|
* |
|
14
|
|
|
* This program is distributed in the hope that it will be useful, |
|
15
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
16
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
17
|
|
|
* GNU Affero General Public License for more details. |
|
18
|
|
|
* |
|
19
|
|
|
* You should have received a copy of the GNU Affero General Public License |
|
20
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
21
|
|
|
* |
|
22
|
|
|
*/ |
|
23
|
|
|
|
|
24
|
|
|
namespace JuliusHaertl\PHPDocToRst\Extension; |
|
25
|
|
|
|
|
26
|
|
|
use JuliusHaertl\PHPDocToRst\Builder\FileBuilder; |
|
27
|
|
|
use JuliusHaertl\PHPDocToRst\Builder\InterfaceFileBuilder; |
|
28
|
|
|
use JuliusHaertl\PHPDocToRst\Builder\RstBuilder; |
|
29
|
|
|
use phpDocumentor\Reflection\Php\Interface_; |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* This extension will render a list of methods for easy access |
|
33
|
|
|
* at the beginning of classes, interfaces and traits |
|
34
|
|
|
*/ |
|
35
|
|
|
|
|
36
|
|
|
class TocExtension extends Extension { |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* @param string $type |
|
40
|
|
|
* @param FileBuilder $builder |
|
41
|
|
|
*/ |
|
42
|
|
|
public function render($type, &$builder) { |
|
43
|
|
|
if ($type === InterfaceFileBuilder::SECTION_AFTER_DESCRIPTION) { |
|
44
|
|
|
$builder->addLine(); |
|
45
|
|
|
/** @var Interface_ $interface */ |
|
46
|
|
|
$interface = $builder->getElement(); |
|
47
|
|
|
$builder->addH2('Methods'); |
|
48
|
|
|
foreach ($interface->getMethods() as $method) { |
|
49
|
|
|
$builder->addLine('* :php:meth:`' . $method->getName() . '`'); |
|
50
|
|
|
} |
|
51
|
|
|
$builder->addLine(); |
|
52
|
|
|
} |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
} |
juliushaertl /
phpdoc-to-rst
