Pagefile class

Represents a single file item attached to a page, typically via a File Fieldtype.

Pagefile objects are contained by a Pagefiles object.


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

Show class?             Show args?        

Common

NameReturnSummary 
Pagefile::__construct(Pagefiles $pagefiles, string $filename)
(nothing)Construct a new Pagefile 
Pagefile::basename()
stringReturns the basename of this Pagefile (name and extension, without disk path).
Can also be used as property: Pagefile::basename
 
Pagefile::description()
string arrayGet or set the file’s description (with multi-language support).
Can also be used as property: Pagefile::description
 
Pagefile::ext()
stringReturns the file’s extension - "pdf", "jpg", etc.
Can also be used as property: Pagefile::ext
 
Pagefile::filemtime()
intGet last modified time of file 
Pagefile::filename()
stringReturns the full disk path name filename to the Pagefile.
Can also be used as property: Pagefile::filename
 
Pagefile::filesize()
intReturns the filesize in number of bytes.
Can also be used as property: Pagefile::filesize
 
Pagefile::filesizeStr()
stringReturns the filesize in a formatted, output-ready string (i.e. "123 kB")
Can also be used as property: Pagefile::filesizeStr
 
Pagefile::hash()
stringReturn a unique MD5 hash representing this Pagefile.
Can also be used as property: Pagefile::hash
 
Pagefile::httpUrl()
stringReturn the web accessible URL (with scheme and hostname) to this Pagefile.
Can also be used as property: Pagefile::httpUrl
Pagefile::isNew()
boolGet or set “new” status of the Pagefile 
Pagefile::name string Returns the filename without the path, same as the "basename" property. 
Pagefile::noCacheURL()
string
Pagefile::save()
boolSave this Pagefile independently of the Page it lives on 
Pagefile::url()
stringReturn the web accessible URL to this Pagefile.
Can also be used as property: Pagefile::url
 

Traversal

For the most part you’ll want to traverse from the parent Pagefiles object than these methods.

NameReturnSummary 
Pagefile::getNext()
Pagefile Wire nullReturn the next sibling Pagefile in the parent Pagefiles, or NULL if at the end. 
Pagefile::getPrev()
Pagefile Wire nullReturn the previous sibling Pagefile in the parent Pagefiles, or NULL if at the beginning. 

Manipulation

Remember to follow up any manipulations with a $pages->save() call.

NameReturnSummary 
Pagefile::addTag($tag)
$thisAdd the given tag to this file’s tags (if not already present) 
Pagefile::description()
string arrayGet or set the file’s description (with multi-language support).
Can also be used as property: Pagefile::description
 
Pagefile::filedata()
mixedGet or set filedata
Can also be used as property: Pagefile::filedata
 
Pagefile::removeTag(string $tag)
$thisRemove the given tag from this file’s tags (if present) 
Pagefile::rename(string $basename)
string boolRename this file 
Pagefile::tags()
string arrayGet or set the "tags" property, when in use.
Can also be used as property: Pagefile::tags
 

Date time

NameReturnSummary 
Pagefile::created int Unix timestamp of when file was created.  
Pagefile::createdStr string Readable date/time string of when Pagefile was created  
Pagefile::modified int Unix timestamp of when Pagefile (file, description or tags) was last modified.  
Pagefile::modifiedStr string Readable date/time string of when Pagefile was last modified.  
Pagefile::mtime int Unix timestamp of when file (only) was last modified.  
Pagefile::mtimeStr string Readable date/time string when file (only) was last modified.  

For hooks

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

Tags

Be sure to see the Pagefiles::getTag() and Pagesfiles::findTag() methods, which enable you retrieve files by tag.

NameReturnSummary 
Pagefile::addTag($tag)
$thisAdd the given tag to this file’s tags (if not already present) 
Pagefile::hasTag(string $tag)
bool stringDoes this file have the given tag(s)? 
Pagefile::removeTag(string $tag)
$thisRemove the given tag from this file’s tags (if present) 
Pagefile::tags()
string arrayGet or set the "tags" property, when in use.
Can also be used as property: Pagefile::tags
 
Pagefile::tagsArray array Get file tags as an array.  

Other

NameReturnSummary 
Pagefile::HTTPURL string Same as the cache-busting uppercase “URL” property, but includes scheme and hostname.  
Pagefile::URL string Same as $url property but with browser cache busting query string appended.  
Pagefile::createdUser User NullPage User that added/uploaded the file or NullPage if not known (3.0.154)+.  
Pagefile::created_users_id int ID of user that added/uploaded the file or 0 if not known (3.0.154+).  
Pagefile::field Field The Field object that this file is part of.  
Pagefile::modifiedUser User NullPage User that last modified the file or NullPage if not known (3.0.154)+.  
Pagefile::modified_users_id int ID of user that last modified the file or 0 if not known (3.0.154+).  
Pagefile::page Page The Page object that this file is part of.  
Pagefile::pagefiles Pagefiles The Pagefiles WireArray that contains this file.  

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.167

Twitter updates

  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020
  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020

Latest news

  • ProcessWire Weekly #336
    In the 336th issue of ProcessWire Weekly we're going to introduce the Stripe action for FormBuilder, highlight some recent forum topics and other online resources, and more. Read on!
    Weekly.pw / 17 October 2020
  • Stripe Payment Processor for FormBuilder
    This week a second new module for processing Stripe payments has been added to FormBuilder. We’ll take a closer look at it in this blog post, plus we’ve got a demo of it here too.
    Blog / 16 October 2020
  • Subscribe to weekly ProcessWire news

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