FileController class - Documentation for SproutCMS

Info Page:

Page options:

class FileController

Provides access to file and image data

File: /sprout/Controllers/FileController.php
Namespace: Sprout\Controllers
Extends: Controller

Functions

Name	Visibility	Description
download	public	Renders file contents for viewing or downloading
nameLookup	public	Looks up filenames for a list of file IDs
playAudio	public	Outputs an audio player.
redirectResize	public	Redirect to the resize url
resize	public	On the fly image resizing

public download

void $FileController->download ( int $id [, string $size ] );

Renders file contents for viewing or downloading

public nameLookup

void $FileController->nameLookup ( );

Looks up filenames for a list of file IDs

public playAudio

void $FileController->playAudio ( mixed $filename );

Outputs an audio player.

public redirectResize

void $FileController->redirectResize ( string $size , string $filename );

Redirect to the resize url
This allows JS code to use a common URL without needing to be aware of which FilesBackend is in use

public resize

void $FileController->resize ( mixed $size , mixed $filename );

On the fly image resizing

The size parameter is the new size.
The first character is taken to be the resize type, accepts 'r' or 'c' or 'm':
Meaning 'r'esize, 'c'rop or 'm'ax resize (do not scale up).
The width and height is specified width . 'x' . height (e.g. 200x100)

SproutCMS