feat: APCu caching driver #9874

sk757a · 2026-01-07T23:15:29Z

Description
This PR enhance the framework's capabilities by adding a new caching driver based on the APCu extension.

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

mergeable · 2026-01-07T23:15:32Z

Hi there, sk757a! 👋

Thank you for sending this PR!

We expect the following in all Pull Requests (PRs).

PRs must be sent to the appropriate branch
All git commits must be GPG-signed
Must follow our style guide
Be commented in the PHP source file
Be documented in the user guide
Be unit tested
Pass all checks in GitHub Actions

Important

We expect all code changes or bug-fixes to be accompanied by one or more tests added to our test suite to prove the code works.

If pull requests do not comply with the above, they will likely be closed. Since we are a team of volunteers, we don't have any more time to work
on the framework than you do. Please make it as painless for your contributions to be included as possible.

See https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/pull_request.md

Sincerely, the mergeable bot 🤖

paulbalandan · 2026-01-08T01:51:02Z

The test failures are due to $this->handler being an instance of DummyHandler. This means the apcu driver's ->isSupported() call in CacheFactory returns false so you may want to debug there why it is not working on Github actions.

sk757a · 2026-01-08T02:12:18Z

The test failures are due to $this->handler being an instance of DummyHandler. This means the apcu driver's ->isSupported() call in CacheFactory returns false so you may want to debug there why it is not working on Github actions.

It seems to me that APCu extension just needs to be installed in the CI environment.

paulbalandan · 2026-01-08T02:45:05Z

It seems to me that APCu extension just needs to be installed in the CI environment.

Please add then in test-phpunit.yml under the extra-extensions parameter of cache-live-tests job.

sk757a · 2026-01-08T03:17:35Z

APCu enabled. Can't get why tests failed.

paulbalandan · 2026-01-08T03:23:25Z

Probably apcu_enabled() returns false?

michalsn · 2026-01-08T06:44:51Z

By default, APCu is disabled in CLI, see: https://www.php.net/manual/en/apcu.configuration.php#ini.apcu.enable-cli

We can use:

ini-values: apc.enable_cli=1

But this should be abstracted, like other options.

datamweb

Thanks!
Please provide full details in the PR description.

system/Cache/Handlers/ApcuHandler.php

user_guide_src/source/libraries/caching.rst

sk757a · 2026-01-08T14:38:09Z

By default, APCu is disabled in CLI, see: https://www.php.net/manual/en/apcu.configuration.php#ini.apcu.enable-cli

This. Forgot about this parameter.

We can use:
ini-values: apc.enable_cli=1
But this should be abstracted, like other options.

Could you elaborate a bit? At first glance, I just wanted to add -d apcu.enable_cli=1 at the end of

CodeIgniter4/.github/workflows/test-phpunit.yml

Line 167 in 12cf2b4

extra-composer-options: ${{ matrix.composer-option }}

michalsn · 2026-01-08T15:00:42Z

I don't think it will have any effect if you add it to the extra-composer-options.

The proper way to add ini settings to setup-php is by ini-values: https://github.com/marketplace/actions/setup-php-action#ini-values-optional

So I think we should have an abstract value, like: extra-ini-options, which will be applied when we setup php:

CodeIgniter4/.github/workflows/reusable-phpunit-test.yml

Lines 160 to 166 in 12cf2b4

    
           - name: Setup PHP 
        
             uses: shivammathur/setup-php@v2 
        
             with: 
        
               php-version: ${{ inputs.php-version }} 
        
               tools: composer 
        
               extensions: gd, ${{ inputs.extra-extensions }} 
        
               coverage: ${{ env.COVERAGE_DRIVER }}

sk757a · 2026-01-08T15:41:42Z

I don't think it will have any effect if you add it to the extra-composer-options.

I was in a hurry and made a mistake. The composer parameters are of course irrelevant. I rather meant something like this
extra-phpunit-options: -d apcu.enable_cli=1

Thanks for the clarification. I'll look into this now.

sk757a · 2026-01-08T22:45:40Z

Time dependent test fail. May be just rerun?

