Skip to content
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

Use PHPStan-specific annotations when using PHPStan alias types #60

Merged
merged 2 commits into from
Jan 7, 2025
Merged

Use PHPStan-specific annotations when using PHPStan alias types #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8517866
Aliased types require phpstan annotations
uuf6429 Jan 6, 2025
f4db0a9
Tiny fix
uuf6429 Jan 6, 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
16 changes: 8 additions & 8 deletions src/WebdriverClassicDriver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,23 +84,23 @@ class WebdriverClassicDriver extends CoreDriver
private DesiredCapabilities $desiredCapabilities;

/**
* @var TTimeouts
* @phpstan-var TTimeouts
*/
private array $timeouts = [];

private string $webDriverHost;

/**
* @var TWebDriverInstantiator
* @phpstan-var TWebDriverInstantiator
*/
private $webDriverInstantiator;

private ?string $initialWindowHandle = null;

/**
* @param string $browserName One of 'edge', 'firefox', 'chrome' or any one of {@see WebDriverBrowserType} constants.
* @param TCapabilities $desiredCapabilities
* @param TWebDriverInstantiator|null $webDriverInstantiator
* @phpstan-param TCapabilities $desiredCapabilities
* @phpstan-param TWebDriverInstantiator|null $webDriverInstantiator
*/
public function __construct(
string $browserName = self::DEFAULT_BROWSER,
Expand Down Expand Up @@ -350,7 +350,7 @@ public function getAttribute(

/**
* {@inheritdoc}
* @return TElementValue
* @phpstan-return TElementValue
*/
public function getValue(
#[Language('XPath')]
Expand Down Expand Up @@ -394,7 +394,7 @@ public function getValue(

/**
* {@inheritdoc}
* @param TElementValue $value
* @phpstan-param TElementValue $value
*/
public function setValue(
#[Language('XPath')]
Expand Down Expand Up @@ -759,7 +759,7 @@ public function getWebDriverSessionId(): ?string
/**
* Sets the timeouts to apply to the webdriver session
*
* @param TTimeouts $timeouts The session timeout settings: Array of {script, implicit, page} => time in milliseconds
* @phpstan-param TTimeouts $timeouts The session timeout settings: Array of {script, implicit, page} => time in milliseconds
* @throws DriverException
* @api
*/
Expand Down Expand Up @@ -817,7 +817,7 @@ private function getNormalisedBrowserName(): string
/**
* Detect and assign appropriate browser capabilities
*
* @param TCapabilities $desiredCapabilities
* @phpstan-param TCapabilities $desiredCapabilities
*
* @see https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
*/
Expand Down
6 changes: 3 additions & 3 deletions tests/Custom/CapabilityTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ class CapabilityTest extends \PHPUnit\Framework\TestCase
use WebDriverMockingTrait;

/**
* @param TCapabilities $desiredCapabilities
* @param TCapabilities $expectedCapabilities
* @phpstan-param TCapabilities $desiredCapabilities
* @phpstan-param TCapabilities $expectedCapabilities
*
* @dataProvider capabilitiesDataProvider
*/
Expand All @@ -39,7 +39,7 @@ function ($host, $capabilities) use (&$actualCapabilities, $mockWebDriver) {
}

/**
* @return iterable<string, array{browserName: string, desiredCapabilities: TCapabilities, expectedCapabilities: TCapabilities}>
* @phpstan-return iterable<string, array{browserName: string, desiredCapabilities: TCapabilities, expectedCapabilities: TCapabilities}>
*/
public static function capabilitiesDataProvider(): iterable
{
Expand Down
Loading