AdminController class - Documentation for SproutCMS

Info Page:

Page options:

class AdminController

Main class to handle admin processing.
This delegates processing to controllers registered with Register::adminControllers

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

Functions

Name	Visibility	Description
__construct	public	Does some general admin loading
add	public	Shows an add form for the specified item
addSave	public	Executes the save action for a specific item
ajaxUnlock	public	Unlock a record.
call	public	Directly calls a method provided by an admin controller
checkAccess	private	Check access for a given controller/access flag combo
checkRecordAccess	public	Checks that an admin user has access to an individual record
cleanupCommonPostData	private	Ensure 'active' flag and 'tags' POST fields have values set, if they are nonexistant
closeFirstrun	public	Closes the 'first run' box, which is shown on the admin dashboard
contents	public	Shows an edit form for the specified item
cronGenericActivate	public	Activates AutoLaunch revisions
dashboard	public	Dashboard shown when a user first logs in to the admin
delete	public	Shows a delete form for the specified item
deleteSave	public	Executes the delete action for a specific item
duplicate	public	Shows a duplication form for the specified item
duplicateSave	public	Executes the save action for a record duplication
edit	public	Shows an edit form for the specified item
editSave	public	Executes the save action for a specific item
error	private	Shows an error message in the admin skin
export	public	Shows an edit form for the specified item
exportAction	public	Executes the save action for a specific item
extra	public	Calls any 'extra' commands that might be provided by the controller
getController	private	Returns an instance of a controller class for a given type
heartbeat	public
importAction	public	Executes the import action
importOptions	public	Shows the import form for the specified item
importUpload	public	File upload box for importing, options are the next step
importUploadAction	public	Copies the file to a temporary directory
index	public	Home page of admin area
intro	public	Shows an introduction for a specified type.
lock	private	Does lock checking, locking, or lock messages.
login	public	Shows a login form
loginAction	public	Processes a user login
loginComplete	private	Set up various login params and redirect into admin
loginTwoFactor	public	Show the two-factor-auth ui for a half-logged-in operator
loginTwoFactorAction	public	Process the result of a two-factor-auth for a half-logged-in operator
logout	public	Processes a user logout
moderate	public	Moderation
moderateAction	public	Processes the moderation form
perRecordPermissionsFields	protected	Generates HTML for fields relating to per-record permissions in the 'save changes' box
renderSubActions	private	Render a list of sub-actions into HTML as links
restore	public	Restore a deleted record from log data
search	public	Shows a search form for the specified item
setActiveSubsite	public	Sets the active subsite, and then redirects back to the admin area.
setDefaultMainviewParams	private	Sets the a bunch of parameters for a the main view.
setNavigation	private	Sets up the sidebar navigation for a view to show the navigation for a specific controller.
styleGuide	public	View the various styles available in the admin area
unlock	private	Unlocks lock for a given record/controller, all records for a controller, or all locks
userAgent	public	Browser information

public __construct

void $AdminController->__construct ( );

Does some general admin loading

public add

void $AdminController->add ( string $type );

Shows an add form for the specified item

public addSave

void $AdminController->addSave ( string $type );

Executes the save action for a specific item

public ajaxUnlock

void $AdminController->ajaxUnlock ( );

Unlock a record.
Called via ajax in the beforeunload javascript event

public call

void $AdminController->call ( string $class , string $method );

Directly calls a method provided by an admin controller
Suports varargs - additional args are passed to the underlying function

private checkAccess

True $AdminController->checkAccess ( ManagedAdminController $ctlr , string $access_flag , bool $action );

Check access for a given controller/access flag combo
If this returns false, it will echo out an error message; the calling code should just return.

public checkRecordAccess

bool $AdminController->checkRecordAccess ( ManagedAdminController $ctlr , int $item_id );

Checks that an admin user has access to an individual record

private cleanupCommonPostData

void $AdminController->cleanupCommonPostData ( ManagedAdminController $ctlr );

Ensure 'active' flag and 'tags' POST fields have values set, if they are nonexistant

public closeFirstrun

void $AdminController->closeFirstrun ( );

Closes the 'first run' box, which is shown on the admin dashboard

public contents

void $AdminController->contents ( string $type );

Shows an edit form for the specified item

public cronGenericActivate

unknown $AdminController->cronGenericActivate ( );

Activates AutoLaunch revisions

public dashboard

void $AdminController->dashboard ( );