paulbalandan

Can you also add ext-apcu in the suggested extensions in composer.json? Both root composer.json and framework composer.json

paulbalandan · 2026-01-09T08:16:34Z

.github/workflows/reusable-phpunit-test.yml

        description: Additional PHP extensions that are needed to be enabled
        type: string
        required: false
+      extra-ini-options:


This change to this file should go the develop branch in a separate PR as I believe it can be used early.

Do you think we should make similar changes to the reusable-serviceless-phpunit-test.yml file?

Yes, please

paulbalandan · 2026-01-09T08:18:59Z

system/Cache/Handlers/ApcuHandler.php

+    /**
+     * {@inheritDoc}
+     */


I think you can safely remove the inheritdocs tags here.

paulbalandan · 2026-01-09T08:24:15Z

system/Cache/Handlers/ApcuHandler.php

+    /**
+     * {@inheritDoc}
+     */
+    public function increment(string $key, int $offset = 1): bool|int


For here and decrement, you can change the return type to false|int

paulbalandan · 2026-01-09T08:24:48Z

system/Cache/Handlers/ApcuHandler.php

+    /**
+     * {@inheritDoc}
+     */
+    public function getCacheInfo(): array|false|object|null


We can limit the return type to just array|false

paulbalandan · 2026-01-09T08:27:31Z

tests/system/Cache/Handlers/ApcuHandlerTest.php

+        if (! extension_loaded('apcu')) {
+            $this->markTestSkipped('APCu extension not loaded.');
+        }


use a class-level attribute #[\PHPUnit\Framework\Attributes\RequiresPhpExtension('apcu')] instead

sk757a added 2 commits January 8, 2026 03:45

feat: APCu caching driver implementation

4d6b6be

feat: APCu caching driver: changelog, documentation

79942cb

sk757a changed the title ~~APCu caching driver implementation~~ feat: APCu caching driver Jan 7, 2026

sk757a force-pushed the apcucache branch from ca5b98e to 79942cb Compare January 8, 2026 00:02

paulbalandan added enhancement PRs that improve existing functionalities 4.7 labels Jan 8, 2026

datamweb suggested changes Jan 8, 2026

View reviewed changes

system/Cache/Handlers/ApcuHandler.php Outdated Show resolved Hide resolved

user_guide_src/source/libraries/caching.rst Outdated Show resolved Hide resolved

sk757a force-pushed the apcucache branch from 3c1fc0d to 79942cb Compare January 8, 2026 21:34

sk757a added 4 commits January 9, 2026 02:47

feat: APCu caching driver: keys iterator improvement, fixes

9770d8d

feat: APCu caching driver: header fix

cbb69b9

feat: APCu caching driver: phpunit workflow extra-ini-options

f26b2ce

feat: APCu caching driver: phpunit workflow APCu extension

aef434f

paulbalandan reviewed Jan 9, 2026

View reviewed changes

sk757a requested a review from datamweb January 9, 2026 11:18

feat: APCu caching driver #9874

Are you sure you want to change the base?

feat: APCu caching driver #9874

Conversation

sk757a commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mergeable bot commented Jan 7, 2026

Uh oh!

paulbalandan commented Jan 8, 2026

Uh oh!

sk757a commented Jan 8, 2026

Uh oh!

paulbalandan commented Jan 8, 2026

Uh oh!

sk757a commented Jan 8, 2026

Uh oh!

paulbalandan commented Jan 8, 2026

Uh oh!

michalsn commented Jan 8, 2026

Uh oh!

datamweb left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sk757a commented Jan 8, 2026

Uh oh!

michalsn commented Jan 8, 2026

Uh oh!

sk757a commented Jan 8, 2026

Uh oh!

sk757a commented Jan 8, 2026

Uh oh!

paulbalandan left a comment

Choose a reason for hiding this comment

Uh oh!

paulbalandan Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

sk757a Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

paulbalandan Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

paulbalandan Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

paulbalandan Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

paulbalandan Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

paulbalandan Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sk757a commented Jan 7, 2026 •

edited

Loading

datamweb left a comment •

edited

Loading