Cheat Sheet

$camera->make()

Returns the camera brand/make

$camera->model()

Returns the name of the camera model

$camera->toArray()

Returns the make and model as associative array.

$content->data()

Returns the entire data array with all field objects

$content([$lang])->exists()

Checks if the content file exists

$content([$lang])->fields()

Returns an array with all field names

$content([$lang])->get($key, $arguments = null)

Gets a field from the content

$content([$lang])->has($key)

Checks if a field exists

$content->language()

Return the language code for the content

$content->name()

Returns the name of the content file without the extension. This is being used to determine the template for the page

$content([$lang])->raw()

Returns the raw content from the file

$content([$lang])->root()

Returns the root for the content file

$content([$lang])->toArray()

Returns the content object as array

$dimension->fit()

Fits the width and height into a box by the given value and returns a modified dimension object

$dimension->fitHeight()

Fits the height by the given value and returns a modified dimension object

$dimension->fitWidth()

Fits the width by the given value and returns a modified dimension object

$dimension->fitWidthAndHeight()

Fits the width and height by the given values and returns a modified dimension object

$dimension->height()

Returns the height in pixels

$dimension->landscape()

Checks if the dimensions are "landscape"

$dimension->orientation()

Returns the orientation of the image as string (landscape|portrait|square)

$dimension->portrait()

Checks if the dimensions are "portrait"

$dimension->ratio()

Returns the ratio

$dimension->square()

Checks if the dimensions are square

$dimension->width()

Returns the width in pixels

$exif->aperture()

Returns the aperture value of the image, if it is available in the exif data set.

$exif->camera()

Returns the $camera object for the image, which contains the make and model.

$exif->data()

Returns the full exif data set as a raw array.

$exif->exposure()

Returns the exposure value of the image, if it is available in the exif data set.

$exif->focalLength()

Returns the focal length of the image, if it is available in the exif data set.

$exif->isBW()

Checks if the image colorspace is grayscale

$exif->isColor()

Checks if the image colorspace is either RGB or CMYK

$exif->iso()

Returns the iso value of the image, if it is available in the exif data set.

$exif->location()

Returns the $location object for the image if the image has GPS data.

$exif->timestamp()

Returns the unix timestamp of when the image was taken.

$exif->toArray()

Returns an associative array of all available exif data.

$field->bool()

Converts the field value into a proper boolean

$field->empty()

Checks if the field is empty

$field->escape()

Escapes all critical characters from the field content to make sure all you get is clean HTML

$field->excerpt($length = 140, $mode = 'chars')

Creates a short text excerpt

$field->exists()

Checks if the field exists.

$field->float()

Converts the field value into a proper float

$field->html()

Converts the field content to valid HTML

$field->int()

Converts the field value into a proper integer

$field->isEmpty()

Checks if the field is empty

$field->isFalse()

Converts the field value into a proper boolean and inverts it

$field->isNotEmpty()

Checks if the field is not empty

$field->isTranslated($lang = null)

Checks if the field is translated in the current/specified language

$field->isTrue()

Converts the field value into a proper boolean

$field->key()

Returns the name of the field.

$field->kirbytext()

Converts the field content from Markdown/Kirbytext to valid HTML

$field->kt()

Converts the field content from Markdown/Kirbytext to valid HTML

$field->length()

Returns the length of the field content

$field->link()

Creates a link for any field value

$field->lower()

Converts the field content to lowercase

$field->markdown()

Converts markdown to valid HTML

$field->or($alternative)

Checks if the field is empty and returns an alternative value in this case

$field->pages()

Converts a yaml list of page URIs to valid page objects

$field->short($chars)

Shortens the field content by the given length

$field->smartypants()

Applies SmartyPants to the field

$field->split($separator = ',')

Splits the field content into an array

$field->toFile()

Returns a file object from a filename in the field

$field->toPage()

Returns a page object from a uri in the field

$field->toStructure()

Converts a yaml field to a Structure object

$field->toUrl()

Creates an URL for any field value

$field->upper()

Converts the field content to uppercase

$field->value()

Returns the value of a field as string.

$field->widont()

Avoids typographical widows in strings by replacing the last space with  

$field->words()

Returns the number of words in the text

$field->xml()

Converts the field content to valid XML

$field->yaml()

Converts YAML-structured field content to an array

$file->append($content)

Appends the content and saves the file

$file->base64()

Returns the content of the file as base64 encoded string

$file->blur()

Applies a blur filter to the image

$file->bw($bw)

Converts the image to grayscale

$file->content($content = null, $format = null)

Setter and getter for the file content

$file->copy($to)

Copies the file to a new location

$file->createNewFilename($name, $safeName = true)

Generates a new filename for a given name and makes sure to handle badly given extensions correctly

$file->crop($width, $height = null, $quality = null)

Crops the image by width and optionally by height

$file->dataUri()

Returns a full base64 encoded data uri with a proper mime type

$file->date($format = null, $field = 'date')

Returns a unix timestamp or formatted date string from the file's meta date field or any other field containing a parsable date

$file->delete()

Deletes the file. This cannot be undone.

$file->dimensions()

Returns the $dimensions object for the file. This is only available for images (jpg, png, gif)

$file->dir()

Returns the full path for the directory, in which the file is located

$file->diruri()

Returns the relative path for the file

$file->download($filename = null)

Sends all needed headers and the content to force the browser to download the file

$file->exif()

Returns the $exif object for the file, which can be used to fetch information such as the camera model or GPS data

