Menu

Result Cache

PHPStan caches the result of the analysis so the subsequent runs are much faster. You should always analyse the whole project - the list of paths passed to the analyse command should be the same to take advantage of the result cache. If the list of paths differs from run to run, the cache is rebuilt from the ground up each time.

The result cache is saved at %tmpDir%/resultCache.php. Learn more about tmpDir configuration »

Result cache contents #

• The last time a full analysis of the project was performed. The full analysis is performed at least every 7 days.
• Analysis variables used to invalidate a stale cache. If any of these values change, full analysis is performed again.
  • PHPStan version
  • PHP version
  • Loaded PHP extensions
  • Rule level
  • Configuration files hashes
  • Analysed paths
  • composer.lock files hashes
  • Stub files hashes
  • Bootstrap files hashes
  • Autoload file hash
• Errors in the last run
• Dependency tree of project files. If file A.php was modified since the last run, A.php and all the files calling or otherwise referencing all the symbols in A.php are analysed again.

Clearing the result cache #

To clear the current state of the result cache, for example if you’re developing custom extensions and the result cache is getting stale too often, you can run the clear-result-cache command. Learn more »

Result cache also gets disabled when running with --debug.

Debugging the result cache #

If you run the analyse command with -vvv, PHPStan will output details about the result cache like:

• “Result cache not used because the cache file does not exist.”
• “Result cache not used because of debug mode.”
• “Result cache was not saved because of internal errors.”
• “Result cache is saved.”
• etc.

Setup in GitHub Actions #

Taking advantage of the result cache in your CI pipeline can make your build a lot faster.

Here’s an example of cache setup in GitHub Actions. First, set tmpDir in your configuration file to be inside your workspace:

parameters:
	tmpDir: tmp

Because GitHub Actions do not overwrite existing cache entries with the same key, we need to make sure the cache always has a unique key. Also, we can save the cache even for failing builds with reported errors. Here’s how the steps in a workflow could look like:

  # checkout, setup-php, composer install...
  
  - name: "Restore result cache"
    uses: actions/cache/restore@v3
    with:
      path: tmp # same as in phpstan.neon
      key: "phpstan-result-cache-${{ github.run_id }}"
      restore-keys: |
        phpstan-result-cache-

  - name: "Run PHPStan"
    run: "vendor/bin/phpstan"

  - name: "Save result cache"
    uses: actions/cache/save@v3
    if: always()
    with:
      path: tmp # same as in phpstan.neon
      key: "phpstan-result-cache-${{ github.run_id }}"

Learn more: Workflow syntax for GitHub Actions, actions/cache

Edit this page on GitHub