Toolkit API

a::average

Returns the average value of an array

a::extract

Extracts a single column from an array

a::fill

Fills an array up with additional elements to certain amount.

a::first

Returns the first element of an array

a::get

Gets an element of an array by key

a::isAssociative

Checks wether an array is associative or not (experimental)

a::json

Converts an array to a JSON string It's basically a shortcut for json_encode()

a::last

Returns the last element of an array

a::merge

Merges arrays recursively

a::missing

Checks if a given element is empty.

a::show

Shows an entire array or object in a human readable way This is perfect for debugging

a::shuffle

Shuffles an array and keeps the keys

a::sort

Sorts a multi-dimensional array by a certain column

a::update($array, $update)

Updates an array with a second array

a::xml

Converts an array to a XML string

bitmask::add

Adds a value to a bitmask

bitmask::includes

Checks if a bitmask includes a value

bitmask::remove

Removes a value from a bitmask

bitmask::validValue

Checks if a value can be used as bitmask value (checks for a power of two)

brick::addClass

brick::append

brick::attr

brick::classNames

brick::__construct

brick::data

brick::get

brick::html

brick::isVoid

brick::make

brick::on

brick::prepend

brick::removeAttr

brick::removeClass

brick::replaceClass

brick::__set

brick::tag

brick::text

brick::toString

brick::trigger

brick::val

c::get

c::remove

c::set

cache::__callStatic

Accessor for all static driver methods

cache::setup

Setup simplifier for the current driver

cache\\driver::__construct

Set all parameters which are needed to connect to the cache storage

cache\\driver::created

Checks when the cache has been created

cache\\driver::exists

Determine if an item exists in the cache.

cache\\driver::expired

Checks if an item in the cache is expired

cache\\driver::expires

Checks when an item in the cache expires

cache\\driver::flush

Flush the entire cache

cache\\driver::get

Get an item from the cache.

cache\\driver::modified

Alternate version for cache::created($key)

cache\\driver::remove

Remove an item from the cache

cache\\driver::retrieve

Private method to retrieve the cache value This needs to be defined by the driver

cache\\driver::set

Write an item to the cache for a given number of minutes.

cache\\driver\\apc::__construct

Set all parameters which are needed to connect to the cache storage

cache\\driver\\apc::created

Checks when the cache has been created

cache\\driver\\apc::exists

Checks if the current key exists in cache

cache\\driver\\apc::expired

Checks if an item in the cache is expired

cache\\driver\\apc::expires

Checks when an item in the cache expires

cache\\driver\\apc::flush

Flush the entire cache directory

cache\\driver\\apc::get

Get an item from the cache.

cache\\driver\\apc::modified

Alternate version for cache::created($key)

cache\\driver\\apc::remove

Remove an item from the cache

cache\\driver\\apc::retrieve

Get an item from the cache.

cache\\driver\\apc::set

Write an item to the cache for a given number of minutes.

cache\\driver\\file::__construct

Set all parameters which are needed for the file cache see defaults for available parameters

cache\\driver\\file::created

Checks when the cache has been created

cache\\driver\\file::exists

Determine if an item exists in the cache.

cache\\driver\\file::expired

Checks if an item in the cache is expired

cache\\driver\\file::expires

Checks when an item in the cache expires

cache\\driver\\file::flush

Flush the entire cache directory

cache\\driver\\file::get

Get an item from the cache.

cache\\driver\\file::modified

Alternate version for cache::created($key)

cache\\driver\\file::remove

Remove an item from the cache

cache\\driver\\file::retrieve

Retrieve an item from the cache.

cache\\driver\\file::set

Write an item to the cache for a given number of minutes.

cache\\driver\\memcached::__construct

Set all parameters which are needed for the memcache client see defaults for available parameters

cache\\driver\\memcached::created

Checks when the cache has been created

cache\\driver\\memcached::exists

Determine if an item exists in the cache.

cache\\driver\\memcached::expired

Checks if an item in the cache is expired

cache\\driver\\memcached::expires

Checks when an item in the cache expires

cache\\driver\\memcached::flush

Flush the entire cache directory

cache\\driver\\memcached::get

Get an item from the cache.

