classScope

packages/sql-catalog/src/Reporter/Html/Scope.php:18

final class Scope

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Where in the program a statement is issued, read out of the enclosing function's name.

The catalog writes the enclosing function as Class::method, function or {main}. The report needs the pieces: the namespace to group by, the class to write a page for, and the member to head a section with. Reading them once here is what keeps every page addressing the same code the same way.

Constants§

public const MAIN = '{main}'

source §

The name the catalog gives to code outside any function.

Properties§

public string $namespace

source §

public string|null $class

source §

public string $member

source §

Methods§

public function __construct(
    public string $namespace,
    public string|null $class,
    public string $member,
)

source §

Parameters

`$namespace`	`string`	The namespace, empty for the global one
`$class`	`string\|null`	The fully qualified class, or null outside a class
`$member`	`string`	The method, function or `{main}`

public static function of(string $function): self

source §

The scope an enclosing function's name stands for.

Parameters

$function string

Returns

self

Test cases 7

Called from 25

Calls 5

function-call ltrim line 42
function-call strpos line 43
function-call substr line 45
function-call strrpos line 46
new self line 48

public function isMain(): bool

source §

Whether the statement is issued outside any function.

Returns

bool

Called from 1

method-call SqlCatalog\Reporter\Html\Scope::display() packages/sql-catalog/src/Reporter/Html/Scope.php:101

Calls 1

class-const Scope::MAIN() line 60

public function isMethod(): bool

source §

Whether the statement is issued from a method.

Returns

bool

public function classShort(): ?string

source §

The class without its namespace, or null outside a class.

Returns

?string

Called from 1

method-call SqlCatalog\Reporter\Html\Scope::display() packages/sql-catalog/src/Reporter/Html/Scope.php:105

Calls 2

function-call strrpos line 79
function-call substr line 81

public function function(): string

source §

The function written the way the catalog writes it.

Returns

string

public function display(): string

source §

The function written for a reader, without the namespace.

Returns

string

Calls 2

method-call Scope::isMain() line 101
method-call Scope::classShort() line 105

public function namespaceLabel(): string

source §

The namespace written for a reader.

Returns

string

Test cases 26§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 7

Other tests reaching this symbol 19

Relations§

Static calls 25