Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProCacheFiles class also inherits all the methods and properties of: ProCacheClass and Wire.
Common
| Name | Return | Summary | |
|---|
$procache->files->filePutContents() $procache->files->filePutContents(string $filename, string $contents) $procache->files->filePutContents(string $filename, string $contents) | bool | Write contents to file | |
$procache->files->mkdir() $procache->files->mkdir(string $path) $procache->files->mkdir(string $path, bool $recursive = false) | bool | Create a directory | |
$procache->files->rename() $procache->files->rename(string $oldName, string $newName) $procache->files->rename(string $oldName, string $newName) | bool | Rename file | |
$procache->files->rmdir() $procache->files->rmdir(string $path, bool $recursive) $procache->files->rmdir(string $path, bool $recursive) | bool | Remove a directory, optionally recursively | |
$procache->files->rmdir2() $procache->files->rmdir2(string $path, bool $recursive) $procache->files->rmdir2(string $path, bool $recursive) | bool | 2-step rmdir: removes a path by first renaming it and then removing it | |
$procache->files->tmpDirCleanup() $procache->files->tmpDirCleanup() $procache->files->tmpDirCleanup() | int | Cleanup any ProCache-tmp dirs that remain in /site/assets/ | |
$procache->files->unlink() $procache->files->unlink(string $filename) $procache->files->unlink(string $filename) | bool | Remove/unlink a file | |
Additional methods and properties
In addition to the methods and properties above, ProCacheFiles also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.252