cache\\driver\\memcached::modified

Alternate version for cache::created($key)

cache\\driver\\memcached::remove

Remove an item from the cache

cache\\driver\\memcached::retrieve

Retrieve the CacheValue object from the cache.

cache\\driver\\memcached::set

Write an item to the cache for a given number of minutes.

cache\\driver\\mock::__construct

Set all parameters which are needed to connect to the cache storage

cache\\driver\\mock::created

Checks when the cache has been created

cache\\driver\\mock::exists

Checks if the current key exists in cache

cache\\driver\\mock::expired

Checks if an item in the cache is expired

cache\\driver\\mock::expires

Checks when an item in the cache expires

cache\\driver\\mock::flush

Flush the entire cache directory

cache\\driver\\mock::get

Get an item from the cache.

cache\\driver\\mock::modified

Alternate version for cache::created($key)

cache\\driver\\mock::remove

Remove an item from the cache

cache\\driver\\mock::retrieve

Get an item from the cache.

cache\\driver\\mock::set

Write an item to the cache for a given number of minutes.

cache\\driver\\session::__construct

Make sure the session is started within the constructor

cache\\driver\\session::created

Checks when the cache has been created

cache\\driver\\session::exists

Determine if an item exists in the cache.

cache\\driver\\session::expired

Checks if an item in the cache is expired

cache\\driver\\session::expires

Checks when an item in the cache expires

cache\\driver\\session::flush

Flush the entire cache directory

cache\\driver\\session::get

Get an item from the cache.

cache\\driver\\session::modified

Alternate version for cache::created($key)

cache\\driver\\session::remove

Remove an item from the cache

cache\\driver\\session::retrieve

Retrieve an item from the cache.

cache\\driver\\session::set

Write an item to the cache for a given number of minutes.

cache\\value::__construct

Constructor

cache\\value::created

Returns the creation date as UNIX timestamp

cache\\value::expires

Returns the expiration date as UNIX timestamp

cache\\value::value

Returns the value

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

Appends an element to the data array

$collection->chunk($size)

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

$collection->count()

Counts all elements in the array

$collection->current()

Returns the current element of the array

collection::extractValue($item, $field)

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

$collection->filter($callback)

Filter the elements in the array by a callback function

$collection->filterBy($field [, $operator], $value [, $split])

Filters the current collection by a field, operator and search value

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

Find a single item by a key and value pair

$collection->first()

Returns the first element from the array

$collection->flip()

Returns the array in reverse order

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

Gets an element by key

$collection->group($callback)

Groups the collection by a given callback

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

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

$collection->has($key)

Checks if an element is present in the collection by its key

$collection->indexOf($needle)

Tries to find the index number for the given element

$collection->key()

Returns the current key from the array

$collection->keyOf($needle)

Tries to find the key for the given element

$collection->keys()

Returns an array of all keys in the collection

$collection->last()

Returns the last element from the array

$collection->limit($limit)

Returns a new collection with a limited number of elements

$collection->map($callback)

Map a function to each item in the collection

$collection->next()

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

$collection->not($args)

Returns a new collection without the given element(s)

$collection->nth($n)

Returns the nth element from the array

$collection->offset($offset)

Returns a new collection starting from the given offset

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

Add pagination

$collection->pagination()

Get the previously added pagination object

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

Extracts all values for a single field into a new array

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

Prepends an element to the data array

$collection->prev()

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

$collection->rewind()

Moves the cursor to the first element of the array

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

$collection->shuffle()

Shuffle all elements in the array

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

Returns a slice of the collection

$collection->sortBy($field, $direction='asc')

Sorts the collection by any number of fields

$collection->toArray($callback = null)

Converts the current object into an array

$collection->toJson()

Converts the current object into a json string

$collection->valid()

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

$collection->without($args)

Returns a new collection without the given element(s)

cookie::exists

Checks if a cookie exists

cookie::forever

Stores a cookie forever

cookie::get

Get a cookie value

cookie::remove

Remove a cookie

cookie::set

Set a new cookie

crypt::decode

Decodes a string

crypt::encode

Encodes a string

data::adapter

data::decode

data::encode

data::read

data::write

database::affected

