elavora / api-cache-apcu

1.0.0 2026-11-01 02:19 UTC

Requires

• php: >=8.3
• ext-apcu: *
• elavora/api-framework: ^2.0

Requires (Dev)

• elavora/code-standards: ^1.1
• phpstan/phpstan: ^2.2
• phpunit/phpunit: ^10.5 || ^11.0 || ^12.0

MIT

Published on Packagist.org on 2026-11-01 02:19 UTC

README

Adapter opcional de cache APCu para o framework Elavora 2 (elavora/api-framework ^2.0, PHP >=8.3).

O pacote requer a extensão PHP apcu. Em execuções pela CLI, habilite apc.enable_cli=1 quando o cache precisar estar ativo.

Uso pelo ambiente

Com o bootstrap do framework 2, basta instalar o pacote e definir CACHE_DRIVER=apcu. CACHE_PREFIX e CACHE_TTL são opcionais.

Registro manual

Registre ApcuCacheExtension com as opções prefix e ttl. Sem ttl, os itens ficam guardados sem expiração. Use ttl 3600 para reproduzir o tempo padrão da integração APCu antiga.

use Elavora\Api\Extension\CacheApcu\ApcuCacheExtension;

$application->extend(new ApcuCacheExtension([
    'prefix' => 'app:',
    'ttl' => 3600,
]));

O pacote implementa Elavora\Api\Framework\Contracts\CacheStore. Registre somente uma extensão de cache na aplicação, pois os adapters de cache compartilham esse contrato.

Especificação completa, exemplos e regras de TTL: docs/USO.md.

Instalação

composer require elavora/api-cache-apcu

Requisitos: PHP 8.3 ou superior, extensão apcu e elavora/api-framework ^2.0.

Versão 1.0: atualiza o pacote para o elavora/api-framework 2.0, que substitui o ^0.3.1 || ^0.4.0, e sobe o PHP mínimo de 8.1 para 8.3. A API do pacote não muda; quem usa o framework 0.x precisa atualizar junto (veja o guia de migração).

Desenvolvimento e testes

Você só precisa de Docker. O ambiente é a imagem ghcr.io/elavora/php-dev:8.3-latest: abra o repositório no VS Code com Dev Containers: Reopen in Container, ou rode no PowerShell:

docker run --rm --mount "type=bind,source=$($PWD.Path),target=/workspace" -w /workspace ghcr.io/elavora/php-dev:8.3-latest sh -lc 'git config --global --add safe.directory /workspace && composer install --no-interaction --prefer-dist && composer check'

Scripts do Composer:

composer check     # lint, testes e PHPStan
composer test      # testes PHPUnit
composer lint      # sintaxe (elavora-standards lint)
composer analyse   # PHPStan, nível 8

A imagem já traz a extensão apcu e o apc.enable_cli = 1, então os testes rodam sem instalar nada e sem rede (detalhes em Desenvolvimento e testes).

O código segue o padrão PER-CS, com as regras do pacote elavora/code-standards. No devcontainer, o arquivo é formatado ao salvar; no PR, o CI formata o que faltou e commita a correção (style: organiza o código). Os testes rodam no CI, no workflow Qualidade, em todo PR. O passo a passo, o que roda no CI e como reproduzi-lo estão em Desenvolvimento e testes.

Como contribuir

1. Crie uma branch a partir da main (feat/..., fix/... ou docs/...).
2. Faça commits em português do Brasil, no padrão Conventional Commits (feat: ..., fix: ..., docs: ...).
3. Rode composer check antes de abrir o PR.
4. Abra o PR para a main, preencha o template e aplique as labels que definem a versão (Versões e release).
5. Confira o comentário do pipeline de qualidade no PR e só integre com os checks verdes.

Versões

Cada PR integrado na main gera uma versão automaticamente, conforme as labels do PR: sem a label release sai uma beta (1.0.1-beta.1), com ela sai a estável (1.0.1). As tags novas não têm o prefixo v, e as notas de cada GitHub Release são geradas em português a partir dos PRs. Veja Versões e release.

Documentação

1. Guia de uso: a especificação do pacote, com a API pública, as regras de TTL, a configuração e a migração.
2. Desenvolvimento e testes: ambiente, como rodar os testes e o que roda no CI.
3. Automação do repositório: workflows, Dependabot, estilo de código, labels e versões.

Licença

MIT