SproutCMS

class FileController

Provides access to file and image data

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

Variables

Should this controller log add/edit/delete actions?

Functions

public __call (from BaseController)

Handles methods that do not exist.

public __construct (from BaseController)

public _run (from BaseController)

The router/kohana will invoke this method to invoke an action.

If you please, you may wrap this method to create before/after hooks.

protected autoSetEmptyParam (from Controller)

Auto-set the "empty" param for fields with foreign keys to be NULL

This greatly reduces the number of foreign-key constraints hit in day-to-day use,
especially with file fields.

protected deleteRecord (from Controller)

Deletes a record, and logs the deletion
This should be used by all _deleteSave methods
Starts a transaction and commits it if not already in a transaction when called

public download

Renders file contents for viewing or downloading

protected generateFormView (from Controller)

Generates a form view from a JSON config file

public getCssClassName (from BaseController)

Return the class name for this controller, expressed in CSS style, i.e. with dashes

Example: When called from BlogPostController --> 'blog-post-controller'

public getModulePath (from BaseController)

Gets the relative path to the module the controller lives in, or sprout itself

protected jsonExtraValidate (from Controller)

Do any additional validation prior to saving the record

protected loadEditJson (from Controller)

Loads a JSON config file for an automated edit-type form for this controller

protected loadFormJson (from Controller)

Loads a config file for a JsonForm associated with this controller

protected loadRecord (from Controller)

Fetches the pre-update record from the database.
Used by the action log system, and disabled if the action log system has been turned off

protected logAction (from Controller)

Stores a history item in the database, recording an add (i.e. insert), edit, or delete.
Should be called AFTER the action has been made.
N.B. This is a low-level method; the friendlier wrapper methods are preferred;
e.g. Controller::logAdd, Controller::logEdit

protected logAdd (from Controller)

Logs an add action. This is a wrapper for Controller::logAction

protected logAddCategory (from Controller)

Logs the adding of a record to a category. This is a wrapper for Controller::logAction

protected logDelete (from Controller)

Logs a delete action. This is a wrapper for Controller::logAction

protected logDeleteCategory (from Controller)

Logs the removal of a record from a category. This is a wrapper for Controller::logAction

protected logEdit (from Controller)

Logs an edit action. This is a wrapper for Controller::logAction

public nameLookup

Looks up filenames for a list of file IDs

public playAudio

Outputs an audio player.

public redirectResize

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

protected replaceSet (from Controller)

Inserts records which are in $new_records, but are not in the specified table
Deletes records which are in the specified table, but not in $new_records
Updates records which are in both

Matching is done on the 'id' field, as a result the $new_records arrays MUST contain an id field.

public resize

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)

protected saveJsonData (from Controller)

Automatically saves the data associated with a submission on a JSON-generated form