Returns the number of affected rows for the last query

database::__call

Magic way to start queries for tables by using a method named like the table.

database::connect

Connects to a database

database::connection

Returns the currently active connection

database::__construct

Constructor

database::createTable

Creates a new table

database::dropTable

Drops a table

database::escape

Escapes a value to be used for a safe query

database::execute

Executes a sql query, which is expected to not return a set of results

database::fail

Sets the exception mode for the next query

database::instance

Returns one of the started instance

database::instances

Returns all started instances

database::lastError

Returns the last db error (exception object)

database::lastId

Returns the last id if available

database::lastQuery

Returns the last query

database::lastResult

Returns the last set of results

database::prefix

Returns the used table name prefix

database::query

Exectues a sql query, which is expected to return a set of results

database::table

Sets the current table, which should be queried

database::trace

Adds a value to the db trace and also returns the entire trace if nothing is specified

database::type

Returns the used database type

database\\query::aggregate

Builds an aggregation query.

database\\query::all

Returns all matching rows from a table

database\\query::andWhere

Shortcut to attach a where clause with an AND operator.

database\\query::avg

Builds an average query

database\\query::bindings

Attaches additional bindings to the query.

database\\query::build

Builds the different types of SQL queries This uses the SQL class to build stuff.

database\\query::__call

Enables magic queries like findByUsername or findByEmail

database\\query::column

Returns only values from a single column

database\\query::__construct

Constructor

database\\query::count

Builds a count query

database\\query::debug

Enables query debugging.

database\\query::delete

Fires a delete query

database\\query::distinct

Enables distinct select clauses.

database\\query::fail

Enables failing queries.

database\\query::fetch

Sets the object class, which should be fetched Set this to array to get a simple array instead of an object

database\\query::find

Find a single row by its primary key

database\\query::findBy

Find a single row by column and value

database\\query::first

Selects only one row from a table

database\\query::group

Attaches a group by clause

database\\query::having

Attaches a having clause

database\\query::innerJoin

Shortcut for creating an inner join clause

database\\query::insert

Fires an insert query

database\\query::iterator

Sets the iterator class, which should be used for multiple results Set this to array to get a simple array instead of an iterator object

database\\query::join

Adds a new join clause to the query

database\\query::leftJoin

Shortcut for creating a left join clause

database\\query::limit

Sets the limit for select clauses

database\\query::max

Builds a max query

database\\query::min

Builds a min query

database\\query::offset

Sets the offset for select clauses

database\\query::one

Selects only one row from a table

database\\query::order

Attaches an order clause

database\\query::orWhere

Shortcut to attach a where clause with an OR operator.

database\\query::page

Automatically adds pagination to a query

database\\query::primaryKeyName

Sets the name of the primary key column

database\\query::rightJoin

Shortcut for creating a right join clause

database\\query::row

Selects only one row from a table

database\\query::select

Sets the columns, which should be selected from the table By default all columns will be selected

database\\query::sum

Builds a sum query

database\\query::table

Sets the name of the table, which should be queried

database\\query::update

Fires an update query

database\\query::values

Sets the values which should be used for the update or insert clause

database\\query::where

Attaches an additional where clause

db::__callStatic

Magic calls for other static db methods, which are redircted to the database class if available

db::connect

(Re)connect the database

db::connection

Returns the current database connection

db::execute

Executes a raw sql query which expects no set of results (i.e. update, insert, delete)

db::query

Executes a raw sql query which expects a set of results

db::table

Sets the current table, which should be queried

detect::apache

Checks if PHP is running on Apache

detect::apc

Check if APC cache is installed

detect::curl

Checks if CURL is installed

detect::documentRoot

Detect the document root

detect::exif

Check if the exif extension is installed

detect::gdlib

Checks if gdlib is installed

detect::iis

Checks if the site is running on IIS

detect::imagick

Checks if imageick is installed

detect::imap

Check if the imap extension is installed

detect::maxUploadSize

Returns the max accepted upload size defined in the php.ini

detect::mbstring

Checks if the mb string extension is installed

detect::mcrypt

Check if the mcrypt extension is installed

detect::memcache

Check if the Memcache extension is installed

