Skip to content

configure: remove overridden inherited methods from class synopses - #358

Open
vrana wants to merge 1 commit into
php:masterfrom
vrana:remove-overridden-methods
Open

configure: remove overridden inherited methods from class synopses#358
vrana wants to merge 1 commit into
php:masterfrom
vrana:remove-overridden-methods

Conversation

@vrana

@vrana vrana commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Class synopses include the methods of parents and interfaces by XInclude, so a method the class overrides was listed twice, e.g. ReflectionFunction::__toString() and ReflectionFunctionAbstract::__toString(). After expanding XIncludes, keep only the first method of each name. Overloads (same class and method name) are kept.

This removes 181 duplicate methods from the manual.

@vrana @claude
configure: remove overridden inherited methods from class synopses
abfe2ee 
Class synopses include the methods of parents and interfaces by XInclude,
so a method the class overrides was listed twice, e.g.
ReflectionFunction::__toString() and ReflectionFunctionAbstract::__toString().
After expanding XIncludes, keep only the first method of each name.
Overloads (same class and method name) are kept.

This removes 181 duplicate methods from the manual.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vrana
vrana requested a review from alfsb October 23, 2026 06:51
@vrana

vrana commented Oct 23, 2026

Copy link
Copy Markdown
Contributor Author

Class synopsis duplicates

Overridden inherited methods removed (181)