$file->exists()

Checks if the file exists

$file->extension()

Returns the file extension

$file->filename()

Returns the full filename including extension

$file->files()

Returns the collection of sibling files including the current object

$file->hasNext()

Checks if there's a next sibling

$file->hasPrev()

Checks if there's a previous sibling

$file->hash()

Returns an md5 hash for the root of the file

$file->header($send = true)

Sends an appropriate header for the asset

$file->height()

Returns the height of image files in pixels

$file->html($attr = array())

Auto-generates an HTML tag for images

$file->imagesize()

Returns the PHP imagesize array

$file->is($value)

Checks if a file is of a certain type

$file->isExecutable()

Checks if the file is executable

$file->isLandscape()

Checks if an image file has been taken in landscape mode

$file->isPortrait()

Checks if an image file has been taken in portrait mode

$file->isReadable()

Checks if the file is readable

$file->isSquare()

Checks if the image is square

$file->isWebsafe()

Checks if the file is a jpg, png or gif

$file->isWritable()

Checks if the file is writable

$file->kirby()

Returns the kirby object

$file->load($data = array())

Safely requires a file if it exists

$file->meta([$language])

Returns the file's $content object with data from the meta file

$file->mime()

Returns the file's mime type

$file->modified($format = false, $handler = null)

Returns the unix timestamp or a formatted date for when the file has been modified

$file->move($to)

Moves the file to a new location

$file->name()

Returns the name of the file without extension

$file->next()

Returns the next sibling

$file->niceSize()

Returns the size of the file in a human readable format

$file->orientation()

Returns the orientation of image files as a string (landscape, portrait, square)

$file->original()

Returns the reference to the original file (for thumbnails)

$file->page()

Returns the page object for a file

$file->prev()

Returns the previous sibling

$file->ratio()

Returns the ratio of an image file

$file->read($format = null)

Reads the content of the file and returns it

$file->remove()

Alternative for delete

$file->rename($name, $safeName = true)

Renames the file and all the meta text files

$file->reset()

Resets the internal memory data cache

$file->resize($width, $height = null, $quality = null)

Resizes the image by width and optionally by height

$file->root()

Returns the full root for a file

$file->safeName()

Returns the filename as safe name

$file->save($content = null, $format = null)

Saves new content to the file

$file->scale($by)

Scales the image up or down by value

$file->show()

Read and send the file with the correct headers

$file->siblings()

Returns all siblings of the file

$file->site()

Returns the site object

$file->size()

Returns the raw file size

$file->textfile([$language])

Returns the root for the meta file of the file

$file->thumb($params)

Sets all parameters for the thumb generator at once.

$file->toArray($callback = null)

Converts the entire file object into a plain PHP array

$file->toJson($callback = null)

Converts the entire media object into a JSON string

$file->touch()

Change the file's modification date to now and create it with an empty content if it is not there yet

$file->type()

Returns the file type (image, document, video, archive, code, audio, unkown)

$file->update($data = array()[, $language])

Updates the meta information for a file

$file->uri()

Returns the cleaned up relative path for the file

$file->url()

Returns the absolute URL for a file

$file->width()

Returns the width of image files in pixels

$file->write($content = null, $format = null)

Alternative for save

$files->count()

Returns the number of files in the collection

$files->filter($callback)

Applies a filter callback to each item in the collection

$files->filterBy($key [, $operator], $value [, $split])

Filters the collection by any field and value and with a set of filtering operators

$files->find()

Finds a single file or multiple files by one or many filenames.

$files->findBy($field, $value)

Finds a single file by key and value

$files->first()

Returns the first file in the collection

$files->flip()

Returns the collection in reverse order

$files->get($filename)

Returns a single file by filename

$files->groupBy($field, $caseInsensitive = true)

Groups all files in the collection by a given field.

$files->has($file)

Checks if a $file object is included in the collection

$files->keys()

Returns an array with all filenames in the collection.

$files->last()

Returns the last file in the collection

$files->limit($limit)

Returns the collection with a limited set of items

$files->map($callback)

Applies a callback to all items in the collection.

$files->not()

Returns the collection without a given file. The ignored file can be passed by filename or entire file object.

$files->nth($n)

Returns the nth file in the collection.

$files->offset($offset)

Returns the collection starting from a given offset

$files->paginate($limit, $options = array())

Applies pagination to the collection

$files->pagination()

Returns the $pagination object

$files->pluck($field, $split = null, $unique = false)

Plucks all values for a specific field from the collection and returns those as array.

$files->shuffle()

Returns the collection in shuffled order.

$files->slice($offset = null, $limit = null)

Returns a sliced version of the collection starting from a given offset and an optional limited number of items.

$files->sortBy($field, $direction = 'asc', $method = SORT_REGULAR)

Sorts the files in the collection by field and direction

$files->toArray($callback = null)

Converts the collection to a simple array.

$files->toJson()

Converts the collection to a json string.

attr($name, $value = null)

Creates attributes for an HTML tag

brick($tag, $html = false, $attr = array())

Creates an HTML Element (Brick object)

call($function, $arguments = array())

Calls a function with a given set of arguments

csrf($check = null)

Generates and checks CSRF tokens

css($path, $media = null)

Creates one or multiple CSS link tags

dump($variable, $echo = true)

Dumps the content of any variable in a human readable way for debugging

e($condition, $a, $b = null)

Echos one of two alternatives depending on a condition (Shortcut for ecco())

