Skip to content

Add phpstan type to profiler #144

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

Merged
tyrsson merged 3 commits into from
Mar 28, 2026
Merged

Add phpstan type to profiler #144

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
593541c
Adds two phpstan types to cover the shape of $profile and $profiles.
tyrsson Mar 27, 2026
6562496
Add missing use for ParameterContainer
tyrsson Mar 27, 2026
e52bd6d
Flips those since is_string should be faster than instanceof
tyrsson Mar 28, 2026
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
29 changes: 20 additions & 9 deletions src/Adapter/Profiler/Profiler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,26 @@

use PhpDb\Adapter\Exception;
use PhpDb\Adapter\Exception\InvalidArgumentException;
use PhpDb\Adapter\ParameterContainer;
use PhpDb\Adapter\StatementContainerInterface;

use function end;
use function is_string;
use function microtime;

/**
* @phpstan-type ProfileShape array{
* sql: string,
* parameters: ParameterContainer|null,
* start: float,
* end: float|null,
* elapse: float|null,
* }
* @phpstan-type ProfilesShape ProfileShape[]
*/
class Profiler implements ProfilerInterface
{
/** @var array */
/** @var ProfilesShape */
protected $profiles = [];

/** @var int */
Expand All @@ -33,18 +44,15 @@ public function profilerStart(string|StatementContainerInterface $target): Profi
'end' => null,
'elapse' => null,
];
if ($target instanceof StatementContainerInterface) {

if (is_string($target)) {
$profileInformation['sql'] = $target;
} else {
$profileInformation['sql'] = $target->getSql();
$container = $target->getParameterContainer();
if ($container !== null) {
$profileInformation['parameters'] = clone $container;
}
} elseif (is_string($target)) {
$profileInformation['sql'] = $target;
} else {
throw new Exception\InvalidArgumentException(
__FUNCTION__ . ' takes either a StatementContainer or a string'
);
}

$this->profiles[$this->currentIndex] = $profileInformation;
Expand All @@ -70,13 +78,16 @@ public function profilerFinish(): ProfilerInterface
}

/**
* @return array|null
* @return ProfileShape|null
*/
public function getLastProfile(): ?array
{
return end($this->profiles);
}

/**
* @return ProfilesShape
*/
public function getProfiles(): array
{
return $this->profiles;
Expand Down