# Synopsis Kept Removed
1 throwable Throwable::__toString Stringable::__toString
2 phar RecursiveDirectoryIterator::key FilesystemIterator::key
3 phar RecursiveDirectoryIterator::next FilesystemIterator::next
4 phar RecursiveDirectoryIterator::rewind FilesystemIterator::rewind
5 phar FilesystemIterator::current DirectoryIterator::current
6 phar RecursiveDirectoryIterator::key DirectoryIterator::key
7 phar RecursiveDirectoryIterator::next DirectoryIterator::next
8 phar RecursiveDirectoryIterator::rewind DirectoryIterator::rewind
9 phar DirectoryIterator::getBasename SplFileInfo::getBasename
10 phar DirectoryIterator::getExtension SplFileInfo::getExtension
11 phar DirectoryIterator::getFilename SplFileInfo::getFilename
12 phar Phar::getPath SplFileInfo::getPath
13 phar Phar::isWritable SplFileInfo::isWritable
14 phar DirectoryIterator::__toString SplFileInfo::__toString
15 phardata RecursiveDirectoryIterator::key FilesystemIterator::key
16 phardata RecursiveDirectoryIterator::next FilesystemIterator::next
17 phardata RecursiveDirectoryIterator::rewind FilesystemIterator::rewind
18 phardata FilesystemIterator::current DirectoryIterator::current
19 phardata RecursiveDirectoryIterator::key DirectoryIterator::key
20 phardata RecursiveDirectoryIterator::next DirectoryIterator::next
21 phardata RecursiveDirectoryIterator::rewind DirectoryIterator::rewind
22 phardata DirectoryIterator::getBasename SplFileInfo::getBasename
23 phardata DirectoryIterator::getExtension SplFileInfo::getExtension
24 phardata DirectoryIterator::getFilename SplFileInfo::getFilename
25 phardata PharData::isWritable SplFileInfo::isWritable
26 phardata DirectoryIterator::__toString SplFileInfo::__toString
27 mongodb-bson-persistable MongoDB\BSON\Persistable::bsonSerialize MongoDB\BSON\Serializable::bsonSerialize
28 splmaxheap SplMaxHeap::compare SplHeap::compare
29 splminheap SplMinHeap::compare SplHeap::compare
30 appenditerator AppendIterator::current IteratorIterator::current
31 appenditerator AppendIterator::key IteratorIterator::key
32 appenditerator AppendIterator::next IteratorIterator::next
33 appenditerator AppendIterator::rewind IteratorIterator::rewind
34 appenditerator AppendIterator::valid IteratorIterator::valid
35 cachingiterator CachingIterator::current IteratorIterator::current
36 cachingiterator CachingIterator::key IteratorIterator::key
37 cachingiterator CachingIterator::next IteratorIterator::next
38 cachingiterator CachingIterator::rewind IteratorIterator::rewind
39 cachingiterator CachingIterator::valid IteratorIterator::valid
40 callbackfilteriterator CallbackFilterIterator::accept FilterIterator::accept
41 callbackfilteriterator FilterIterator::current IteratorIterator::current
42 callbackfilteriterator FilterIterator::key IteratorIterator::key
43 callbackfilteriterator FilterIterator::next IteratorIterator::next
44 callbackfilteriterator FilterIterator::rewind IteratorIterator::rewind
45 callbackfilteriterator FilterIterator::valid IteratorIterator::valid
46 directoryiterator DirectoryIterator::getBasename SplFileInfo::getBasename
47 directoryiterator DirectoryIterator::getExtension SplFileInfo::getExtension
48 directoryiterator DirectoryIterator::getFilename SplFileInfo::getFilename
49 directoryiterator DirectoryIterator::__toString SplFileInfo::__toString
50 filesystemiterator FilesystemIterator::current DirectoryIterator::current
51 filesystemiterator FilesystemIterator::key DirectoryIterator::key
52 filesystemiterator FilesystemIterator::next DirectoryIterator::next
53 filesystemiterator FilesystemIterator::rewind DirectoryIterator::rewind
54 filesystemiterator DirectoryIterator::getBasename SplFileInfo::getBasename
55 filesystemiterator DirectoryIterator::getExtension SplFileInfo::getExtension
56 filesystemiterator DirectoryIterator::getFilename SplFileInfo::getFilename
57 filesystemiterator DirectoryIterator::__toString SplFileInfo::__toString
58 filteriterator FilterIterator::current IteratorIterator::current
59 filteriterator FilterIterator::key IteratorIterator::key
60 filteriterator FilterIterator::next IteratorIterator::next
61 filteriterator FilterIterator::rewind IteratorIterator::rewind
62 filteriterator FilterIterator::valid IteratorIterator::valid
63 globiterator FilesystemIterator::current DirectoryIterator::current
64 globiterator FilesystemIterator::key DirectoryIterator::key
65 globiterator FilesystemIterator::next DirectoryIterator::next
66 globiterator FilesystemIterator::rewind DirectoryIterator::rewind
67 globiterator DirectoryIterator::getBasename SplFileInfo::getBasename
68 globiterator DirectoryIterator::getExtension SplFileInfo::getExtension
69 globiterator DirectoryIterator::getFilename SplFileInfo::getFilename
70 globiterator DirectoryIterator::__toString SplFileInfo::__toString
71 infiniteiterator InfiniteIterator::next IteratorIterator::next
72 limititerator LimitIterator::current IteratorIterator::current
73 limititerator LimitIterator::key IteratorIterator::key
74 limititerator LimitIterator::next IteratorIterator::next
75 limititerator LimitIterator::rewind IteratorIterator::rewind
76 limititerator LimitIterator::valid IteratorIterator::valid
77 norewinditerator NoRewindIterator::current IteratorIterator::current
78 norewinditerator NoRewindIterator::key IteratorIterator::key
79 norewinditerator NoRewindIterator::next IteratorIterator::next
80 norewinditerator NoRewindIterator::rewind IteratorIterator::rewind
81 norewinditerator NoRewindIterator::valid IteratorIterator::valid
82 parentiterator ParentIterator::getChildren RecursiveFilterIterator::getChildren
83 parentiterator ParentIterator::hasChildren RecursiveFilterIterator::hasChildren
84 parentiterator ParentIterator::accept FilterIterator::accept
85 parentiterator ParentIterator::next FilterIterator::next
86 parentiterator ParentIterator::rewind FilterIterator::rewind
87 parentiterator FilterIterator::current IteratorIterator::current
88 parentiterator FilterIterator::key IteratorIterator::key
89 parentiterator ParentIterator::next IteratorIterator::next
90 parentiterator ParentIterator::rewind IteratorIterator::rewind
91 parentiterator FilterIterator::valid IteratorIterator::valid
92 recursivecachingiterator CachingIterator::current IteratorIterator::current
93 recursivecachingiterator CachingIterator::key IteratorIterator::key
94 recursivecachingiterator CachingIterator::next IteratorIterator::next
95 recursivecachingiterator CachingIterator::rewind IteratorIterator::rewind
96 recursivecachingiterator CachingIterator::valid IteratorIterator::valid
97 recursivecallbackfilteriterator CallbackFilterIterator::accept FilterIterator::accept
98 recursivecallbackfilteriterator FilterIterator::current IteratorIterator::current
99 recursivecallbackfilteriterator FilterIterator::key IteratorIterator::key
100 recursivecallbackfilteriterator FilterIterator::next IteratorIterator::next
101 recursivecallbackfilteriterator FilterIterator::rewind IteratorIterator::rewind
102 recursivecallbackfilteriterator FilterIterator::valid IteratorIterator::valid
103 recursivedirectoryiterator RecursiveDirectoryIterator::key FilesystemIterator::key
104 recursivedirectoryiterator RecursiveDirectoryIterator::next FilesystemIterator::next
105 recursivedirectoryiterator RecursiveDirectoryIterator::rewind FilesystemIterator::rewind
106 recursivedirectoryiterator FilesystemIterator::current DirectoryIterator::current
107 recursivedirectoryiterator RecursiveDirectoryIterator::key DirectoryIterator::key
108 recursivedirectoryiterator RecursiveDirectoryIterator::next DirectoryIterator::next
109 recursivedirectoryiterator RecursiveDirectoryIterator::rewind DirectoryIterator::rewind
110 recursivedirectoryiterator DirectoryIterator::getBasename SplFileInfo::getBasename
111 recursivedirectoryiterator DirectoryIterator::getExtension SplFileInfo::getExtension
112 recursivedirectoryiterator DirectoryIterator::getFilename SplFileInfo::getFilename
113 recursivedirectoryiterator DirectoryIterator::__toString SplFileInfo::__toString
114 recursivefilteriterator FilterIterator::current IteratorIterator::current
115 recursivefilteriterator FilterIterator::key IteratorIterator::key
116 recursivefilteriterator FilterIterator::next IteratorIterator::next
117 recursivefilteriterator FilterIterator::rewind IteratorIterator::rewind
118 recursivefilteriterator FilterIterator::valid IteratorIterator::valid
119 recursiveregexiterator RegexIterator::accept FilterIterator::accept
120 recursiveregexiterator FilterIterator::current IteratorIterator::current
121 recursiveregexiterator FilterIterator::key IteratorIterator::key
122 recursiveregexiterator FilterIterator::next IteratorIterator::next
123 recursiveregexiterator FilterIterator::rewind IteratorIterator::rewind
124 recursiveregexiterator FilterIterator::valid IteratorIterator::valid
125 recursivetreeiterator RecursiveTreeIterator::beginChildren RecursiveIteratorIterator::beginChildren
126 recursivetreeiterator RecursiveTreeIterator::beginIteration RecursiveIteratorIterator::beginIteration
127 recursivetreeiterator RecursiveTreeIterator::callGetChildren RecursiveIteratorIterator::callGetChildren
128 recursivetreeiterator RecursiveTreeIterator::callHasChildren RecursiveIteratorIterator::callHasChildren
129 recursivetreeiterator RecursiveTreeIterator::current RecursiveIteratorIterator::current
130 recursivetreeiterator RecursiveTreeIterator::endChildren RecursiveIteratorIterator::endChildren
131 recursivetreeiterator RecursiveTreeIterator::endIteration RecursiveIteratorIterator::endIteration
132 recursivetreeiterator RecursiveTreeIterator::key RecursiveIteratorIterator::key
133 recursivetreeiterator RecursiveTreeIterator::next RecursiveIteratorIterator::next
134 recursivetreeiterator RecursiveTreeIterator::nextElement RecursiveIteratorIterator::nextElement
135 recursivetreeiterator RecursiveTreeIterator::rewind RecursiveIteratorIterator::rewind
136 recursivetreeiterator RecursiveTreeIterator::valid RecursiveIteratorIterator::valid
137 regexiterator RegexIterator::accept FilterIterator::accept
138 regexiterator FilterIterator::current IteratorIterator::current
139 regexiterator FilterIterator::key IteratorIterator::key
140 regexiterator FilterIterator::next IteratorIterator::next
141 regexiterator FilterIterator::rewind IteratorIterator::rewind
142 regexiterator FilterIterator::valid IteratorIterator::valid
143 splfileobject SplFileObject::__toString SplFileInfo::__toString
144 spltempfileobject SplFileObject::__toString SplFileInfo::__toString
145 swoole-http-server Swoole\Http\Server::on Swoole\Server::on
146 swoole-http-server Swoole\Http\Server::start Swoole\Server::start
147 swoole-redis-server Swoole\Redis\Server::start Swoole\Server::start
148 swoole-websocket-server Swoole\WebSocket\Server::on Swoole\Http\Server::on
149 yaf-config-ini Yaf_Config_Ini::get Yaf_Config_Abstract::get
150 yaf-config-ini Yaf_Config_Ini::readonly Yaf_Config_Abstract::readonly
151 yaf-config-ini Yaf_Config_Ini::set Yaf_Config_Abstract::set
152 yaf-config-ini Yaf_Config_Ini::toArray Yaf_Config_Abstract::toArray
153 yaf-config-simple Yaf_Config_Simple::get Yaf_Config_Abstract::get
154 yaf-config-simple Yaf_Config_Simple::readonly Yaf_Config_Abstract::readonly
155 yaf-config-simple Yaf_Config_Simple::set Yaf_Config_Abstract::set
156 yaf-config-simple Yaf_Config_Simple::toArray Yaf_Config_Abstract::toArray
157 yaf-route-regex Yaf_Route_Regex::assemble Yaf_Route_Interface::assemble
158 yaf-route-regex Yaf_Route_Regex::route Yaf_Route_Interface::route
159 yaf-route-rewrite Yaf_Route_Rewrite::assemble Yaf_Route_Interface::assemble
160 yaf-route-rewrite Yaf_Route_Rewrite::route Yaf_Route_Interface::route
161 yaf-exception Yaf_Exception::getPrevious Exception::getPrevious
162 solrpingresponse SolrPingResponse::getResponse SolrResponse::getResponse
163 solrquery SolrQuery::__construct SolrModifiableParams::__construct
164 solrquery SolrQuery::__destruct SolrModifiableParams::__destruct
165 solrclientexception SolrClientException::getInternalInfo SolrException::getInternalInfo
166 solrserverexception SolrServerException::getInternalInfo SolrException::getInternalInfo
167 solrillegalargumentexception SolrIllegalArgumentException::getInternalInfo SolrException::getInternalInfo
168 solrillegaloperationexception SolrIllegalOperationException::getInternalInfo SolrException::getInternalInfo
169 commonmark-node-codeblock CommonMark\Node\Text::__construct CommonMark\Node\CodeBlock::__construct
170 reflectionenumunitcase ReflectionEnumUnitCase::getValue ReflectionClassConstant::getValue
171 reflectionenumbackedcase ReflectionEnumUnitCase::getValue ReflectionClassConstant::getValue
172 reflectionfunction ReflectionFunction::__toString ReflectionFunctionAbstract::__toString
173 reflectionmethod ReflectionMethod::__toString ReflectionFunctionAbstract::__toString
174 soapfault SoapFault::__toString Exception::__toString
175 xmldiff-dom XMLDiff\DOM::diff XMLDiff\Base::diff
176 xmldiff-dom XMLDiff\DOM::merge XMLDiff\Base::merge
177 xmldiff-memory XMLDiff\Memory::diff XMLDiff\Base::diff
178 xmldiff-memory XMLDiff\Memory::merge XMLDiff\Base::merge
179 xmldiff-file XMLDiff\File::diff XMLDiff\Base::diff
180 xmldiff-file XMLDiff\File::merge XMLDiff\Base::merge

