Skip to content

feat: add PHPStan type testing for cache component #972

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
huangdijia merged 2 commits into from
Oct 29, 2025
Merged

feat: add PHPStan type testing for cache component #972

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
53fa697
Initial plan
Copilot Oct 29, 2025
9e00487
feat: add comprehensive type testing for cache component
Copilot Oct 29, 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
96 changes: 96 additions & 0 deletions types/Cache/Facade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<?php

declare(strict_types=1);
/**
* This file is part of friendsofhyperf/components.
*
* @link https://github.com/friendsofhyperf/components
* @document https://github.com/friendsofhyperf/components/blob/main/README.md
* @contact huangdijia@gmail.com
*/
use FriendsOfHyperf\Cache\Contract\Repository;
use FriendsOfHyperf\Cache\Facade\Cache;
use Hyperf\Cache\Driver\DriverInterface;

use function PHPStan\Testing\assertType;

// Cache::store() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', Cache::store());
assertType('FriendsOfHyperf\Cache\Contract\Repository', Cache::store('default'));
assertType('FriendsOfHyperf\Cache\Contract\Repository', Cache::store('redis'));

// Cache::driver() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', Cache::driver());
assertType('FriendsOfHyperf\Cache\Contract\Repository', Cache::driver('default'));

// Cache::resolve() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', Cache::resolve('default'));

// Cache::has() tests
assertType('bool', Cache::has('key'));

// Cache::missing() tests
assertType('bool', Cache::missing('key'));

// Cache::get() tests
assertType('mixed', Cache::get('key'));
assertType('mixed', Cache::get('key', 'default'));
assertType('string', Cache::get('key', 'default'));
assertType('int', Cache::get('key', 123));

// Cache::many() tests
assertType('iterable', Cache::many(['key1', 'key2']));

// Cache::pull() tests
assertType('mixed', Cache::pull('key'));
assertType('mixed', Cache::pull('key', 'default'));
assertType('string', Cache::pull('key', 'default'));

// Cache::put() tests
assertType('bool', Cache::put('key', 'value'));
assertType('bool', Cache::put('key', 'value', 60));
assertType('bool', Cache::put('key', 'value', new DateInterval('PT1H')));
assertType('bool', Cache::put('key', 'value', new DateTime('+1 hour')));

// Cache::putMany() tests
assertType('bool', Cache::putMany(['key1' => 'value1', 'key2' => 'value2']));
assertType('bool', Cache::putMany(['key1' => 'value1'], 60));

// Cache::add() tests
assertType('bool', Cache::add('key', 'value'));
assertType('bool', Cache::add('key', 'value', 60));

// Cache::forever() tests
assertType('bool', Cache::forever('key', 'value'));

// Cache::forget() tests
assertType('bool', Cache::forget('key'));

// Cache::flush() tests
assertType('bool', Cache::flush());

// Cache::increment() tests
assertType('bool|int', Cache::increment('key'));
assertType('bool|int', Cache::increment('key', 5));

// Cache::decrement() tests
assertType('bool|int', Cache::decrement('key'));
assertType('bool|int', Cache::decrement('key', 5));

// Cache::remember() tests
assertType('string', Cache::remember('key', 60, fn () => 'value'));
assertType('int', Cache::remember('key', 60, fn () => 123));
assertType('array', Cache::remember('key', 60, fn () => []));

// Cache::rememberForever() tests
assertType('string', Cache::rememberForever('key', fn () => 'value'));
assertType('int', Cache::rememberForever('key', fn () => 123));

// Cache::sear() tests
assertType('string', Cache::sear('key', fn () => 'value'));
assertType('int', Cache::sear('key', fn () => 123));

// Cache::flexible() tests
assertType('string', Cache::flexible('key', [60, 120], fn () => 'value'));
assertType('int', Cache::flexible('key', [60, 120], fn () => 123));
assertType('array', Cache::flexible('key', [60, 120], fn () => []));
44 changes: 44 additions & 0 deletions types/Cache/Manager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

declare(strict_types=1);
/**
* This file is part of friendsofhyperf/components.
*
* @link https://github.com/friendsofhyperf/components
* @document https://github.com/friendsofhyperf/components/blob/main/README.md
* @contact huangdijia@gmail.com
*/
use FriendsOfHyperf\Cache\CacheManager;
use FriendsOfHyperf\Cache\Contract\Factory;
use FriendsOfHyperf\Cache\Contract\Repository;

use function PHPStan\Testing\assertType;

/** @var CacheManager $manager */
$manager = null;

/** @var Factory $factory */
$factory = null;

// CacheManager::store() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', $manager->store());
assertType('FriendsOfHyperf\Cache\Contract\Repository', $manager->store('default'));
assertType('FriendsOfHyperf\Cache\Contract\Repository', $manager->store('redis'));