ecco($condition, $a, $b = null)

Echos one of two alternatives depending on a condition

email($params)

Sends an email

esc($string, $context = 'html', $strict = false)

Escapes strings based on the output context

excerpt($text, $length = 140, $mode = 'chars')

Creates an excerpt of any text by a given character or word length

get($key = null, $default = null)

Fetches a POST or GET parameter by key

gist($url, $file = null)

Embeds a Gist from Github by URL

go($url = '/', $code = 302)

Redirects to a different URL

gravatar($email, $size = 256, $default = 'mm')

Builds the Gravatar URL by email

h($text, $keepTags = true)

Converts any text to valid HTML (shortcut for html())

html($text, $keepTags = true)

Converts any text to valid HTML

image($filename = null)

Fetches any image by filename for the current page, or by path for any other page

invalid($data, $rules, $messages = array())

Runs a number of validators on a set of data and checks if the data is invalid

js($path, $async = false)

Creates a script tag to load a javascript file

kirby()

Returns the Kirby object in any situation

kirbytag($attr)

Makes it possible to use any defined Kirbytag as standalone function

kirbytext($text, $page = null)

Parses any text with Markdown and Kirbytext

l($key, $default = null)

Fetches a language variable for multi-language sites

markdown($text)

Parses the text as Markdown

memory()

Returns the current memory usage in a human-readable format

multiline($text)

Converts new lines in text to html breaks.

page($uri = null)

Fetches any page by URI or the current page when no URI is specified

pages($data = array())

Helper to build page collections

param($key = null, $default = null)

Fetches a Kirby URL parameter

params()

Fetches all Kirby URL parameters

r($condition, $a, $b = null)

Returns either $a or $b by the given condition

site()

Returns the site object in any situation

size($input)

Determines the size/length of numbers, strings, arrays and countable objects

smartypants($text)

Applies the SmartyPants Typographer on an HTML string

snippet($file, $data = array(), $return = false)

Embeds a snippet from the snippet folder

structure($data, $page = null, $key = null)

Creates a Kirby structure object from a data array

textfile($uri, $template, $lang = null)

Helper to create correct text file names for content files

thisUrl()

Returns the current url

thumb($image, $params = array(), $obj = true)

Creates a thumbnail for a given image object

twitter($username, $text = null, $title = null, $class = null)

Builds a Twitter profile link by username

u($path = '/')

Shortcut for url()

upload($to, $params = array())

Shortcut for the Upload class

url($path = '/')

Builds an absolute URL for a given path

vimeo($url, $width = null, $height = null, $class = null)

Embeds a Vimeo video by URL in an iframe

widont($text)

Avoids typographical widows in strings by replacing the last space with  

xml($text)

Converts any text to valid XML

yaml($string)

Parses any string as YAML

youtube($url, $width = null, $height = null, $class = null)

Embeds a Youtube video by URL in an iframe

date

Adds a dynamic date to the text

email

Creates an email address link

file

Creates a download link for any file

gist

Embeds a Github Gist by URL

image

Embeds an image

link

Creates a link

tel

Embeds a linked telephone number

twitter

Creates a link to a Twitter profile

vimeo

Embeds a Vimeo video by URL

youtube

Embeds a Youtube video by URL

$language->code()

Returns the iso language code

$language->default()

Checks if this is the default language

$language->direction()

Returns the text direction of the language (rtl or ltr)

$language->host()

Returns the host component of the language URL

$language->locale()

Returns the locale string

$language->name()

Returns the full name of the language

$language->path()

Returns the path component of the language URL

$language->url()

Returns the assigned base URL for the language

$location->lat()

Returns the latitude

$location->lng()

Returns the longitude

$location->toArray()

Returns latitude and longitude as associative array

cache

Enables/disables Kirby's cache

cache.autoupdate

If true, Kirby will scan the content folder for updates and refresh the cache automatically

cache.driver

Kirby has three built-in cache drivers: file, memcached and apc

cache.ignore

An array of URIs of pages, which should be ignored by the cache

cache.options

An array of options for the cache driver

content.file.extension

The file extension for files in the content folder, which are detected as content files by Kirby's core

content.file.ignore

An array of file names / folder names, which are not being scanned by Kirby's core

css.handler

Set your own handler for the css() helper function

date.handler

Can be 'date' or 'strftime' to determine which PHP function is used to formate dates for pages and files.

debug

Enables/disables PHP errors

error

The name of the error page folder

headers

An array with template names as keys and HTTP headers as values. Those headers will be sent before the template is rendered.

home

The name of the home page folder

js.handler

Set your own handler for the js() helper function

kirbytext.image.figure

If false, the image Kirbytag will no longer wrap images in figure elements.

kirbytext.video.class

The default class which is being added to Youtube and Vimeo iframes

kirbytext.video.height

The default height which is being added to Youtube and Vimeo iframes (false = no width)

kirbytext.video.vimeo.options

kirbytext.video.width

The default width which is being added to Youtube and Vimeo iframes (false = no width)

kirbytext.video.youtube.options

language.detect

Enables/disables automatic language detection for multi-language sites

languages

Language definition for multi-language sites

license

Setup for the license key

locale

Sets the global locale setting for PHP

markdown

If false, markdown parsing will be disabled in Kirbytext

markdown.breaks

Enables/disables automatic line breaks in Markdown like on Github. Otherwise line breaks must be confirmed with three spaces at the end of the line.

markdown.extra

Enables/disables the Markdown extra parser with additional Markdown features like footnotes and tables.