Dashboard shown when a user first logs in to the admin

public delete

void $AdminController->delete ( string $type , int $id );

Shows a delete form for the specified item

public deleteSave

void $AdminController->deleteSave ( string $type , int $id );

Executes the delete action for a specific item

public duplicate

void $AdminController->duplicate ( string $type , int $id );

Shows a duplication form for the specified item
This uses the edit form with some string replacements

public duplicateSave

void $AdminController->duplicateSave ( string $type , int $orig_id );

Executes the save action for a record duplication

public edit

void $AdminController->edit ( string $type , int $id );

Shows an edit form for the specified item

public editSave

void $AdminController->editSave ( string $type , int $id );

Executes the save action for a specific item

private error

void $AdminController->error ( string $message [, ManagedAdminController $ctlr ] );

Shows an error message in the admin skin

public export

void $AdminController->export ( string $type );

Shows an edit form for the specified item

public exportAction

void $AdminController->exportAction ( string $type );

Executes the save action for a specific item

public extra

void $AdminController->extra ( string $class , string $method );

Calls any 'extra' commands that might be provided by the controller

Method names will be prefixed with '_extra' and must be public
Names which are lower_cased will be converted to camelCase

Supports varargs - additional args are passed to the underlying function
Called method should return an array, with two keys:
    title     string    Main title
    content   string    HTML for the main content area

private getController

Controller $AdminController->getController ( string $type );

Returns an instance of a controller class for a given type

public heartbeat

void $AdminController->heartbeat ( );

This function does not have a description

public importAction

void $AdminController->importAction ( string $type );

Executes the import action

public importOptions

void $AdminController->importOptions ( string $type );

Shows the import form for the specified item

public importUpload

void $AdminController->importUpload ( string $type );

File upload box for importing, options are the next step

public importUploadAction

void $AdminController->importUploadAction ( mixed $type );

Copies the file to a temporary directory

public index

void $AdminController->index ( );

Home page of admin area

public intro

void $AdminController->intro ( string $type );

Shows an introduction for a specified type.

private lock

void $AdminController->lock ( string $type , int $id , View $view );

Does lock checking, locking, or lock messages.

public login

void $AdminController->login ( );

Shows a login form

public loginAction

void $AdminController->loginAction ( );

Processes a user login

private loginComplete

void $AdminController->loginComplete ( );

Set up various login params and redirect into admin

Called after a successful login (either one-factor or two-factor)

public loginTwoFactor

void $AdminController->loginTwoFactor ( );

Show the two-factor-auth ui for a half-logged-in operator

public loginTwoFactorAction

void $AdminController->loginTwoFactorAction ( );

Process the result of a two-factor-auth for a half-logged-in operator

public logout

void $AdminController->logout ( );

Processes a user logout

public moderate

void $AdminController->moderate ( );

Moderation

public moderateAction

void $AdminController->moderateAction ( );

Processes the moderation form

protected perRecordPermissionsFields

string $AdminController->perRecordPermissionsFields ( ManagedAdminController $ctlr , int $item_id );

Generates HTML for fields relating to per-record permissions in the 'save changes' box

private renderSubActions

HTML $AdminController->renderSubActions ( array $list );

Render a list of sub-actions into HTML as links

Each sub-action should be an array, with the following keys:
   url     Link URL
   name    Link text
   class   Optional class
   new_tab Optional bool to show in new window/tab

Use a special entry with a key of "_preview" and a value of the
preview URL to set up a preview button

public restore

void $AdminController->restore ( int $log_id );

Restore a deleted record from log data

public search

void $AdminController->search ( string $type );

Shows a search form for the specified item

public setActiveSubsite

void $AdminController->setActiveSubsite ( );

Sets the active subsite, and then redirects back to the admin area.
Uses the post variable "subsite".

private setDefaultMainviewParams

void $AdminController->setDefaultMainviewParams ( View $view );

Sets the a bunch of parameters for a the main view.

private setNavigation

void $AdminController->setNavigation ( View $view , Controller $ctlr );

Sets up the sidebar navigation for a view to show the navigation for a specific controller.

public styleGuide

void $AdminController->styleGuide ( mixed $section );

View the various styles available in the admin area

private unlock

void $AdminController->unlock ( [ mixed $type [, mixed $id ]] );

Unlocks lock for a given record/controller, all records for a controller, or all locks

public userAgent

void $AdminController->userAgent ( );

Browser information

SproutCMS

Search documentation