Skip to content

Commit ac46ffe

Browse files
authored
Use PHPStan-specific annotations when using PHPStan alias types (#60)
1 parent 8bee0da commit ac46ffe

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

src/WebdriverClassicDriver.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,23 +84,23 @@ class WebdriverClassicDriver extends CoreDriver
8484
private DesiredCapabilities $desiredCapabilities;
8585

8686
/**
87-
* @var TTimeouts
87+
* @phpstan-var TTimeouts
8888
*/
8989
private array $timeouts = [];
9090

9191
private string $webDriverHost;
9292

9393
/**
94-
* @var TWebDriverInstantiator
94+
* @phpstan-var TWebDriverInstantiator
9595
*/
9696
private $webDriverInstantiator;
9797

9898
private ?string $initialWindowHandle = null;
9999

100100
/**
101101
* @param string $browserName One of 'edge', 'firefox', 'chrome' or any one of {@see WebDriverBrowserType} constants.
102-
* @param TCapabilities $desiredCapabilities
103-
* @param TWebDriverInstantiator|null $webDriverInstantiator
102+
* @phpstan-param TCapabilities $desiredCapabilities
103+
* @phpstan-param TWebDriverInstantiator|null $webDriverInstantiator
104104
*/
105105
public function __construct(
106106
string $browserName = self::DEFAULT_BROWSER,
@@ -350,7 +350,7 @@ public function getAttribute(
350350

351351
/**
352352
* {@inheritdoc}
353-
* @return TElementValue
353+
* @phpstan-return TElementValue
354354
*/
355355
public function getValue(
356356
#[Language('XPath')]
@@ -394,7 +394,7 @@ public function getValue(
394394

395395
/**
396396
* {@inheritdoc}
397-
* @param TElementValue $value
397+
* @phpstan-param TElementValue $value
398398
*/
399399
public function setValue(
400400
#[Language('XPath')]
@@ -759,7 +759,7 @@ public function getWebDriverSessionId(): ?string
759759
/**
760760
* Sets the timeouts to apply to the webdriver session
761761
*
762-
* @param TTimeouts $timeouts The session timeout settings: Array of {script, implicit, page} => time in milliseconds
762+
* @phpstan-param TTimeouts $timeouts The session timeout settings: Array of {script, implicit, page} => time in milliseconds
763763
* @throws DriverException
764764
* @api
765765
*/
@@ -817,7 +817,7 @@ private function getNormalisedBrowserName(): string
817817
/**
818818
* Detect and assign appropriate browser capabilities
819819
*
820-
* @param TCapabilities $desiredCapabilities
820+
* @phpstan-param TCapabilities $desiredCapabilities
821821
*
822822
* @see https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
823823
*/

tests/Custom/CapabilityTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ class CapabilityTest extends \PHPUnit\Framework\TestCase
1313
use WebDriverMockingTrait;
1414

1515
/**
16-
* @param TCapabilities $desiredCapabilities
17-
* @param TCapabilities $expectedCapabilities
16+
* @phpstan-param TCapabilities $desiredCapabilities
17+
* @phpstan-param TCapabilities $expectedCapabilities
1818
*
1919
* @dataProvider capabilitiesDataProvider
2020
*/
@@ -39,7 +39,7 @@ function ($host, $capabilities) use (&$actualCapabilities, $mockWebDriver) {
3939
}
4040

4141
/**
42-
* @return iterable<string, array{browserName: string, desiredCapabilities: TCapabilities, expectedCapabilities: TCapabilities}>
42+
* @phpstan-return iterable<string, array{browserName: string, desiredCapabilities: TCapabilities, expectedCapabilities: TCapabilities}>
4343
*/
4444
public static function capabilitiesDataProvider(): iterable
4545
{

0 commit comments

Comments
 (0)