PagefilesManager class

Manages files and file directories for a page independent of a particular field.

Files in ProcessWire are always connected with a particular Field on a Page. This is typically a FieldtypeFile field or a FieldtypeImage field, which exist as Pagefiles or Pageimages values on the Page. Sometimes it is necessary to manage all files connected with a page as a group, and this files manager class provides that. Likewise, something needs to manage the paths and URLs where these files live, and that is where this files manager comes into play as well.

Summary of what PagefilesManager does

  • Provides methods for movement of all files connected with a page as a group.
  • Ensures that file directories for a page are created (and removed) when applicable.
  • Manages secured vs. normal page file paths (see $config->pagefileSecure).
  • Manages extended vs. normal page file paths (see $config->pagefileExtendedPaths).

How to access the Page files manager

The Page files manager can be accessed from any page’s Page::filesManager() method or property.

// Example of getting a Page’s dedicated file path and URL
$filesPath = $page->filesManager->path();
$filesURL = $page->filesManager->url();

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

Show class?             Show args?        

Common

NameReturnSummary 
PagefilesManager::getFile(string $name)
Pagefile Pageimage nullGet the Pagefile object containing the given filename. 
PagefilesManager::getFiles()
arrayGet an array of all published filenames on the current Page. 
PagefilesManager::getTempPath()
stringReturn a path where temporary files can be stored unique to this ProcessWire instance 
PagefilesManager::page Page Page that this files manager is for.  
PagefilesManager::path()
stringGet the published path for files
Can also be used as property: PagefilesManager::path
 
PagefilesManager::url()
stringGet the published URL for files
Can also be used as property: PagefilesManager::url
 

For hooks

These methods are only useful for hooking and should not be called directly.

NameReturnSummary 
PagefilesManager::save()
(nothing)For hooks to listen to on page save action, for file-specific operations

Static

These methods are not connected with a particular instance and may only be called statically.

NameReturnSummary 
PagefilesManager::dirToPageID(string $dir)
intGiven a dir (URL or path) to a files directory, return the page ID associated with it. 
PagefilesManager::hasFiles(Page $page)
boolReturns true if Page has a path and files, false if not. 
PagefilesManager::hasPath(Page $page)
boolReturns true if Page has a files path that exists. 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: ProcessWire 3.0.131 adds support for partial/resumable downloads and http stream delivery, and contains several updates to our comments system, among other updates— More
    3 May 2019
  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019

Latest news

  • ProcessWire Weekly #262
    The 262nd issue of ProcessWire Weekly will cover the latest module updates, both Pro modules and non-commercial ones. We've also got some highlights from the support forum, and a beautiful new site of the week. Read on!
    Weekly.pw / 18 May 2019
  • Lots of module updates
    In this post we take a quick look at the new version of ProFields Repeater Matrix, yet another new version of FormBuilder, and a new version of the GoogleClientAPI module.
    Blog / 17 May 2019
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH