Skip to content

Add inheritance of constants #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mspirkov wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add inheritance of constants #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe2fc37
Add inheritance of constants
mspirkov Dec 19, 2025
614494a
Run checks
mspirkov Dec 19, 2025
1c441df
Run checks
mspirkov Dec 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ Yii Framework 2 apidoc extension Change Log
- Enh #347: Add PHPDoc types for class properties (mspirkov)
- Enh #348: Inherit descriptions of the parent class (mspirkov)
- Enh #349: Add support for constants in interfaces and traits (mspirkov)
- Enh #349: Add inheritance of constants in interfaces (mspirkov)
- Enh #349: Add inheritance of trait constants in classes (mspirkov)
- Enh #261: Add inheritance of interface constants in classes (mspirkov)


3.0.8 November 24, 2025
Expand Down
52 changes: 37 additions & 15 deletions models/Context.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,21 +146,7 @@ public function updateReferences()
}
// update implementedBy and usedBy for interfaces
foreach ($this->classes as $class) {
foreach ($class->interfaces as $interface) {
if (!isset($this->interfaces[$interface])) {
continue;
}
$this->interfaces[$interface]->implementedBy[] = $class->name;
if (!$class->isAbstract) {
continue;
}
// add not implemented interface methods
foreach ($this->interfaces[$interface]->methods as $method) {
if (!isset($class->methods[$method->name])) {
$class->methods[$method->name] = $method;
}
}
}
$this->handleInterfaceInheritance($class);
}
foreach ($this->interfaces as $interface) {
$this->updateSubInterfaceInheritance($interface);
Expand Down Expand Up @@ -228,6 +214,41 @@ protected function handleTraitInheritance($class)
$class->methods[$method->name] = $method;
}
}

foreach ($trait->constants as $constant) {
if (!isset($class->constants[$constant->name])) {
$class->constants[$constant->name] = $constant;
}
}
}
}

/**
* @param ClassDoc $class
*/
private function handleInterfaceInheritance($class)
{
foreach ($class->interfaces as $interface) {
if (!isset($this->interfaces[$interface])) {
continue;
}

$this->interfaces[$interface]->implementedBy[] = $class->name;

foreach ($this->interfaces[$interface]->constants as $constant) {
if (!isset($class->constants[$constant->name])) {
$class->constants[$constant->name] = $constant;
}
}

// add not implemented interface methods
if ($class->isAbstract) {
foreach ($this->interfaces[$interface]->methods as $method) {
if (!isset($class->methods[$method->name])) {
$class->methods[$method->name] = $method;
}
}
}
}
}

Expand Down Expand Up @@ -274,6 +295,7 @@ protected function updateSubInterfaceInheritance($interface)

$subInterface = $this->interfaces[$name];
$subInterface->methods = array_merge($interface->methods, $subInterface->methods);
$subInterface->constants = array_merge($interface->constants, $subInterface->constants);
$this->updateSubInterfaceInheritance($subInterface);
}
}
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__10.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
26 changes: 26 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__11.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down Expand Up @@ -209,13 +211,37 @@ <h2>Constants</h2>
<th>Defined By</th>
</tr>

<tr class="inherited">
<td>FIRST_CONST</td>
<td>'firstConst'</td>
<td>

</td>
<td><a href="yiiunit-apidoc-data-api-db-activequeryinterface.html">yiiunit\apidoc\data\api\db\ActiveQueryInterface</a></td>
</tr>
<tr class="inherited">
<td>SECOND_CONST</td>
<td>'secondConst'</td>
<td>

</td>
<td><a href="yiiunit-apidoc-data-api-db-activequeryinterface.html">yiiunit\apidoc\data\api\db\ActiveQueryInterface</a></td>
</tr>
<tr class="">
<td>SOME_CLASS_CONST</td>
<td>'someClassConst'</td>
<td>

</td>
<td><a href="yiiunit-apidoc-data-api-db-activequery.html">yiiunit\apidoc\data\api\db\ActiveQuery</a></td>
</tr>
<tr class="inherited">
<td>SOME_TRAIT_CONST</td>
<td>'someTraitConst'</td>
<td>

</td>
<td><a href="yiiunit-apidoc-data-api-db-activerelationtrait.html">yiiunit\apidoc\data\api\db\ActiveRelationTrait</a></td>
</tr>
</table>
</div>
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__12.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__13.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__14.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__15.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__16.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__17.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__18.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item active" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__19.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item active" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
2 changes: 2 additions & 0 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__20.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-assetmanager.html">AssetManager</a>
<a class="list-group-item active" href="./yiiunit-apidoc-data-api-web-erroraction.html">ErrorAction</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-someinterface.html">SomeInterface</a>
<a class="list-group-item" href="./yiiunit-apidoc-data-api-web-somesubinterface.html">SomeSubInterface</a>
</div>
</div> </div>
<div class="col-md-9 api-content" role="main">
Expand Down
Loading
Loading