// CacheManager::driver() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', $manager->driver());
assertType('FriendsOfHyperf\Cache\Contract\Repository', $manager->driver('default'));

// CacheManager::resolve() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', $manager->resolve('default'));

// Factory::store() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', $factory->store());
assertType('FriendsOfHyperf\Cache\Contract\Repository', $factory->store('default'));

// Factory::driver() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', $factory->driver());
assertType('FriendsOfHyperf\Cache\Contract\Repository', $factory->driver('default'));

// Factory::resolve() tests
assertType('FriendsOfHyperf\Cache\Contract\Repository', $factory->resolve('default'));
117 changes: 117 additions & 0 deletions types/Cache/Repository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<?php

declare(strict_types=1);
/**
* This file is part of friendsofhyperf/components.
*
* @link https://github.com/friendsofhyperf/components
* @document https://github.com/friendsofhyperf/components/blob/main/README.md
* @contact huangdijia@gmail.com
*/
use FriendsOfHyperf\Cache\Contract\Repository;
use FriendsOfHyperf\Cache\Repository as CacheRepository;
use Hyperf\Cache\Driver\DriverInterface;

use function PHPStan\Testing\assertType;

/** @var Repository $repository */
$repository = null;

/** @var CacheRepository $cacheRepository */
$cacheRepository = null;

// Repository::has() tests
assertType('bool', $repository->has('key'));

// Repository::missing() tests
assertType('bool', $repository->missing('key'));

// Repository::get() tests
assertType('mixed', $repository->get('key'));
assertType('mixed', $repository->get('key', 'default'));

// Repository::set() tests
assertType('bool', $repository->set('key', 'value'));
assertType('bool', $repository->set('key', 'value', 60));

// Repository::delete() tests
assertType('bool', $repository->delete('key'));

// Repository::clear() tests
assertType('bool', $repository->clear());

// Repository::many() tests
assertType('iterable', $repository->many(['key1', 'key2']));

// Repository::getMultiple() tests
assertType('iterable', $repository->getMultiple(['key1', 'key2']));
assertType('iterable', $repository->getMultiple(['key1', 'key2'], 'default'));

// Repository::setMultiple() tests
assertType('bool', $repository->setMultiple(['key1' => 'value1', 'key2' => 'value2']));
assertType('bool', $repository->setMultiple(['key1' => 'value1'], 60));

// Repository::deleteMultiple() tests
assertType('bool', $repository->deleteMultiple(['key1', 'key2']));

// Repository::pull() tests
assertType('mixed', $repository->pull('key'));
assertType('mixed', $repository->pull('key', 'default'));

// Repository::put() tests
assertType('bool', $repository->put('key', 'value'));
assertType('bool', $repository->put('key', 'value', 60));
assertType('bool', $repository->put(['key1' => 'value1', 'key2' => 'value2'], 60));

// Repository::putMany() tests
assertType('bool', $repository->putMany(['key1' => 'value1', 'key2' => 'value2']));
assertType('bool', $repository->putMany(['key1' => 'value1'], 60));

// Repository::add() tests
assertType('bool', $repository->add('key', 'value'));
assertType('bool', $repository->add('key', 'value', 60));

// Repository::forever() tests
assertType('bool', $repository->forever('key', 'value'));

// Repository::forget() tests
assertType('bool', $repository->forget('key'));

// Repository::flush() tests
assertType('bool', $repository->flush());

// Repository::increment() tests
assertType('bool|int', $repository->increment('key'));
assertType('bool|int', $repository->increment('key', 5));

// Repository::decrement() tests
assertType('bool|int', $repository->decrement('key'));
assertType('bool|int', $repository->decrement('key', 5));

// Repository::remember() tests
assertType('string', $repository->remember('key', 60, fn () => 'value'));
assertType('int', $repository->remember('key', 60, fn () => 123));
assertType('array', $repository->remember('key', 60, fn () => []));

// Repository::rememberForever() tests
assertType('string', $repository->rememberForever('key', fn () => 'value'));
assertType('int', $repository->rememberForever('key', fn () => 123));

// Repository::sear() tests
assertType('string', $repository->sear('key', fn () => 'value'));
assertType('int', $repository->sear('key', fn () => 123));

// Repository::flexible() tests
assertType('string', $repository->flexible('key', [60, 120], fn () => 'value'));
assertType('int', $repository->flexible('key', [60, 120], fn () => 123));
assertType('array', $repository->flexible('key', [60, 120], fn () => []));

// Repository::getDriver() tests
assertType('Hyperf\Cache\Driver\DriverInterface', $repository->getDriver());

// Repository::getStore() tests
assertType('Hyperf\Cache\Driver\DriverInterface', $repository->getStore());

// CacheRepository specific tests
assertType('Hyperf\Cache\Driver\DriverInterface', $cacheRepository->getDriver());
assertType('Hyperf\Cache\Driver\DriverInterface', $cacheRepository->getStore());