detect::memcached

Check if the Memcached extension is installed

detect::mysql

Checks if mysql installed with the minimum required version

detect::path

Detects the current path

detect::php

Checks if the required php version is installed

detect::safemode

Checks if safe mode is enabled

detect::sqlite

Checks if SQLite 3 is installed

detect::subfolder

Detect if the script is installed in a subfolder

detect::windows

Checks if the site is running on Windows

dimensions::__construct

Constructor

dimensions::crop

Crops the dimensions by width and optionally by height

dimensions::fit

Recalculates the width and height to fit into the given box.

dimensions::fitHeight

Recalculates the width and height to fit the given height

dimensions::fitWidth

Recalculates the width and height to fit the given width

dimensions::fitWidthAndHeight

Recalculates the dimensions by the width and height

dimensions::height

Returns the height

dimensions::landscape

Checks if the dimensions are landscape

dimensions::orientation

Returns a string representation of the orientation

dimensions::portrait

Checks if the dimensions are portrait

dimensions::ratio

Calculates and returns the ratio

dimensions::crop

Recalculates the dimensions by width and height

dimensions::square

Checks if the dimensions are square

dimensions::toArray

Returns an array represenation of the dimensions object

dimensions::__toString

Echos the dimensions as width x height

dimensions::width

Returns the width

dir::clean

Flushes a directory

dir::copy

Copy a file, or recursively copy a folder and its contents

dir::make

Creates a new directory

dir::modified

Recursively check when the dir and all subfolders have been modified for the last time.

dir::move

Moves a directory to a new location

dir::niceSize

Returns a nicely formatted size of all the contents of the folder

dir::read

Reads all files from a directory and returns them as an array.

dir::readable

Checks if the dir is readable

dir::remove

Deletes a directory

dir::size

Gets the size of the directory and all subfolders and files

dir::wasModifiedAfter

Checks if the directory or any subdirectory has been modified after the given timestamp

dir::writable

Checks if the dir is writable

email::__call

email::__construct

email::error

Public getter for the error exception

email::get

email::send

Sends the constructed email

email::set

email::toArray

email::validate

Validates the constructed email to make sure it can be sent at all

embed::gist

Embeds a github gist

embed::vimeo

Embeds a vimeo video by passing the vimeo url

embed::youtube

Embeds a youtube video by passing the Youtube url

error::code

error::__construct

error::getCode

error::getFile

error::getLine

error::getMessage

error::getPrevious

error::getTrace

error::getTraceAsString

error::message

error::__toString

errorreporting::add

Adds a level to the current error reporting

errorreporting::get

Returns the current raw value

errorreporting::includes

Check if the current error reporting includes an error level

errorreporting::remove

Removes a level from the current error reporting

errorreporting::set

Sets a new raw error reporting value

escape::attr

Escape common HTML attributes data

escape::charIsUndefined

Check if a character is undefined in HTML

escape::convertEncoding

Convert a character from UTF-8 to UTF-16BE

escape::css

Escape HTML style property values

escape::html

Escape HTML element content

escape::js

Escape JavaScript data values

escape::noNeedToEscape

Check if a string needs to be escaped or not

escape::url

Escape URL parameter values

escape::xml

Escape XML element content

exif::aperture

Returns the aperture

exif::camera

Returns the Camera object

exif::__construct

Constructor

exif::data

Returns the raw data array from the parser

exif::exposure

Returns the exposure

exif::focalLength

Returns the focal length

exif::isBW

Checks if this is a bw picture

exif::isColor

Checks if this is a color picture

exif::iso

Returns the iso value

exif::location

Returns the location object

exif::timestamp

Returns the timestamp

exif::toArray

Converts the object into a nicely readable array

exif\\camera::__construct

Constructor

exif\\camera::make

Returns the make of the camera

exif\\camera::model

Returns the camera model

exif\\camera::toArray

Converts the object into a nicely readable array

exif\\camera::__toString

Returns the full make + model name

exif\\location::__construct

Constructor

exif\\location::lat

Returns the latitude

exif\\location::lng

Returns the longitude

exif\\location::toArray

Converts the object into a nicely readable array

exif\\location::__toString

