Reference

Search

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Blocks
Icons
Samples

Objects

$asset
$block
$blocks
$file
$files
$kirby
$language
$languages
$layout
$layoutcolumn
$layouts
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit
Panel internals

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
$query
Server
Str
Tpl
Url
V
Xml

Advanced

All classes
Aliases

new File()
Creates a new File object
$file->blueprint()
Returns the FileBlueprint object for the file
$file->blueprints()
Returns an array with all blueprints that are available
$file->blur()
Blurs the image by the given amount of pixels
$file->bw()
Converts the image to black and white
$file->changeName()
Renames the file without touching the extension The store is used to actually execute this.
$file->changeSort()
Changes the file's sorting number in the meta file
$file->clone()
Creates an instance with the same initial properties.
$file->content()
Returns the content
$file->contentFiles()
Returns an array with all content files
$file->copy()
Copy the file to the given page
File::create()
Creates a new file on disk and returns the File object. The store is used to handle file writing, so it can be replaced by any other way of generating files.
$file->crop()
Crops the image by the given width and height
$file->decrement()
Decrement a given field value
$file->delete()
Deletes the file. The store is used to manipulate the filesystem or whatever you prefer.
$file->errors()
Returns all content validation errors
$file->exists()
Checks if the file exists on disk
$file->extension()
Returns the file extension
$file->filename()
Returns the filename with extension
$file->files()
Returns the parent Files collection
$file->grayscale()
Alias for File::bw()
$file->greyscale()
Alias for File::bw()
$file->hardcopy()
Creates a clone and fetches all lazy-loaded getters to get a full copy
$file->hasNext()
Checks if there's a next item in the collection
$file->hasPrev()
Checks if there's a previous item in the collection
$file->html()
Converts the file to html
$file->id()
Returns the id
$file->increment()
Increment a given field value
$file->indexOf()
Returns the position / index in the collection
$file->is()
Compares the current object with the given file object
$file->isFirst()
Checks if the item is the first in the collection
$file->isLast()
Checks if the item is the last in the collection
$file->isLocked()
Checks if the model is locked for the current user
$file->isNth()
Checks if the item is at a certain position
$file->isReadable()
Check if the file can be read by the current user
$file->isResizable()
Checks if the file is a resizable image
$file->isValid()
Checks if the data has any errors
$file->isViewable()
Checks if a preview can be displayed for the file in the panel or in the frontend
$file->kirby()
Returns the app instance
$file->lock()
Returns the lock object for this model
$file->modified()
Get the file's last modification time.
$file->next()
Returns the next item in the collection if available
$file->nextAll()
Returns the end of the collection starting after the current item
$file->page()
Returns the parent Page object
$file->panelOptions()
Returns an array of all actions that can be performed in the Panel
$file->panelPickerData()
Prepares the response data for file pickers and file fields
$file->parent()
Returns the parent Model object
$file->parents()
Returns a collection of all parent pages
$file->permissions()
Returns the permissions object for this file
$file->prev()
Returns the previous item in the collection if available
$file->prevAll()
Returns the beginning of the collection before the current item
$file->publish()
Move the file to the public media folder if it's not already there.
$file->quality()
Sets the JPEG compression quality
$file->replace()
Replaces the file. The source must be an absolute path to a file or a Url.
$file->resize()
Resizes the file with the given width and height while keeping the aspect ratio.
$file->root()
Returns the absolute root to the file
$file->siblings()
Returns all sibling elements
$file->site()
Returns the parent Site object
$file->srcset()
Create a srcset definition for the given sizes Sizes can be defined as a simple array. They can also be set up in the config with the thumbs.srcsets option.
$file->template()
Returns the final template
$file->templateSiblings()
Returns siblings with the same template
$file->thumb()
Creates a modified version of images The media manager takes care of generating those modified versions and putting them in the right place. This is normally the /media folder of your installation, but could potentially also be a CDN or any other place.
$file->toArray()
Extended info for the array export by injecting the information from the asset.
$file->toString()
String template builder
$file->translation()
Returns a single translation by language code If no code is specified the current translation is returned
$file->translations()
Returns the translations collection
$file->type()
Returns the file type
$file->unpublish()
Remove all public versions of this file
$file->update()
Updates the model data
$file->url()
Returns the Url

$file->id()

Returns the id

$file->id(): string

Return type

string

Source code

kirby/src/Cms/File.php#L300