markdown.parser

Set your own markdown parser handler

panel.favicon

Path to a custom Panel favicon

panel.info.license

Show/Hide Kirby license information in the Panel.

panel.info.versions

Show/hide Kirby/Panel/Toolkit version information in the Panel.

panel.install

Allow running the Panel installer on a remote server.

panel.kirbytext

If false, the Panel formatting buttons and drag and drop for files and links will create regular Markdown instead of Kirbytags.

panel.language

The code for the default interface language for the Panel before the user's choice kicks in.

panel.session.timeout

Set timeout for the Panel session.

panel.stylesheet

Set a custom stylesheet for the Panel, which will be loaded after all the default styles.

representations.accept

Enables/disables parsing the Accept header for content representations

rewrite

Enables/disables URL rewriting

roles

Available user roles

routes

Additional route setup for Kirby's internal router

smartypants

Enables/disables the smartypants plugin

ssl

If true, Kirby will redirect all http requests to https.

thumbs.bin

The path for the imagemagick convert binary

thumbs.destination

Sets your own handler for where to store thumbnails

thumbs.driver

The thumbnail library which is being used by Kirby's thumb function/class ('gd' or 'im')

thumbs.filename

The naming scheme for thumb files

thumbs.interlace

Switches the default interlacing for JPEGs on or off

thumbs.memory

Allocates memory to the GD library

thumbs.quality

The default JPEG compression quality for all thumbnails

timezone

The PHP timezone setting for all date functions

tinyurl.enabled

Enables/disables tinyurls

tinyurl.folder

Tinyurl format: yourdomain/{folder}/{hash}

tinyurl.url

Separate domain for tinyurl links: {url}/{hash}

url

The base URL for the site. When set to false, Kirby auto-detects the correct URL.

whoops

Enables/disables the Whoops debugger

$page->archives()

Returns a $files collection with all archive files (zip, gzip, tar) in the page's directory

$page->audio()

Returns a $files collection with all audio files in the page's directory

$page->children()

Returns a $pages collection with all children of the page

$page->code()

Returns a $files collection with all code files (css, js, html, etc.) in the page's directory

$page->content([$lang = null])

Returns the page's $content object

$page->content()->has($field)

Checks if the page has a certain field

$page->contentURL()

Returns the full URL for the content folder

$page->create($uri, $template, $data = array())

Creates a new page object

$page->date($format = null, $field = 'date')

Returns a unix timestamp or formatted date string from the page's date field or any other field containing a parsable date

$page->decrement($field, $by = 1, $max = null)

Decrement a field value by one or a given value

$page->delete($force = false)

Deletes the $page object and all its data and files. This cannot be undone!

$page->depth()

Returns a number, which represents the nesting depth of the page

$page->dirname()

Returns the full name of the page's directory

$page->diruri()

Returns the full directory path of the page starting at /content

$page->document($filename = false)

Returns a specific document $file object by filename. If no filename is given, the first available document will be returned.

$page->documents()

Returns a $files collection with all documents in the page's directory

$page->equals($other)

Compares the page with another $page object and checks if they are the same

$page->file($filename = false)

Returns a specific $file object within the page's directory by filename. If no filename is given, the first file will be returned

$page->files()

Returns a $files collection with all files in the page's directory

$page->find($uri)

Returns the $page object of a specific subpage by URI. If multiple URIs are given, the method will return a $pages collection with all matches.

$page->grandChildren()

Returns a $pages collection with all children of children in the page's directory

$page->hasArchives()

Checks if there are any archive files (zip, gzip, tar) in the page's directory

$page->hasAudio()

Checks if there are any audio files in the page's directory

$page->hasChildren()

Checks if the page has children

$page->hasCode()

Checks if there are any code files in the page's directory

$page->hasDocuments()

Checks if there are any documents (pdf, doc, xls, etc.) in the page's directory

$page->hasFiles()

Checks if there are any files in the page's directory

$page->hasImages()

Checks if there are image files (jpg, png, gif, etc.) in the page directory

$page->hasInvisibleChildren()

Checks if the page has any invisible children

$page->hasNext([$sort, $direction])

Checks if the page has a next sibling

$page->hasNextInvisible([$sort, $direction])

Checks if the page has a next invisible sibling

$page->hasNextVisible([$sort, $direction])

Checks if the page has a next visible sibling

$page->hasPrev([$sort, $direction])

Checks if the page has a previous sibling

$page->hasPrevInvisible([$sort, $direction])

Checks if the page has a previous invisible sibling

$page->hasPrevVisible([$sort, $direction])

Checks if the page has a previous visible sibling

$page->hasTemplate()

Checks if the page has its own template or if it uses the default template

$page->hasVideos()

Checks if there are any video files in the page directory

$page->hasVisibleChildren()

Checks if the page has any visible children

$page->hash()

Returns a unique hash for the page, which is used by tinyurls

$page->headers()

Sends all appropriate headers for this page. Can be configured with the headers config array, which should contain all header definitions for each template

$page->hide()

Removes the sorting number from the page directory to switch it to invisible

$page->id()

Returns the page id, which is the untranslated URI

$page->image($filename = false)

Returns a specific image $file object by filename. If no filename is given, the first available image will be returned.

$page->images()

Returns a $files collection with all image files (jpg, png, gif, etc.) in the page directory

$page->increment($field, $by = 1, $max = null)

Increment a field value by one or a given value

$page->index()

Recursively builds a $pages collection with all children, children of children, etc.

$page->intendedTemplate()

Returns the name of the intended template. This is the name of the content text file.

$page->intendedTemplateFile()

Returns the path for the intended template file

$page->inventory()

Reads the directory and returns an inventory array

$page->is($other)

Compares the page with another $page object and checks if they are the same

$page->isActive()

Checks if the page is the currently active page

$page->isAncestorOf($child)

Checks if the page is a direct or indirect ancestor of the given $page object

$page->isCacheable()

Checks if the page can be cached

$page->isChildOf($parent)

Checks if the page is a child of the given page

$page->isDeletable()

Checks if the page is deletable

$page->isDescendantOf($parent)

Checks if the page is a descendant of the given page

$page->isDescendantOfActive()

Checks if the page is a descendant of the currently active page

$page->isErrorPage()

Checks if the page is the error page

$page->isHomePage()

Checks if the page is the home page

$page->isInvisible()

Checks if the page is invisible

$page->isOpen()

Checks if the page is open. This means that it is either active or it is a direct or indirect parent of the currently active page.

$page->isParentOf($child)

Checks if the page is the parent of the given page

$page->isSite()

Checks if this page object is the main site

$page->isVisible()

Checks if the page is visible

$page->isWritable()

Checks if the page is writable

$page->kirby()

Returns the kirby object

$page->modified($format = false)

Returns the unix timestamp or a formatted date string of the last modification date of the page

$page->move($uid)

Changes the uid for the page

$page->next([$sort, $direction])

Returns the next sibling

$page->nextInvisible([$sort, $direction])

Returns the next invisible sibling

$page->nextVisible([$sort, $direction])

Returns the next visible sibling

$page->num()

Returns the sorting number

$page->parent()

Returns the parent $page object

$page->parents()

Returns a $pages collection of all parents

$page->prev([$sort, $direction])

Returns the previous sibling

$page->prevInvisible([$sort, $direction])

Returns the previous invisble sibling.

$page->prevVisible([$sort, $direction])

Returns the previous visible sibling

$page->reset()

Cleans the temporary page cache and the cache of all parent pages

$page->root()

Returns the full root of the page directory

$page->search($query, $params = array())

Searches all descendants

$page->siblings($self = true)

Returns all siblings.

$page->site()

Returns the site object

$page->slug([$lang = null])

Returns the slug. The slug is the last part of the page's URL. It is translatable in multi-language sites while the UID always stays the page's directory name without the sorting number.

$page->sort($num = null)

Changes the sorting number of the page.

$page->template()

Returns the name of the used template for the page. Will return default if the intended template cannot be found.

$page->templateData()

Additional data, which will be passed to the template

$page->templateFile()

Returns the full path of the template file.

$page->textfile($template = null [, $lang = null])

Returns the root for the content file

$page->tinyurl()

Returns the tinyurl for the page if tinyurls are activated in the config

$page->title()

Returns the page title. The title is fetched from the content unless it does not exist. In this case it will be overwritten by the UID.

$page->toArray($callback = null)

Converts the entire page object into a plain PHP array

$page->toJson($callback = null)

Converts the entire page array into a json string

$page->touch()

Marks the page as modified

$page->uid()

The UID is the page directory name without the sorting number.

$page->update($data = array() [, $lang = null])

Updates the page content with all passed variables.

$page->uri([$lang = null])

Returns the URI. The URI is the relative URL without the host or any subfolders.

$page->url()

Returns the full URL of the page

$page->urlKey($lang = null)

Returns the URL key from the content file if available and otherwise returns the page UID

$page->video($filename = false)

Returns a specific video $file object by filename. If no filename is given, the first available video will be returned.

$page->videos()

Returns a $files collection with all videos in the page directory.

$pages->add($page)

Adds a single page object or a collection to a collection

$pages->append($key, $object)

Appends an element to the data array

$pages->children()

Returns a $pages collection with all children of each page in the collection

$pages->chunk($size)

Creates chunks of the same size and returns them in a new collection

$pages->count()

Returns the number of pages in the collection

$pages->create($uid, $template, $data = array())

Creates a new subpage

$pages->current()

Returns the current element of the array

pages::extractValue($item, $field)

Makes sure to provide a valid value for each filter method no matter if an object or an array is given

$pages->files()

Returns a $files collection with all files of each page in the collection

$pages->filter($callback)

Filters the collection with a custom filter callback

$pages->filterBy($key [, $operator], $value [, $split])

Filters the collection by any field and value and with a set of filtering operators

$pages->find($page)

Finds a $page object in the collection by UID or relative URI

$pages->findBy($key, $value)

Finds a single $page object in the collection by $key and $value

$pages->findByURI($uri)

Finds a $page object in the collection by its full URI

$pages->findOpen()

Finds the open $page object in the collection

$pages->first()

Returns the first $page object from the collection

$pages->flip()

Returns the collection in reverse order

$pages->get($key, $default = null)

Returns a $page object by its full URI

$pages->group($callback)

Groups the collection by a given callback

$pages->groupBy($field, $caseInsensitive = true)

Groups $page objects in the collection by any field and returns them in a new collection

$pages->has($page)

Checks if a $page object is included in the collection

$pages->index()

Recursively creates a full index from all pages and subpages in the collection and returns it as a new flat $pages collection

$pages->indexOf($needle)

Tries to find the index number for the given element

$pages->invisible()

Returns all invisible $page objects from the collection

$pages->key()

Returns the current key from the array

$pages->keyOf($needle)

Tries to find the key for the given element

$pages->keys()

Returns all keys/URIs from the collection

$pages->last()

Returns the last $page object from the collection

$pages->limit($limit)

Returns the collection with a limited amount of pages

$pages->map($callback)

Returns a new collection and applies the mapping callback to all pages

$pages->merge($collection2)

Returns a new combined collection

$pages->next()

Moves the cursor to the next element in the array and returns it

$pages->not($args)

Returns the collection without any given pages.

$pages->nth($n)

Returns the nth page in the collection

$pages->offset($offset)

Returns the collection starting from the given offset

$pages->paginate($limit, $options = array())

Adds a $pagination object to the collection, which makes it easy to page through items

$pages->pagination()

Returns the $pagination object if available

$pages->pluck($field, $split = null, $unique = false)

Extracts an array of values from each item by field

$pages->prepend($key, $object)

Prepends an element to the data array

$pages->prev()

Moves the cursor to the previous element in the array and returns it

$pages->rewind()

Moves the cursor to the first element of the array

$pages->search($query, $params = array())

Searches all pages in the collection and all descendants

$pages->set($key, $value)

$pages->shuffle()

Shuffles all items in the collection

$pages->slice($offset = null, $limit = null)

Returns a sliced version of the collection defined by offset and limit

$pages->sortBy($field, $direction = 'asc', $method = SORT_REGULAR)

Returns a sorted version of the collection

$pages->toArray($callback = null)

Converts the collection to a good old array. You can pass a callback which will be applied to all items in the collection before conversion

$pages->toJson()

Converts the collection to a JSON string

$pages->valid()

Checks if an element is valid This is needed for the Iterator implementation

$pages->visible()

Returns all visible items in the collection

$pages->without($args)

Returns a new collection without the given element(s)

$pagination->firstPage()

Returns the first page number — which is actually always 1.

$pagination->firstPageUrl()

Returns the absolute URL for the first page

$pagination->hasNextPage()

Checks if there's a next available page

$pagination->hasPages()

Checks if there are any pages at all. This is useful if you want to show/hide the pagination.

$pagination->hasPrevPage()

Checks if there is a previous page

$pagination->isFirstPage()

Checks if the current page is the first page

$pagination->isLastPage()

Checks if the current page is the last page

$pagination->items()

Returns the total number of items

$pagination->lastPage()

Returns the last page number

$pagination->lastPageUrl()

Returns the absolute URL for the last page

$pagination->limit()

Returns the limit of items per page

$pagination->nextPage()

Returns the next page number

$pagination->nextPageUrl()

Returns the absolute URL for the next page

$pagination->numEnd()

Returns the index number of the last item on the current page

$pagination->numStart()

Returns the index number of the first item on the current page

$pagination->offset()

Returns the offset, which is being applied to the items collection

$pagination->page()

Returns the current page number

$pagination->pageUrl($page)

Returns the absolute URL for the given page

$pagination->pages()

Returns the total number of available pages

$pagination->prevPage()

Returns the previous page number

$pagination->prevPageUrl()

Returns the absolute URL for the previous page

$pagination->range($range=5)

Returns an array of page numbers in a range of the given value.

$pagination->rangeEnd()

Returns the page number at the end of the range

$pagination->rangeStart()

Returns the page number at the beginning of the range

$pagination->toArray()

Returns the pagination object as an associative array.

Checkbox

A single checkbox field

Checkboxes

A list of checkbox fields

Date

A date picker field

Datetime

A date and time picker field

Email

An email input field with autocompletion and validation

Headline

Creates a headline to group fields

Hidden

Creates a hidden field

Image

A drag and drop image select field with preview thumbnail

Info

A plain HTML field for user instructions

Line

Draws a horizontal line to separate fields

Number

A number input field with validation

Page

A single page input with autocompletion

Radiobuttons

A list of radio buttons

Select

A simple selectbox field

Structure

Structured data input, which stores data in a field as YAML.

Tags

An interactive tags input field with autocompletion

Tel

A phone number input field

Text

A standard, single-line input field

Textarea

A textarea field, which auto-resizes and has built-in format buttons.

Time

A time picker field

Toggle

Yes/no or on/off toggle

Url

A URL input field with validation

User

A user input field with autocompletion for registered users.

panel.access

Permission to access the Panel

panel.access.options

Permission to access the site options

panel.access.users

Permission to access the user management

panel.avatar.delete

Permission to delete a user avatar

panel.avatar.replace

Permission to replace a user avatar

panel.avatar.upload

Permission to upload a new user avatar

panel.file.delete

Permission to delete a file

panel.file.rename

Permission to rename a file

panel.file.replace

Permission to replace an existing file

panel.file.sort

Permission to sort a file via drag and drop

panel.file.update

Permission to update custom fields of a file

panel.file.upload

Permission to upload a new file

panel.page.create

Permission to create a new page

panel.page.delete

Permission to delete a page

panel.page.read

Permission to access/read a page in the Panel

panel.page.update

Permission to update a page's form

panel.page.url

Permission to change the URL appendix of a page

panel.page.visibility

Permission to change the visibility of a page

panel.site.update

Permission to update the site settings

panel.user.create

Permission to create a new user

panel.user.delete

Permission to delete a user

panel.user.read

Permission to access/read a user data set

panel.user.update

Permission to update a user

panel.widget.account

Permission to see the account widget

panel.widget.history

Permission to see the history widget