Echos the entire location as lat, lng

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::download

f::exists

Checks if a file exists

f::extension

Gets the extension of a file

f::extensions

Returns all extensions for a certain file type

f::extensionToMime

Converts a file extension to a mime type

f::extensionToType

Returns the file type for a passed extension

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::load

Safely requires a file if it exists

f::mime

Returns the mime type of a file

f::mimes

Returns all detectable mime types

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::remove

Deletes a file

f::safeName

Sanitize a filename to strip unwanted special characters

f::show

Read and send the file with the correct headers

f::size

Returns the size of a file.

f::type

Categorize the file

f::types

Returns an array of all available file types

f::uri

Returns the file as data uri

f::write

Creates a new file

folder::child

Returns a subfolder object by path

folder::children

Return a collection of subfolders

folder::clean

Alternative for flush

folder::__construct

Constructor

folder::content

Returns a collection with full File and Directory objects for each item in the directory

folder::copy

Copies the directory to a new location

folder::create

Alternative for make

folder::delete

Deletes the directory

folder::exists

Checks if the dir exists

folder::files

Return a collection of all files within the directory

folder::flush

Deletes all contents of the directory

folder::hash

Returns a md5 hash of the root

folder::inventory

Returns the entire content of the directory

folder::isReadable

Checks if the directory is readable

folder::isWritable

Checks if the directory is writable

folder::make

Creates the directory if it does not exist yet

folder::modified

Recursively check when the dir and all subfolders have been modified for the last time.

folder::move

Moves the directory to a new location

folder::name

Returns the name of the directory without the full path

folder::niceSize

Returns the size as a human-readable string

folder::parent

Returns the parent directory object

folder::read

Alternative for scan

folder::remove

Alternative for delete

folder::root

Returns the root of the directory

folder::scan

Reads the directory content and returns an array with file objects

folder::size

Returns the entire size of the directory and all its contents

folder::__toString

Makes it possible to echo the entire object

folder::type

Corresponding method to File::type() which makes it possible to filter a collection of files and directories by type.

header::accepted

Sends a 202 header

header::contentType

Sends a content type header

header::create

Creates headers by key and value

header::created

Sends a 201 header

header::download

Sends download headers for anything that is downloadable

header::error

Sends a 400 header

header::forbidden

Sends a 403 header

header::gone

Sends a 410 header

header::missing

Sends a 404 header

header::notfound

Sends a 404 header

header::panic

Sends a 500 header

header::redirect

Sends a redirect header

header::status

Sends a status header

header::success

Sends a 200 header

header::type

Shortcut for static::contentType()

header::unavailable

Sends a 503 header

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

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

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

Fetches a POST or GET parameter by key

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

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

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

l($key, $default = null)

Fetches a language variable for multi-language sites

memory()

Returns the current memory usage in a human-readable format

multiline($text)

Converts new lines in text to html breaks.

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

size($input)

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

u($path = '/')

Shortcut for url()

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

Shortcut for the Upload class

url($path = '/')

Builds an absolute URL for a given path

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

html::a

Generates an a tag

html::attr

Generates a single attribute or a list of attributes

html::breaks

Converts lines in a string into html breaks

html::decode

Removes all html tags and encoded chars from a string

html::email

Generates an "a mailto" tag

html::encode

Converts a string to a html-safe string

html::entities

Returns the full array with all HTML entities

html::img

Generates an img tag

html::tag

Generates an Html tag with optional content and attributes

$i->current()

Returns the current element of the array

$i->key()

Returns the current key from the array

$i->next()

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

$i->prev()

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

$i->rewind()

Moves the cusor to the first element of the array

$i->valid()

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

l::get

l::remove

l::set

$media->append($content)

Appends the content and saves the file

$media->base64()

Returns the content of the file as base64 encoded string

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

Setter and getter for the file content

$media->copy($to)

Copies the file to a new location

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

Crops the file according to the given parameters

$media->dataUri()

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

$media->delete()

Deletes the file

$media->dimensions()

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

$media->dir()

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

$media->download($filename = null)

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

$media->exif()

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

$media->exists()

Checks if the file exists

$media->extension()

Returns the file extension

$media->filename()

