PHPackages                             yiisoft/cache-file - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/cache-file

ActiveLibrary[Framework](/categories/framework)

yiisoft/cache-file
==================

Yii Caching Library - File Handler

3.2.0(1y ago)13685.3k↓34.9%12[1 issues](https://github.com/yiisoft/cache-file/issues)[1 PRs](https://github.com/yiisoft/cache-file/pulls)9BSD-3-ClausePHPPHP ^8.0CI passing

Since Feb 2Pushed 3mo ago16 watchersCompare

[ Source](https://github.com/yiisoft/cache-file)[ Packagist](https://packagist.org/packages/yiisoft/cache-file)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-cache-file/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (10)Versions (9)Used By (9)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Cache Library - File Handler
================================

[](#yii-cache-library---file-handler)

[![Latest Stable Version](https://camo.githubusercontent.com/e40ed03a17fba51a87a75c310340b9dd5352d52faf2eaf6958c487505326c18c/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f63616368652d66696c652f76)](https://packagist.org/packages/yiisoft/cache-file)[![Total Downloads](https://camo.githubusercontent.com/d39a42fecac4de77c5ca6a8735348bf2f409beed0070190fa586535d60817cc3/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f63616368652d66696c652f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/cache-file)[![Build status](https://github.com/yiisoft/cache-file/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/cache-file/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/426be8eca99c5c2b972f1c7cd5cbccabebb0fa7448658d0af5c458b52055cb31/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f63616368652d66696c652f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/yiisoft/cache-file)[![Mutation testing badge](https://camo.githubusercontent.com/030e6fcc723618cb8d99120a8f6f63994cf63b572460b9be1c95295b57bd318b/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f667425324663616368652d66696c652532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cache-file/master)[![static analysis](https://github.com/yiisoft/cache-file/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/cache-file/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/e181e2f3dd38f294bbe736f83ca6493c1912d5d92e8eed6e4d960f5c1de3331a/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f63616368652d66696c652f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/cache-file)

This package implements file-based [PSR-16](https://www.php-fig.org/psr/psr-16/) cache.

Requirements
------------

[](#requirements)

- PHP 8.1 - 8.5.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/cache-file
```

Configuration
-------------

[](#configuration)

When creating an instance of `\Yiisoft\Cache\File\FileCache`, you must specify the path to the base directory in which the cache files will be stored:

```
$cache = new \Yiisoft\Cache\File\FileCache('/path/to/directory');
```

### Constructor parameters

[](#constructor-parameters)

You can configure the cache by passing parameters to the constructor:

```
$cache = new \Yiisoft\Cache\File\FileCache(
    cachePath: '/path/to/directory',
    directoryMode: 0777,        // Permission for new directories (default: 0775)
    fileSuffix: '.cache',       // Cache file suffix (default: '.bin')
    fileMode: 0644,             // Permission for new cache files (default: null)
    directoryLevel: 2,          // Sub-directory levels (default: 1)
    gcProbability: 100,         // GC probability in parts per million (default: 10)
);
```

#### Directory mode

[](#directory-mode)

Change the permission to be set for newly created directories:

```
$cache = new \Yiisoft\Cache\File\FileCache('/path/to/directory', 0777); // default is 0775
```

This value will be used by PHP `chmod()` function. No umask will be applied. Defaults to 0775, meaning the directory is read-writable by an owner and group, but read-only for other users.

#### File suffix

[](#file-suffix)

Change the suffix of the cache files:

```
$cache = new \Yiisoft\Cache\File\FileCache(
    cachePath: '/path/to/directory',
    fileSuffix: '.cache', // default is '.bin'
);
```

#### File mode

[](#file-mode)

Change the permission to be set for newly created cache files:

```
$cache = new \Yiisoft\Cache\File\FileCache(
    cachePath: '/path/to/directory',
    fileMode: 0644, // default is null
);
```

This value will be used by PHP `chmod()` function. No umask will be applied. If not set, the permission will be determined by the current environment.

#### Directory level

[](#directory-level)

Change the level of sub-directories to store cache files:

```
$cache = new \Yiisoft\Cache\File\FileCache(
    cachePath: '/path/to/directory',
    directoryLevel: 2, // default is 1
);
```

If the system has huge number of cache files (e.g. one million), you may use a bigger value (usually no bigger than 3). Using sub-directories is mainly to ensure the file system is not over burdened with a single directory having too many files.

#### GC probability

[](#gc-probability)

Change the probability of performing garbage collection when storing a piece of data in the cache:

```
$cache = new \Yiisoft\Cache\File\FileCache(
    cachePath: '/path/to/directory',
    gcProbability: 100, // default is 10
);
```

The probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache. Defaults to 10, meaning 0.001% chance. This number should be between 0 and 1000000. A value 0 means no GC will be performed at all.

General usage
-------------

[](#general-usage)

The package does not contain any additional functionality for interacting with the cache, except those defined in the [PSR-16](https://www.php-fig.org/psr/psr-16/) interface.

```
$cache = new \Yiisoft\Cache\File\FileCache('/path/to/directory');
$parameters = ['user_id' => 42];
$key = 'demo';

// try retrieving $data from cache
$data = $cache->get($key);

if ($data === null) {
    // $data is not found in cache, calculate it from scratch
    $data = calculateData($parameters);

    // store $data in cache for an hour so that it can be retrieved next time
    $cache->set($key, $data, 3600);
}

// $data is available here
```

In order to delete value you can use:

```
$cache->delete($key);
// Or all cache
$cache->clear();
```

To work with values in a more efficient manner, batch operations should be used:

- `getMultiple()`
- `setMultiple()`
- `deleteMultiple()`

This package can be used as a cache handler for the [Yii Caching Library](https://github.com/yiisoft/cache).

Documentation
-------------

[](#documentation)

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii Cache Library - File Handler is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

53

—

FairBetter than 97% of packages

Maintenance61

Regular maintenance activity

Popularity46

Moderate usage in the ecosystem

Community37

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~240 days

Recently: every ~227 days

Total

7

Last Release

490d ago

Major Versions

1.0.1 → 2.0.02022-07-21

2.0.1 → 3.0.02023-02-15

PHP version history (2 changes)1.0.0PHP ^7.4|^8.0

2.0.0PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (40 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (26 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (13 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (10 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (10 commits)")[![alexkart](https://avatars.githubusercontent.com/u/8249105?v=4)](https://github.com/alexkart "alexkart (8 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (6 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (5 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![particleflux](https://avatars.githubusercontent.com/u/3686454?v=4)](https://github.com/particleflux "particleflux (2 commits)")[![dehbka](https://avatars.githubusercontent.com/u/16839017?v=4)](https://github.com/dehbka "dehbka (2 commits)")[![sartor](https://avatars.githubusercontent.com/u/159053?v=4)](https://github.com/sartor "sartor (2 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (2 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (2 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (2 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![skugarev](https://avatars.githubusercontent.com/u/22639131?v=4)](https://github.com/skugarev "skugarev (1 commits)")[![Chi-teck](https://avatars.githubusercontent.com/u/673139?v=4)](https://github.com/Chi-teck "Chi-teck (1 commits)")

---

Tags

cachecache-storagefilehacktoberfestpsr-16yii3frameworkcachepsr-16fileyii

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm, Rector

Type Coverage Yes

### Embed Badge

![Health badge](/badges/yiisoft-cache-file/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-cache-file/health.svg)](https://phpackages.com/packages/yiisoft-cache-file)
```

###  Alternatives

[yiisoft/cache

Yii Caching Library

48887.6k21](/packages/yiisoft-cache)[yiisoft/cache-memcached

Yii Caching Library - Memcached Handler

1316.2k](/packages/yiisoft-cache-memcached)[yiisoft/cache-redis

Yii Caching Library - Redis Handler

1012.9k](/packages/yiisoft-cache-redis)[yiisoft/cache-db

Yii Caching Library - DB Handler

136.6k](/packages/yiisoft-cache-db)[yiisoft/cache-apcu

Yii Caching Library - APCu Handler

136.5k](/packages/yiisoft-cache-apcu)[phalcon/phalcon

Phalcon Framework

2421.5k1](/packages/phalcon-phalcon)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)