panel.widget.pages

Permission to see the pages widget

panel.widget.site

Permission to see the site url widget

$request->ajax()

Checks if this request is an Ajax request

$request->body()

Returns the raw request body

$request->cli()

Checks if this request is comming from the command line

$request->data()

Returns an array of request data coming through the query and the post body.

$request->files()

Returns the $_FILES array

$request->get($key, $default = null)

Returns any value of the request data by key

$request->has($key)

Checks if a value is available in the request data

$request->ip()

Returns the IP address of the current visitor

$request->is()

Checks for the type of method

$request->method()

Returns the request method (GET, POST, DELETE, etc.)

$request->params()

Returns all params from the URL in a handy object

$request->path()

Returns the path in the current URL as object

$request->query()

Returns the query from the current URL as object

$request->referer()

Returns the referer. Also available with to "rr"

$request->scheme()

Returns the URL scheme (http, https, ftp, etc.)

$request->secure()

Checks if this is a secure request (SSL)

$request->ssl()

Checks if this is an SSL request

$request->url()

Returns the complete URL for the current request

$roots->accounts()

Returns the root of the accounts folder.

$roots->assets()

Returns the root of the assets folder.

$roots->autocss()

Returns the root of the autocss folder for the css('@auto') rule.

$roots->autojs()

Returns the root of the autojs folder for the js('@auto') rule.

$roots->avatars()

Returns the root of the avatars folder.

$roots->blueprints()

Returns the root of the blueprints folder

$roots->cache()

Returns the root of the cache folder.

$roots->config()

Returns the root of the config folder.

$roots->content()

Returns the root of the content folder

$roots->controllers()

Returns the root of the controllers folder.

$roots->fields()

Returns the root of the Panel fields folder.

$roots->index()

Returns the document root of the website

$roots->kirby()

Returns the root of the Kirby core folder

$roots->languages()

Returns the root of the languages folder for custom site localizations

$roots->models()

Returns the root of the folder for page models

$roots->plugins()

Returns the root of the plugins folder.

$roots->roles()

Returns the root of the roles folder.

$roots->site()

Returns the root of the site folder

$roots->snippets()

Returns the root of the snippets folder.

$roots->tags()

Returns the root of the Kirbytags folder

$roots->templates()

Returns the root of the templates folder.

$roots->thumbs()

Returns the root of the thumbs folder.

$roots->widgets()

Returns the root of the Panel widgets folder.

$site->activePage()

Returns the currently active page object

$site->archives()

Returns a $files collection with all archive files (zip, gzip, tar) placed directly in /content

$site->audio()

Returns a $files collection with all audio files placed directly in /content

$site->breadcrumb()

Returns a $pages collection, prepared for a foreach loop to generate a breadcrumb

$site->children()

Returns a $pages collection with all first-level children in the content folder

$site->code()

Returns a $files collection with all code files (css, js, html) placed directly in /content

$site->content()

Returns the $content object for the site, which can be used to further inspect all content variables for $site

$site->content()->has($field)

Checks if the site has a certain field

$site->contentURL()

Returns the full URL for the content folder

$site->defaultLanguage()

Returns the $language object for the default language

$site->detectedLanguage()

Returns the detected language

$site->diruri()

The base diruri is basically just an empty string

$site->documents()

Returns a $files collection with all documents (pdf, doc, xls, etc.) placed directly in /content

$site->errorPage()

Returns the $page object for the error page.

$site->file($filename)

Searches for a specific file placed directly in /content by filename

$site->files()

Returns a $files collection with all files placed directly in /content

$site->find($uri)

Finds a single $page object or a collection of $pages placed directly in /content by a single UID or a set of multiple UIDs.

$site->grandChildren()

Returns a $pages collection with all grandChildren in the /content directory

$site->hasArchives()

Checks if there are any archive files (zip, gzip, tar) placed directly in /content

$site->hasAudio()

Checks if there are any audio files placed directly in /content

$site->hasChildren()

Checks if there are any children placed directly in /content

$site->hasCode()

Checks if there are any code files placed directly in /content

$site->hasDocuments()

Checks if there are any documents (pdf, doc, xls, etc.) placed directly in /content

$site->hasFiles()

Checks if there are any files placed directly in /content

$site->hasImages()

Checks if there are any images (jpg, png, gif, etc.) placed directly in /content

$site->hasInvisibleChildren()

Checks if there are any invisible children placed directly in /content

$site->hasVideos()

Checks if there are any videos placed directly in /content

$site->hasVisibleChildren()

Checks if there are any visible children placed directly in /content

$site->homePage()

Returns the $page object for the home page

$site->id()

Returns the site id, which is an empty string in case of the site object

$site->image($filename = false)

Returns a specific image $file object by filename. If no filename is given, the first image will be returned.

$site->images()

Returns a $files collection with all images (jpg, png, gif, etc.) placed directly in /content

$site->index()

Creates a $pages collection with every page and subpage in /content. This will walk the entire file tree.

$site->isSite()

Checks if this site object is the main site

$site->language($code = null)

Returns the current language by default or any other language when a language code is given

$site->languages()

Returns the collection of available languages for multi-language sites

$site->locale()

Returns the locale settings for the site

$site->modified($format = false)

Returns the last modification date for the site. This will walk all pages and subpages and search for the very last modification.

$site->multilang()

Checks if there are one or more languages configured in the config.php

$site->page($uri = null)

Returns a specific $page object by URI. If no URI is specified the currently active page will be returned.

