SproutCMS

class FileAdminController

Handles most of the processing for files

• File: /sprout/Controllers/Admin/FileAdminController.php
• Namespace: Sprout\Controllers\Admin
• Extends: HasCategoriesAdminController
• Implements:FrontEndSearch

Variables

Functions

public __construct

Constructor

protected _addPreRender

Hook called by _getAddForm() just before the view is rendered

public _addSave

Not used.

public _deleteSave

Deletes an item and logs the deleted data

This method DOES NOT remove files from disk, in case the deleted DB record needs to be restored.
They are removed later, when the deletion log is cleared; see ActionLogAdminController::cronCleanup.
If lack of disk space is an issue, the log should be cleared more often, or alternate file backends should be
used; see FilesBackend.

public _editPreRender

Pre-render hook

public _editSave

Saves the provided POST data into this file in the database

public _extraCleanupInvalid

Provides a UI for doing a 'cleanup' - removes invalid files

public _extraFindUsage

Find usage of a given file

public _extraRedoSizes

List of links to redo the sizes

public _getContentsView

Return HTML for a resultset of items
The returned HTML will be sandwiched between the refinebar and the pagination bar.

private _getContentsViewThumb

Thumbnail view for files

public _getEditSubActions

Return the sub-actions for editing; for spec AdminController::renderSubActions

public _getTools

Return the list of sidebar tools

public _getVisibilityFields

Return the fields to show in the sidebar when adding or editing a record.
These fields are shown under a heading of "Visibility"

Key is the field name, value is the field label

public _isAddSaved

Is the "add" action saved?
These may be false if the UI provides its own save mechanism (e.g. multi-add)

public ajaxAuthorLookup

Matches user input against a list of possible authors for files

public ajaxDragdropCancel

Cancel an upload - delete temporary files.

May receive two different variations on the provided POST data:
   [result][tmp_file]       Whole file was uploaded
   [partial_upload][code]   Only some chunks of the file have been uploaded

public ajaxDragdropChunk

Save a single chunk of a multi-part file upload

public ajaxDragdropDone

Stitch together uploaded chunks into an actual file

Outputs a JSON response.
The field "success" will be checked (= 1) to determine success.
On error, the field "message" will be used as an error message.
Other keys provided are passed to the ajaxDragdropForm method.

public ajaxDragdropForm

Returns the form for updating a file which has been uploaded

public ajaxDragdropSave

Handles the drag-and-drop upload form

Output JSON should be:
   success   1 or 0
   message   Error message, if success is 0
   html      Confirmation HTML, if success is 1

private ajaxErr

Used by some AJAX stuff to return a JSON error

public cleanupInvalidAction

Does file cleanup - wrapper (admin)

private cleanupInvalidActionInner

Remove invalid files, such as:
 - Files without a name
 - Files without a type
 - Files which don't actually exist

public cronCleanupInvalid

Does file cleanup - wrapper (cron)

private doUpload

Used by the quick upload tool

public downloadTemp

Provide the contents of a temporarily uploaded file, for e.g. listening to uploaded audio

public frontEndSearch

Process the results of a search.

public previewFocalCrop

Renders a HTML subset containing a focal crop image

public previewTransform

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'.
The width and height is specified width . 'x' . height (e.g. 200x100)

public quickUpload

Does a quick upload (from the fileselector)
Returns JSON.

public redoSizesAction

Fixes files which don't have the sizes they should

public reindexAll

Does a complete re-index of all files

private reindexItem

Does a re-index for a file

public selectorPopup

Outputs the file selector HTML

public selectorPopupSearch

Does the backend selector search

private stitchChunks

Stitch together the uploaded file from multiple chunks