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.

Common / Traversal / Manipulation / Date time / For hooks / Tags / Other

Common

Name Return Summary  
Pagefile::basename() string Returns the basename of this Pagefile (name and extension, without disk path).
Can also be used as property: Pagefile::basename
Pagefile::description() string Get or set the file’s description (with multi-language support).
Can also be used as property: Pagefile::description
Pagefile::ext() string Returns the file’s extension - "pdf", "jpg", etc.
Can also be used as property: Pagefile::ext
Pagefile::filename() string Returns the full disk path name filename to the Pagefile.
Can also be used as property: Pagefile::filename
Pagefile::filesize() int Returns the filesize in number of bytes.
Can also be used as property: Pagefile::filesize
Pagefile::filesizeStr() string Returns the filesize in a formatted, output-ready string (i.e. "123 kB")
Can also be used as property: Pagefile::filesizeStr
Pagefile::hash() string Return a unique MD5 hash representing this Pagefile.
Can also be used as property: Pagefile::hash
Pagefile::httpUrl() string Return the web accessible URL (with scheme and hostname) to this Pagefile.
Pagefile::name string Returns the filename without the path, same as the "basename" property.
Pagefile::url() string Return 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.

Name Return Summary  
Pagefile::getNext() Pagefile or null Return the next sibling Pagefile in the parent Pagefiles, or NULL if at the end.
Pagefile::getPrev() Pagefile or null Return 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.

Name Return Summary  
Pagefile::addTag($tag) $this Add the given tag to this file’s tags (if not already present)
Pagefile::description() string Get or set the file’s description (with multi-language support).
Can also be used as property: Pagefile::description
Pagefile::removeTag(string $tag) $this Remove the given tag from this file’s tags (if present)
Pagefile::rename(string $basename) string or bool Rename this file
Pagefile::tags() string or array Get or set the "tags" property, when in use.
Can also be used as property: Pagefile::tags

Date time

Name Return Summary  
Pagefile::created int Unix timestamp of when file was created.
Pagefile::modified int Unix timestamp of when Pagefile (file, description or tags) was last modified.
Pagefile::mtime int Unix timestamp of when file (only) was last modified.

For hooks

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

Name Return Summary  
Pagefile::install(string $filename) (nothing) Install this Pagefile

Tags

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

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

Other

Name Return Summary  
Pagefile::URL string Same as $url property but with browser cache busting query string appended that represents the file's modification time.
Pagefile::field Field The Field object that this file is part of.
Pagefile::page Page The Page object that this file is part of.
Pagefile::pagefiles Pagefiles The Pagefiles WireArray that contains this file.
Pagefile::sort int Sort order in database.

Additional methods and properties

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