Skip to content

Commit c1f8c02

Browse files
committed
improved phpDoc
1 parent c9cae3e commit c1f8c02

13 files changed

Lines changed: 40 additions & 3 deletions

File tree

src/Application/Helpers.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public static function splitName(string $name): array
3434

3535

3636
/**
37-
* return string[]
37+
* @return array<string, class-string>
3838
*/
3939
public static function getClassesAndTraits(string $class): array
4040
{

src/Application/Routers/CliRouter.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ final class CliRouter implements Nette\Routing\Router
2222

2323

2424
public function __construct(
25+
/** @var array<string, mixed> */
2526
private readonly array $defaults = [],
2627
) {
2728
}
@@ -99,6 +100,7 @@ public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?stri
99100

100101
/**
101102
* Returns default values.
103+
* @return array<string, mixed>
102104
*/
103105
public function getDefaults(): array
104106
{

src/Application/Routers/Route.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ public function match(Nette\Http\IRequest $httpRequest): ?array
9898

9999
/**
100100
* Constructs absolute URL from array.
101+
* @param array<string, mixed> $params
101102
*/
102103
public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?string
103104
{
@@ -121,7 +122,10 @@ public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?stri
121122
}
122123

123124

124-
/** @internal */
125+
/**
126+
* @return array<string, mixed>
127+
* @internal
128+
*/
125129
public function getConstantParameters(): array
126130
{
127131
$res = parent::getConstantParameters();

src/Application/Routers/RouteList.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ public function __construct(?string $module = null)
3333

3434
/**
3535
* Support for modules.
36+
* @param array<string, mixed> $params
37+
* @return array<string, mixed>|null
3638
*/
3739
protected function completeParameters(array $params): ?array
3840
{
@@ -47,6 +49,7 @@ protected function completeParameters(array $params): ?array
4749

4850
/**
4951
* Constructs absolute URL from array.
52+
* @param array<string, mixed> $params
5053
*/
5154
public function constructUrl(array $params, Nette\Http\UrlScript $refUrl): ?string
5255
{

src/Application/UI/AccessPolicy.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ private function getAttributes(): array
6363

6464

6565
/**
66-
* @param Requires[] $attrs
66+
* @param Attributes\Requires[] $attrs
67+
* @return Attributes\Requires[]
6768
*/
6869
private function applyInternalRules(array $attrs, Component $component): array
6970
{

src/Application/UI/Component.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ abstract class Component extends Nette\ComponentModel\Container implements Signa
2929

3030
/** @var array<callable(self): void> Occurs when component is attached to presenter */
3131
public array $onAnchor = [];
32+
33+
/** @var array<string, mixed> */
3234
protected array $params = [];
3335

3436

@@ -99,6 +101,7 @@ protected function validateParent(Nette\ComponentModel\IContainer $parent): void
99101

100102
/**
101103
* Calls public method if exists.
104+
* @param array<string, mixed> $params
102105
*/
103106
protected function tryCall(string $method, array $params): bool
104107
{
@@ -146,6 +149,7 @@ public static function getReflection(): ComponentReflection
146149

147150
/**
148151
* Loads state information.
152+
* @param array<string, mixed> $params
149153
*/
150154
public function loadState(array $params): void
151155
{
@@ -174,6 +178,7 @@ public function loadState(array $params): void
174178

175179
/**
176180
* Saves state information for next request.
181+
* @param array<string, mixed> $params
177182
*/
178183
public function saveState(array &$params): void
179184
{
@@ -235,6 +240,7 @@ final public function getParameter(string $name): mixed
235240

236241
/**
237242
* Returns component parameters.
243+
* @return array<string, mixed>
238244
*/
239245
final public function getParameters(): array
240246
{

src/Application/UI/ComponentReflection.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,9 @@ public function getPersistentComponents(): array
115115
}
116116

117117

118+
/**
119+
* @return string[] names of public properties with #[TemplateVariable] attribute
120+
*/
118121
public function getTemplateVariables(Control $control): array
119122
{
120123
$res = [];

src/Application/UI/Link.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ final class Link
1919
public function __construct(
2020
private readonly Component $component,
2121
private readonly string $destination,
22+
/** @var array<string, mixed> */
2223
private array $params = [],
2324
) {
2425
}
@@ -63,6 +64,7 @@ public function getParameter(string $key): mixed
6364

6465
/**
6566
* Returns link parameters.
67+
* @return array<string, mixed>
6668
*/
6769
public function getParameters(): array
6870
{

src/Application/UI/ParameterConverter.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ final class ParameterConverter
2424

2525
/**
2626
* @param array<string, mixed> $args
27+
* @return mixed[]
2728
*/
2829
public static function toArguments(\ReflectionFunctionAbstract $method, array $args): array
2930
{

src/Application/UI/Presenter.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,11 @@ abstract class Presenter extends Control implements Application\IPresenter
9696
public array $allowedMethods = ['GET', 'POST', 'HEAD', 'PUT', 'DELETE', 'PATCH'];
9797
private ?Nette\Application\Request $request = null;
9898
private ?Nette\Application\Response $response = null;
99+
100+
/** @var array<string, array<string, mixed>> */
99101
private array $globalParams = [];
102+
103+
/** @var array<string, mixed> */
100104
private array $globalState;
101105
private ?array $globalStateSinces;
102106
private string $action = '';
@@ -912,6 +916,7 @@ public static function getPersistentComponents(): array
912916

913917
/**
914918
* Saves state information for all subcomponents to $this->globalState.
919+
* @return array<string, mixed>
915920
*/
916921
public function getGlobalState(?string $forClass = null): array
917922
{
@@ -1061,6 +1066,7 @@ private function initGlobalParameters(): void
10611066

10621067
/**
10631068
* Pops parameters for specified component.
1069+
* @return array<string, mixed>
10641070
* @internal
10651071
*/
10661072
final public function popGlobalParameters(string $id): array

0 commit comments

Comments
 (0)