Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Plugins
- Themes
- Newsletter
- Buzz
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Fields
- Sections
- Blocks
- Icons
- Styling
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $block
- $blocks
- $layout
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- Query
- Str
- Tpl
- Url
- V
- Xml

new Image()

Constructor sets all file properties
$image->base64()

Returns the file content as base64 encoded string
$image->clone()

Creates an instance with the same initial properties.
$image->copy()

Copy a file to a new location.
$image->dataUri()

Returns the file as data uri
$image->delete()

Deletes the file
$image->dimensions()

Returns the dimensions of the file if possible
$image->download()
$image->exif()

Returns the exif object for this file (if image)
$image->exists()

Checks if the file actually exists
$image->extension()

Returns the current lowercase extension (without .)
$image->filename()

Returns the filename
$image->hardcopy()

Creates a clone and fetches all lazy-loaded getters to get a full copy
$image->hash()

Returns a md5 hash of the root
$image->header()

Sends an appropriate header for the asset
$image->height()

Returns the height of the asset
$image->html()

Converts the file to html
$image->imagesize()

Returns the PHP imagesize array
$image->is()

Checks if a file is of a certain type
$image->isLandscape()

Checks if the dimensions of the asset are landscape
$image->isPortrait()

Checks if the dimensions of the asset are portrait
$image->isReadable()

Checks if the file is readable
$image->isResizable()

Checks if the file is a resizable image
$image->isSquare()

Checks if the dimensions of the asset are square
$image->isViewable()

Checks if a preview can be displayed for the file in the Panel or in the frontend
$image->isWritable()

Checks if the file is writable
$image->kirby()

Returns the app instance if it exists
$image->match()

Runs a set of validations on the file object (mainly for images).
$image->mime()

Detects the mime type of the file
$image->modified()

Returns the file's last modification time
$image->move()

Move the file to a new location
$image->name()

Getter for the name of the file without the extension
$image->niceSize()

Returns the file size in a human-readable format
$image->orientation()

Returns the orientation as string landscape | portrait | square
$image->ratio()

Returns the ratio of the asset
$image->read()

Reads the file content and returns it.
$image->realpath()

Returns the absolute path to the file
$image->rename()

Changes the name of the file without touching the extension
$image->root()

Returns the given file path
$image->sanitizeContents()

Sanitizes the file contents depending on the file type by overwriting the file with the sanitized version
$image->sha1()

Returns the sha1 hash of the file
$image->size()

Returns the raw size of the file
$image->toArray()

Converts the object to an array
$image->toJson()

Converts the entire file array into a json string
$image->type()

Returns the file type.
$image->url()

Returns the absolute url for the file
$image->validateContents()

Validates the file contents depending on the file type
$image->width()

Returns the width of the asset
$image->write()

Writes content to the file

$image->ratio()

Returns the ratio of the asset

kirby/src/Image/Image.php#L209

$image->ratio(): float

Return type

float

Parent class

Kirby\Image\Image

Did you find an error? Help us improve our docs and edit this page on Github. Make sure to check out our styleguide →