Returns the full filename including extension

$media->hash()

Returns an md5 hash for the root of the file

$media->header($send = true)

Sends an appropriate header for the asset

$media->height()

Returns the height of image files in pixels

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

Auto-generates an HTML tag for images

$media->imagesize()

Returns the PHP imagesize array

$media->is($value)

Checks if a file is of a certain type

$media->isExecutable()

Checks if the file is executable

$media->isLandscape()

Checks if an image file has been taken in landscape mode

$media->isPortrait()

Checks if an image file has been taken in portrait mode

$media->isReadable()

Checks if the file is readable

$media->isSquare()

Checks if the image is square

$media->isWritable()

Checks if the file is writable

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

Safely requires a file if it exists

$media->mime()

Returns the file's mime type

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

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

$media->move($to)

Moves the file to a new location

$media->name()

Returns the name of the file without extension

$media->niceSize()

Returns the size of the file in a human readable format.

$media->orientation()

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

$media->ratio()

Returns the ratio of an image file

$media->read($format = null)

Reads the content of the file and returns it

$media->remove()

Alternative for delete

$media->reset()

Resets the internal memory data cache

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

Resizes the file according to the given parameters

$media->root()

Returns the full root for a file

$media->safeName()

Returns the filename as safe name

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

Saves new content to the file

$media->show()

Read and send the file with the correct headers

$media->size()

Returns the raw file size

$media->toArray($callback = null)

Converts the entire media object into a plain PHP array

$media->toJson($callback = null)

Converts the entire media object into a JSON string

$media->touch()

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

$media->type()

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

$media->url()

Returns the url to the file

$media->width()

Returns the width of image files in pixels

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

Alternative for save

obj::__call

obj::__construct

obj::get

obj::set

obj::toArray

pagination::__construct

Constructor

pagination::countItems

Returns the total number of items in the collection

pagination::countPages

Returns the total number of pages

pagination::firstPage

Returns the number of the first page

pagination::firstPageURL

Returns the url for the first page

pagination::hasNextPage

Checks if there's a next page

pagination::hasPages

Checks if multiple pages are needed or if the collection can be displayed on a single page

pagination::hasPrevPage

Checks if there's 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

Alternative for countItems()

pagination::lastPage

Returns the number of the last page

pagination::lastPageURL

Returns the url for the last page

pagination::limit

Returns the chosen limit This is used for the slice() method together with the offset to get the correct items from collections

pagination::nextPage

Returns the number of the next page

pagination::nextPageURL

Returns the url for the next page

pagination::numEnd

Returns the index number of the last item on the current page Can be used to display something like "Currently showing 1 - 10 of 123 items"

pagination::numStart

Returns the index number of the first item on the current page Can be used to display something like "Currently showing 1 - 10 of 123 items"

pagination::offset

Returns the current offset This is used for the slice() method together with the limit to get the correct items from collections

pagination::page

Returns the current page number

pagination::pages

Alternative for countPages()

pagination::pageURL

Returns a page url for any given page number

pagination::prevPage

Returns the number of the previous page

pagination::prevPageURL

Returns the url for the previous page

pagination::range

Creates a range of page numbers for Google-like pagination

pagination::rangeEnd

Returns the last page of the created range

pagination::rangeStart

Returns the first page of the created range

pagination::toArray

Returns the most important pagination data into a readable array

password::hash

Generates a salted hash for a plaintext password

password::isHash

Checks if a given string is already a hash

password::match

Checks if a password matches the encrypted hash

r::ajax

Checks if the request is an AJAX request

r::body

Returns the request body from POST requests for example

r::cli

Checks if the request has been made from the command line

r::data

Returns either the entire data array or parts of it

r::files

Returns the files array

r::get

Alternative for r::data($key, $default)

r::getData

Only returns get data

r::has

Checks for a specific key in the data array

r::ip

Returns the IP address from the request user if available

r::is

Checks if the request is of a specific type:

r::method

Returns the current request method

r::postData

Only returns post data

r::raw

Returns the raw request data

r::referer

Returns the referer if available

r::referrer

Nobody remembers how to spell it so this is a shortcut

r::remove

Removes a variable from the request array

