CacheFile class

Located in file /wire/core/CacheFile.php

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the CacheFile class also inherits all the methods and properties of: Wire.

Show class?             Show args?        

Common

NameReturnSummary 
CacheFile::exists()
boolDoes the cache file exist? 
CacheFile::expireAll()
(nothing)Causes all cache files in this type to be immediately expired 
CacheFile::get()
stringGet the contents of the cache based on the primary or secondary ID 
CacheFile::remove()
(nothing)Removes all cache files for primaryID 
CacheFile::removeAll(string $path)
intRemove all cache files in the given path, recursively 
CacheFile::save(string $data)
boolSaves $data to the cache 
CacheFile::setChmodDir(string $mode)
(nothing)Set the octal mode for dirs created by CacheFile 
CacheFile::setChmodFile(string $mode)
(nothing)Set the octal mode for files created by CacheFile 
CacheFile::setSecondaryID($id)
(nothing)An extra part to be appended to the filename 

Additional methods and properties

In addition to the methods and properties above, CacheFile also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer