Reference

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Icons
Samples

Objects

$file
$files
$kirby
$language
$languages
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Cookie
Data
Dir
Escape
F
Header
Html
Mime
Server
Str
Url
Xml

F::append()
Appends new content to an existing file
F::base64()
Returns the file content as base64 encoded string
F::copy()
Copy a file to a new location.
F::dirname()
Just an alternative for dirname() to stay consistent
F::exists()
Checks if the file exists on disk
F::extension()
Gets the extension of a file
F::extensionToMime()
Converts a file extension to a mime type
F::extensionToType()
Returns the file type for a passed extension
F::extensions()
Returns all extensions for a certain file type
F::filename()
Extracts the filename from a file path
F::is()
Checks if a file is of a certain type
F::isReadable()
Checks if the file is readable
F::isWritable()
Checks if the file is writable
F::link()
Create a (symbolic) link to a file
F::load()
Loads a file and returns the result
F::mime()
Returns the mime type of a file
F::mimeToExtension()
Converts a mime type to a file extension
F::mimeToType()
Returns the type for a given mime
F::modified()
Get the file's last modification time.
F::move()
Moves a file to a new location
F::name()
Extracts the name from a file path or filename without extension
F::niceSize()
Converts an integer size into a human readable format
F::read()
Reads the content of a file
F::realpath()
Returns the absolute path to the file if the file can be found.
F::remove()
Deletes a file
F::rename()
Changes the name of the file without touching the extension
F::safeName()
Sanitize a filename to strip unwanted special characters
F::similar()
Tries to find similar or the same file by building a glob based on the path
F::size()
Returns the size of a file.
F::type()
Categorize the file
F::unzip()
Unzips a zip file
F::uri()
Returns the file as data uri
F::write()
Creates a new file

F::unzip()

Unzips a zip file

F::unzip(string $file, string $to): bool

Parameters

Name	Type	Default	Description
`$file`	`string`
`$to`	`string`

Return type

bool

Source code

kirby/src/Toolkit/F.php#L687