classNamespacePage
final class NamespacePage
Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.
Every namespace, with the classes and functions under it that issue statements.
Code is organised by namespace and class, so that is how a reader looking for the SQL behind a piece of code looks for it. A class leads to its own page; a function to the file it is written in, since a function has no page of its own; and a namespace to the whole of what it issues.
Methods§
public function __construct(?HtmlText $text = null)public function render(ReportSite $site): stringThe body of the namespaces listing.
Parameters
$site | ReportSite |
Returns
stringTest cases 2
Called from 1
Calls 4
- method-call ReportSite::index() line 39
- method-call NamespacePage::section() line 45
- method-call HtmlText::count() line 48
- function-call
countline 48
public function section(
ReportSite $site,
string $namespace,
list<CatalogEntry> $entries,
): stringOne namespace, with everything declared in it that issues statements.
Parameters
$site | ReportSite | |
$namespace | string | |
$entries | list<CatalogEntry> |
Returns
stringCalled from 1
Calls 14
- method-call ReportSite::index() line 62
- method-call NamespacePage::members() line 64
- static-call Scope::of() line 65
- method-call ReportSite::classPage() line 68
- class-const ReportSite::STATEMENTS() line 69
- function-call
rawurlencodeline 69 - method-call ReportSite::functionUrl() line 70
- method-call HtmlText::link() line 71
- method-call ReportSite::filePage() line 73
- method-call HtmlText::number() line 74
- function-call
countline 74 - method-call HtmlText::escape() line 80
- method-call HtmlText::slug() line 80
- method-call HtmlText::count() line 81
public function members(list<CatalogEntry> $entries): array<string, list<CatalogEntry>>The statements under each class or free function among a set, classes first.
Parameters
$entries | list<CatalogEntry> |
Returns
array<string, list<CatalogEntry>>Test cases 2
Called from 1
Calls 2
- static-call Scope::of() line 99
- function-call
ksortline 106
public function anchors(ReportSite $site): list<array{string, string}>The sections of the page, for the navigation.
Parameters
$site | ReportSite |
Returns
list<array{string, string}>Test cases 1
Called from 1
Calls 4
- function-call
array_keysline 120 - method-call ReportSite::index() line 120
- static-call Scope::of() line 121
- method-call HtmlText::slug() line 122
Private surface 1§
Implementation details, listed for orientation only.
private HtmlText $textTest cases 8§
Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.
Dedicated tests 6
NamespacePageTest::testAnchorsNameEveryNamespacecallsNamespacePageTest::testMembersListClassesBeforeFunctionscallsNamespacePageTest::testMembersOrderNamesWithoutRegardToCasecallsNamespacePageTest::testRenderIsWrittenExactlycallsNamespacePageTest::testRenderListsEveryNamespaceWithWhatIsDeclaredInItcallsNamespacePageTest::testSectionLeadsFromAClassToItsPageAndFromAFunctionToItsFilecalls
Other tests reaching this symbol 2
ReporterInterfaceTestcallsHtmlReporterTestcalls