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
| Name | Return | Summary | |
|---|---|---|---|
Pagefile::__construct() Pagefile::__construct(Pagefiles $pagefiles, string $filename) Pagefile::__construct(Pagefiles $pagefiles, string $filename) | (nothing) | Construct a new Pagefile | |
Pagefile::basename() Pagefile::basename() Pagefile::basename(bool $ext = true) | string | Returns the basename of this Pagefile (name and extension, without disk path). Can also be used as property: Pagefile::basename | |
Pagefile::description() Pagefile::description() Pagefile::description($language = null, $value = null) | string array | Get or set the file’s description (with multi-language support). Can also be used as property: Pagefile::description | |
Pagefile::ext() Pagefile::ext() Pagefile::ext() | string | Returns the file’s extension - "pdf", "jpg", etc. Can also be used as property: Pagefile::ext | |
Pagefile::filemtime() Pagefile::filemtime() Pagefile::filemtime(bool $reset = false) | int | Get last modified time of file | |
Pagefile::filename() Pagefile::filename() Pagefile::filename() | string | Returns the full disk path name filename to the Pagefile. Can also be used as property: Pagefile::filename | |
Pagefile::filesize() Pagefile::filesize() Pagefile::filesize(bool $reset = false) | int | Returns the filesize in number of bytes. Can also be used as property: Pagefile::filesize | |
Pagefile::filesizeStr() Pagefile::filesizeStr() 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::getFiles() Pagefile::getFiles() Pagefile::getFiles() | array | Get all filenames associated with this file | |
Pagefile::hash() Pagefile::hash() Pagefile::hash() | string | Return a unique MD5 hash representing this Pagefile. Can also be used as property: Pagefile::hash | |
Pagefile::hidden() Pagefile::hidden() Pagefile::hidden($set = null) | (nothing) | Get or set hidden state of this file | |
Pagefile::httpUrl() Pagefile::httpUrl() Pagefile::httpUrl() | string | Return the web accessible URL (with scheme and hostname) to this Pagefile. Can also be used as property: Pagefile::httpUrl | |
Pagefile::isNew() Pagefile::isNew() Pagefile::isNew($set = null) | bool | Get or set “new” status of the Pagefile | |
| Pagefile::name | string | Returns the filename without the path, same as the "basename" property. | |
Pagefile::noCacheURL() Pagefile::noCacheURL() Pagefile::noCacheURL($http = false) | string | ||
Pagefile::save() Pagefile::save() Pagefile::save() | bool | Save this Pagefile independently of the Page it lives on | |
Pagefile::uploadName() Pagefile::uploadName() Pagefile::uploadName() | string | Original and unsanitized filename at the time it was uploaded Can also be used as property: Pagefile::uploadName | |
Pagefile::url() Pagefile::url() 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::getNext() Pagefile::getNext() | Pagefile null | Return the next sibling Pagefile in the parent Pagefiles, or NULL if at the end. | |
Pagefile::getPrev() Pagefile::getPrev() Pagefile::getPrev() | Pagefile 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() Pagefile::addTag($tag) Pagefile::addTag($tag) | $this | Add the given tag to this file’s tags (if not already present) | |
Pagefile::description() Pagefile::description() Pagefile::description($language = null, $value = null) | string array | Get or set the file’s description (with multi-language support). Can also be used as property: Pagefile::description | |
Pagefile::filedata() Pagefile::filedata() Pagefile::filedata($key = '', $value = null) | mixed | Get or set filedata Can also be used as property: Pagefile::filedata | |
Pagefile::removeTag() Pagefile::removeTag(string $tag) Pagefile::removeTag(string $tag) | $this | Remove the given tag from this file’s tags (if present) | |
Pagefile::rename() Pagefile::rename(string $basename) Pagefile::rename(string $basename) | string bool | Rename this file | |
Pagefile::tags() Pagefile::tags() Pagefile::tags($value = null) | string 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::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.
| Name | Return | Summary | |
|---|---|---|---|
Pagefile::install() Pagefile::install(string $filename) 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() Pagefile::addTag($tag) Pagefile::addTag($tag) | $this | Add the given tag to this file’s tags (if not already present) | |
Pagefile::hasTag() Pagefile::hasTag(string $tag) Pagefile::hasTag(string $tag) | bool string | Does this file have the given tag(s)? | |
Pagefile::removeTag() Pagefile::removeTag(string $tag) Pagefile::removeTag(string $tag) | $this | Remove the given tag from this file’s tags (if present) | |
Pagefile::tags() Pagefile::tags() Pagefile::tags($value = null) | string array | Get 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
| Name | Return | Summary | |
|---|---|---|---|
| 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.236