$site->pages()

Returns a $pages collection for all direct children in /content. It's an old version of $site->children()

$site->reset()

Cleans the temporary internal cache

$site->roles()

Returns a collection of all roles

$site->search($query, $params = array())

Searches within all pages of the site

$site->sessionLanguage()

Returns the language which will be remembered for the next visit

$site->switchLanguage(Language $language)

Redirects to the given language

$site->update($data = array()[,$lang = null])

Updates all given site variables, which are stored in site.txt

$site->url([$lang=false])

Returns the base URL for the site

$site->user()

Returns the currently logged in $user object. If no user is logged in, it will return false.

$site->users()

Returns a $users collection with all registered users.

$site->videos()

Returns a $files collection with all video files placed directly in /content

$site->visit($uri = '' [, $lang])

Activates the specified page and returns its page object

$site->visitorLanguage()

Tries to find the language for the current visitor

$site->wasModifiedAfter()

Checks if any content of the site has been modified after the given unix timestamp

$urls->assets()

Returns the url of the assets folder

$urls->autocss()

Returns the url of the autocss folder for the css('@auto') rule.

$urls->autojs()

Returns the url of the autojs folder for the js('@auto') rule.

$urls->avatars()

Returns the url of the avatars folder

$urls->content()

Returns the url of the content folder

$urls->index()

Returns the base url of the site

$urls->thumbs()

Returns the URL of the thumbs folder

$user->avatar()

Returns the user avatar object if the avatar exists

$user->avatarRoot()

Returns the full root for the user avatar image

$user->can($event, $args = [])

Returns true if the user has permission for the specified event

$user->cannot($event, $args = [])

Returns true if the user has no permission for the specified event

$user->current()

Returns the current user

$user->data()

Returns an array with all user data

$user->delete()

Deletes the user account. This cannot be undone

$user->email()

Returns the email address for the user

$user->exists()

Checks if the user exists

$user->firstName()

Returns the user's first name

$user->gravatar($size = 256)

Returns the gravatar URL for the user.

$user->hasPanelAccess()

Checks if the user is allowed to access the Panel based on the role.

$user->hasRole($role)

Checks if the user has a particular role.

$user->is($someone)

Checks if the user is the same as the given $user object

$user->isAdmin()

Checks if the user is an admin

$user->isCurrent()

Checks if the user is the currently logged in user.

$user->lastName()

Returns the user's last name

$user->login($password)

Login the user with the given password if the password matches the user's password.

$user->loginPasswordless()

Login the user without a password.

$user->logout()

Logs out the user and kills the session.

$user->permission($event, $args = [])

Checks if the user has permission for the specified event

$user->role()

Returns the user role

$user->textfile()

Returns the root for the account file

$user->update($data = array())

Updates the user account information.

$user->username()

Returns the username

$users->count()

Returns the number of all users

$users->create($data = array())

Creates a new user account

$users->filter($callback)

Filters the collection of users by a given callback function

$users->filterBy($field, $value)

Filters the collection of users by field and value

$users->find($username)

Finds a single user account by username

$users->findBy($field, $value)

Finds a single user account by field and value

$users->first()

Returns the first $user object from the collection

$users->flip()

Returns the $users collection in reversed order

$users->get($username)

Returns a single $user object by username

$users->groupBy($field, $caseInsensitive = true)

Groups users in the collection by a given field.

$users->has($user)

Checks if a $user object is included in the collection

$users->keys()

Returns all usernames/keys in the collection

$users->last()

Returns the last $user object from the collection

$users->limit($limit)

Returns a limited subset of the collection

$users->map($callback)

Maps a callback function to all $user objects in the collection

$users->not()

Returns the $users collection without the given usernames or $user objects

$users->nth($n)

Returns the nth $user in the collection

$users->offset($offset)

Returns the $users collection starting form the given offset

$users->paginate($limit, $options = array())

Applies pagination to the collection

$users->pagination()

Returns the pagination object after using $users->paginate()

$users->pluck($field, $split = null, $unique = false)

Plucks all values for a specific field from the collection and returns those as array.

$users->shuffle()

Returns the collection in shuffled order

$users->slice($offset = null, $limit = null)

Returns a sliced version of the collection starting with the offset and limited by the given limit value.

$users->sortBy($field, $direction = 'desc', $method = SORT_REGULAR)

Sort the collection by one or multiple fields

$users->toArray($callback = null)

Converts the collection to a mult-dimensional array

$users->toJson()

Converts the collection to a json string

Alpha

Valid: A-Z

Alphanum

Valid: A-Z and 0-9

Between

Checks for numbers within a given range

Date

Checks for a valid date

Different

Checks for a value, which does not equal the given value

Email

Checks for valid email addresses

Filename

Checks for valid filenames

In

Checks if the value exists in a given array

Integer

Checks for a valid integer value

IP

Checks for a valid IP address

Match

Checks if the value matches a given regular expression

Max

Checks if the value equals or is below the given maximum

MaxLength

Checks if the number of characters in the value equals or is below the given maximum

MaxWords

Checks if the number of words in the value equals or is below the given maximum

Min

Checks for a value that is greater or equals the given minimum

MinLength

Checks if the number of characters in the value equals or is greater than the given minimum

MinWords

Checks if the number of words in the value equals or is greater than the given minimum

NotIn

Validates that a value is not included in the given array

Num

Checks for a valid number

Same

Checks if the value equals another given value

Size

Checks if the value matches a given size