Overloads kept (88 extra signatures)

Synopsis Method Signatures
componere-definition Componere\Definition::__construct 4
componere-patch Componere\Patch::__construct 2
yac Yac::add 2
yac Yac::set 2
pdo PDO::query 4
pdostatement PDOStatement::fetchAll 4
pdostatement PDOStatement::setFetchMode 4
pdo-dblib PDO::query 4
pdo-firebird PDO::query 4
pdo-mysql PDO::query 4
pdo-odbc PDO::query 4
pdo-pgsql PDO::query 4
pdo-sqlite PDO::query 4
dateperiod DatePeriod::__construct 3
intlcalendar IntlCalendar::set 2
intlgregoriancalendar IntlGregorianCalendar::__construct 3
intlgregoriancalendar IntlCalendar::set 2
parallel-runtime parallel\Runtime::__construct 2
parallel-runtime parallel\Runtime::run 2
parallel-channel parallel\Channel::__construct 2
parallel-channel parallel\Channel::make 2
parallel-sync parallel\Sync::__construct 2
eventbuffer EventBuffer::read 2
eventhttprequest EventHttpRequest::closeConnection 2
commonmark-node-heading CommonMark\Node\Heading::__construct 2
commonmark-node-bulletlist CommonMark\Node\BulletList::__construct 3
commonmark-node-orderedlist CommonMark\Node\OrderedList::__construct 4
commonmark-node-text CommonMark\Node\Text::__construct 2
commonmark-node-code CommonMark\Node\Text::__construct 2
commonmark-node-codeblock CommonMark\Node\Text::__construct 2
commonmark-node-htmlblock CommonMark\Node\Text::__construct 2
commonmark-node-htmlinline CommonMark\Node\Text::__construct 2
commonmark-node-image CommonMark\Node\Image::__construct 3
commonmark-node-link CommonMark\Node\Link::__construct 3
parle-rlexer Parle\RLexer::push 3
reflectionmethod ReflectionMethod::__construct 2
xmlreader XMLReader::open 2
xmlreader XMLReader::XML 2
xsltprocessor XSLTProcessor::setParameter 2
ui-point UI\Point::at 2
ui-size UI\Size::of 2
ui-executor UI\Executor::__construct 3
ui-executor UI\Executor::setInterval 2
ui-controls-colorbutton UI\Controls\ColorButton::setColor 2
ui-draw-pen UI\Draw\Pen::fill 3
ui-draw-pen UI\Draw\Pen::stroke 3
ui-draw-color UI\Draw\Color::__construct 2
ui-draw-brush UI\Draw\Brush::__construct 2
ui-draw-brush UI\Draw\Brush::setColor 2
ui-draw-brush-gradient UI\Draw\Brush\Gradient::addStop 2
ui-draw-brush-gradient UI\Draw\Brush\Gradient::setStop 2
ui-draw-brush-gradient UI\Draw\Brush::setColor 2
ui-draw-brush-lineargradient UI\Draw\Brush\Gradient::addStop 2
ui-draw-brush-lineargradient UI\Draw\Brush\Gradient::setStop 2
ui-draw-brush-radialgradient UI\Draw\Brush\Gradient::addStop 2
ui-draw-brush-radialgradient UI\Draw\Brush\Gradient::setStop 2
ui-draw-text-layout UI\Draw\Text\Layout::setColor 2

@vrana

vrana commented Oct 23, 2026

Copy link
Copy Markdown
Contributor Author

The PL build failure is unrelated and I'm fixing it in php/doc-pl#38.

@vrana
vrana force-pushed the remove-overridden-methods branch from c5ea4e0 to abfe2ee Compare October 23, 2026 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alfsb alfsb Awaiting requested review from alfsb

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@vrana