r::scheme

Returns the request scheme

r::secure

Alternative for r::ssl()

r::set

Sets or overwrites a variable in the data array

r::ssl

Checks if the request is encrypted

redirect::back

Redirects to the last location of the user

redirect::home

Redirects to the home page of the app

redirect::send

Redirects the user to a new URL

redirect::to

Redirects to a specific URL. You can pass either a normal URI a controller path or simply nothing (which redirects home)

remote::__construct

Constructor

remote::delete

Static method to send a DELETE request

remote::get

Static method to send a GET request

remote::head

Static method to send a HEAD request

remote::headers

Static method to send a HEAD request which only returns an array of headers

remote::options

Returns all options which have been set for the current request

remote::patch

Static method to send a PATCH request

remote::post

Static method to send a POST request

remote::put

Static method to send a PUT request

remote::request

Static method to init this class and send a request

remote::response

Returns the response object for the current request

response::__construct

Constructor

response::content

Returns the content of this response

response::error

Returns an error response

response::format

Returns the content format

response::header

Sends the correct header for the response

response::json

Converts an array to json and returns it properly

response::success

Returns a success response

response::__toString

Echos the content and sends the appropriate header

router::arguments

Returns the arguments array from the current route

router::__construct

Constructor

router::filter

Add a new router filter

router::filters

Return all registered filters

router::findRouteBy

Find a registered route by a field and value

router::register

Adds a new route

router::route

Returns the found route

router::routes

Returns all added routes

router::run

Iterate through every route to find a matching route.

s::destroy

Destroys a session

s::get

Gets a session value by key

s::id

Returns the current session id

s::remove

Removes a value from the session by key

s::restart

Destroys a session first and then starts it again

s::set

Sets a session value by key

s::start

Starts a new session

s::stop

Alternative for s::destroy()

server::get

Gets a value from the _SERVER array

silo::get

silo::remove

silo::set

sql::__construct

Constructor

sql::createTable

Creates a table with a simple scheme array for columns

sql::delete

Builds a delete clause

sql::dropTable

Creates the sql for dropping a single table

sql::insert

Builds an insert clause

sql::select

Builds a select clause

sql::update

Builds an update clause

sql::values

Builds a safe list of values for insert, select or update queries

str::after

Returns the end of the string after the given character

str::ascii

Convert a string to 7-bit ASCII.

str::before

Returns the beginning of a string before the given character

str::between

Returns everything between two strings from the first occurrence of a given string

str::contains

Checks if a str contains another string

str::convert

Converts a string to a different encoding

str::download

Forces a download of the string as text file

str::email

Generates an "a mailto" tag

str::encode

Encode a string (used for email addresses)

str::encoding

Tries to detect the string encoding

str::endsWith

Checks if a string ends with the passed needle

str::excerpt

Creates an excerpt of a string It removes all html tags first and then uses str::short

str::from

Returns the end of the string, starting from the given character

str::html

Converts a string to a html-safe string

str::is_URL($string)

Checks if the given string is a URL

str::length

An UTF-8 safe version of strlen()

str::lines

Returns an array with all lines in a string

str::link

Generates an a tag

str::lower

An UTF-8 safe version of strtolower()

str::parse

Parses a string by a set of available methods

str::pool

Get a character pool with various possible combinations

str::quickRandom

Quickly generates a random string

str::random

Generates a random string that may be used for cryptographic purposes

str::replace

Replaces all or some occurrences of the search string with the replacement string. Extension of the str_replace() function in PHP with an additional $limit parameter.

str::sentences

Returns an array with all sentences in a string

str::short

Shortens a string and adds an ellipsis if the string is too long

str::slug

Convert a string to a safe version to be used in a URL

str::split

Better alternative for explode() It takes care of removing empty values and it has a built-in way to skip values which are too short.

str::startsWith

Checks if a string starts with the passed needle

str::stripslashes

A better way to strip slashes

str::substr

An UTF-8 safe version of substr()

str::template

A super simple string template engine, which replaces tags like {mytag} with any other string

str::ucfirst

An UTF-8 safe version of ucfirst()

str::ucwords

An UTF-8 safe version of ucwords()

str::unhtml

Removes all html tags and encoded chars from a string

str::until

Returns the beginning of a string until the given character

str::unxml

Removes all xml entities from a string and convert them to html entities first and remove all html entities afterwards.

str::upper

An UTF-8 safe version of strotoupper()

str::utf8

Converts a string to UTF-8

str::widont

The widont function makes sure that there are no typographical widows at the end of a paragraph – that's a single word in the last line

str::words

Returns an array with all words in a string

str::xml

Converts a string to a xml-safe string. Converts it to html-safe first and then it will replace html entities to xml entities

system::available

Checks if the system() function is available

system::__callStatic

Execute a given shell command Alias for System::execute()

system::execute

Execute a given shell command

system::isExecutable

Checks if a command is executable

system::realpath

Returns the path to a specific executable

thumb::__call

Makes all public methods of the result object available to the thumb class

thumb::__construct

Constructor

thumb::error

Returns the exception if available

thumb::get

thumb::isObsolete

Checks if the thumbnail is not needed because the original image is small enough

thumb::isThere

Checks if the thumbnail already exists and is newer than the original file

thumb::params

Makes it possible to pass a string of params which is shorter and more convenient than passing a full array of keys and values: width:300|height:200|crop:true

thumb::set

thumb::settingsIdentifier

Builds a hash for all relevant settings

thumb::source

Returns the source media object

thumb::tag

Generates and returns the full html tag for the thumbnail

thumb::toArray

thumb::__toString

Makes it possible to echo the entire object

timer::start

timer::stop

toolkit::version

tpl::get

tpl::load

tpl::remove

tpl::set

upload::__construct

upload::error

upload::file

upload::source

upload::to

url::base

Returns the base url

url::build

url::current

Returns the current url with all bells and whistles

url::currentDir

Returns the url for the current directory

url::fix

Tries to fix a broken url without protocol

url::fragments

Returns the path without params

url::hash

url::home

Returns the home url if defined

url::host

url::idn

Converts a URL with an internationalized domain name to the human-readable UTF8 representation

url::index

Returns the absolute URL for the index.php

url::isAbsolute

Checks if an URL is absolute

url::last

Return the last url the user has been on if detectable

url::makeAbsolute

Convert a relative path into an absolute URL

url::params

Returns the params in the url

url::paramsToString

url::path

Returns only the cleaned path of the url

url::port

Returns the port for the given url

url::query

Returns the query as array

url::queryToString

url::scheme

url::short

Shortens a URL It removes http:// or https:// and uses str::short afterwards

url::stripFragments

url::stripHash

Strips a hash value from the URL

url::stripParams

url::stripPath

url::stripQuery

Strips the query from the URL

url::to

The url smart handler. Must be defined before

url::unIdn

Converts a URL with an internationalized domain name to the machine-readable Punycode representation

v::__callStatic

Calls an installed validator and passes all arguments

v::validators

Return the list of all validators

visitor::acceptance

Returns a number between 0 and 1 that defines how "accepted" a specified MIME type is for the visitor's browser using the HTTP Accept header

visitor::acceptedLanguage

Returns the user's accepted language

visitor::acceptedLanguageCode

Returns the user's accepted language code

visitor::accepts

Returns whether a specified MIME type is accepted by the visitor's browser

visitor::banned

Checks if the ip of the current visitor is banned

visitor::ip

Returns the ip address of the current visitor

visitor::referer

Nobody can remember if it is written with on or two r

visitor::referrer

Returns the referrer if available

visitor::ua

Returns the user agent string of the current visitor

visitor::userAgent

A more readable but longer alternative for ua()

xml::create

Creates an XML string from an array

xml::decode

Removes all xml entities from a string and convert them to html entities first and remove all html entities afterwards.

xml::encode

Converts a string to a xml-safe string Converts it to html-safe first and then it will replace html entities to xml entities

xml::entities

Returns a translation table of xml entities to html entities

xml::parse

Parses a XML string and returns an array

yaml::decode

Parses a yaml string and returns the array

yaml::encode

Creates a new yaml string from an array

yaml::read

Reads and parses a yaml file and returns the array

yaml::write

Creates a new yaml file from an array