SproutCMS

class WordCategoryAdminController

Handles most processing for Word categories

• File: /modules/Demo/Controllers/Admin/WordCategoryAdminController.php
• Namespace: SproutModules\Karmabunny\Demo\Controllers\Admin
• Extends: CategoryAdminController

Variables

Should this controller log add/edit/delete actions?

The view to use for adding new category records. Loaded in a popup

Default values used for duplicating a record.

Flag to turn duplication on or off

The view to use for editing existing category records

Modifiers applied to data prior to export
Should be a class which extends ColModifier
Can be an object instance or string of a class name

The columns to allow import for

The default selection for the "duplicates" option
Values are "new", "merge", "merge_blank" and "skip".

If a client is providing CSVs which don't have headings
You'll need to provide them in this array

Typically, we don't want to import the ID, and just let autoinc do it's thing

Actions for the itemlist

Should a link be shown above the list for adding records? (default yes)

Is deletion allowed, with an option shown in the UI? (default: no)

Different modes available for the main view
By default, there is only one mode: list

Order of main view records

An additional where clause for the main view

Instance of the parent controller

Should a UI for editing the "subsite_id" field on a record be shown?
If enabled by extending classes, then the table should contain a 'subsite_id' INT UNSIGNED column

The default number of records to show per page

Defines the widgets for the refine bar

This is the name of the table to get data from. Will be automatically deducted from the controller name if not specified

Functions

public __call (from BaseController)

Handles methods that do not exist.

public __construct (from CategoryAdminController)

public _actionLog (from ManagedAdminController)

protected _addPreRender (from ManagedAdminController)

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

public _addSave (from CategoryAdminController)

Saves the provided POST data into a new record in the database

public _deletePostSave (from ManagedAdminController)

Does custom actions after the _deleteSave method is called, e.g. clearing cache data

public _deletePreSave (from ManagedAdminController)

Does custom actions before _deleteSave method is called, e.g. extra security checks

public _deleteSave (from CategoryAdminController)

Deletes a category

protected _duplicatePreRender (from ManagedAdminController)

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

public _duplicateSave (from ManagedAdminController)

Process the saving of a duplication. Basic version just calls _editSave

protected _editPreRender (from ManagedAdminController)

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

public _editSave (from CategoryAdminController)

Saves the provided POST data the specified record

public _exportData (from ManagedAdminController)

Does the actual export. Return false on error.

public _extraMultiDelete (from ManagedAdminController)

Form to delete multiple records

public _extraReorder (from CategoryAdminController)

Shows the reorder page for re-ordering the items for this category

public _extraReorderCategories (from CategoryAdminController)

Shows the reorder page for re-ordering the categories.

public _getAddForm (from CategoryAdminController)

Returns the add form for adding a record

public _getAddSubActions (from ManagedAdminController)

Return the sub-actions for adding a record (e.g. preview)
These are rendered into HTML using AdminController::renderSubActions

public _getContents (from ManagedAdminController)

Return HTML which represents a list of records for this controller

protected _getContentsQuery (from ManagedAdminController)

Returns the SQL query for use by the contents list.

The query MUST NOT include a LIMIT clause.
The query MUST include a SQL_CALC_FOUND_ROWS clause.
The main table SHOULD be aliased to 'item'.

public _getContentsView (from ManagedAdminController)

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

public _getContentsViewList (from ManagedAdminController)

Formats a resultset of items into an Itemlist

public _getCustomAddSaveHTML (from ManagedAdminController)

Optional custom HTML for the save box
Return NULL to use the default HTML

public _getCustomDuplicateSaveHTML (from ManagedAdminController)

Optional custom HTML for the save box
Return NULL to use the default HTML

public _getCustomEditSaveHTML (from ManagedAdminController)

Optional custom HTML for the save box
Return NULL to use the default HTML

public _getDeleteForm (from CategoryAdminController)

Shows delete form for deleting this category

public _getDeleteSubActions (from ManagedAdminController)

Return the sub-actions for deleting a record (e.g. cancel)
These are rendered into HTML using AdminController::renderSubActions

public _getDuplicateForm (from ManagedAdminController)

Return HTML which represents the form for duplicating a record

public _getDuplicateSubActions (from ManagedAdminController)

Return the sub-actions for duplicating a record
These are rendered into HTML using AdminController::renderSubActions

public _getEditForm (from CategoryAdminController)

Return HTML which represents the form for editing a record

public _getEditLiveUrl (from ManagedAdminController)

Return the URL to use for the 'view live site' button, when editing a given record

public _getEditSubActions (from ManagedAdminController)

Return the sub-actions for editing a record (e.g. deleting)
These are rendered into HTML using AdminController::renderSubActions

public _getExport (from ManagedAdminController)

Returns form for doing exports

protected _getExportQuery (from ManagedAdminController)

Returns the SQL query for use by the export tools.
The query does MUST NOT include a LIMIT clause.

public _getImport (from ManagedAdminController)

Returns a form which contains options for doing an export

public _getNavigation (from CategoryAdminController)

Proxy for navigation => the main controller class

protected _getRecord (from ManagedAdminController)

Fetch the record with a given id

protected _getRefineClause (from ManagedAdminController)

Return the WHERE clause to use for a given key which is provided by the RefineBar
This must be called in the extending class if no clause can be determined,
i.e. return parent::_getRefineClause()

Allows custom non-table clauses to be added.
Is only called for key names which begin with an underscore.
The base table is aliased to 'item'.

public _getSearchForm (from ManagedAdminController)

Return HTML for a search form

public _getTools (from CategoryAdminController)

Proxy for tools => the main controller class

public _getVisibilityFields (from CategoryAdminController)

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 _identifier (from ManagedAdminController)

Creates the identifier used in the heading, and for reordering.

protected _importColGuess (from ManagedAdminController)

Try to guess the database name for a given CSV heading.
If you can't figure it out, return NULL.
If NULL is returned, the rudimentry almost-exact guesser will be run.

public _importData (from ManagedAdminController)

Does the actual import

protected _importExtraOptions (from ManagedAdminController)

Called when the import form is being built.

Returns HTML of extra options to display, or null if no extra options.

protected _importPost (from ManagedAdminController)

Called at the end of the the import process, after everything has been done.
Is called from within a transaction.
Return FALSE to abort the import.

protected _importPostRecord (from ManagedAdminController)

Called after a record has been inserted or updated.

protected _importPre (from ManagedAdminController)

Called at the beginning of the the import process.
Is called from within a transaction.
Return FALSE to abort the import.

protected _importPreRecord (from ManagedAdminController)

Called after the field data has been determined, but before the insert or update is run.

Return FALSE to skip the record.

public _intro (from ManagedAdminController)

Returns the intro HTML for this controller.

public _invalidateCaches (from ManagedAdminController)

This is called after every add, edit and delete, as well as other (i.e. bulk) actions.
Use it to clear any frontend caches. The default is an empty method.

public _isAddSaved (from ManagedAdminController)

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

public _isDeleteSaved (from ManagedAdminController)

Check if deletion of a particular record is allowed
This method may be overridden if ignoring the $main_delete property is desired

public _isEditSaved (from ManagedAdminController)

Is the "edit" action saved?
These may be false if the UI provides its own save mechanism

protected _modeSelector (from ManagedAdminController)

Returns HTML for a ui component to update the current main view mode

protected _paginationBar (from ManagedAdminController)

Builds the HTML for showing the navigation through pages in the admin.
This method is FINAL to help keep the user interface consistent.

protected _preSave (from ManagedAdminController)

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.

public ajaxArchiveAction (from CategoryAdminController)

Archive a category

public ajaxLookup (from ManagedAdminController)

Return list of records for given search term
Used for Fb::autocomplete

public ajaxLookupList (from ManagedAdminController)

Return list of records for given search term
Used for Fb::autocompleteList

public ajaxUnarchiveAction (from CategoryAdminController)

Unarchive a category

protected applyRefineFilter (from ManagedAdminController)

Applies filters defined in the query string using a LIKE contains
Only fields which exist in the RefineBar will be filtered

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

protected generateFormView (from Controller)

Generates a form view from a JSON config file

public getControllerName (from ManagedAdminController)

Returns the defined controller name.

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 getDuplicateEnabled (from ManagedAdminController)

Returns the duplication enabling flag

public getFriendlyName (from ManagedAdminController)

Returns the defined controller friendly name

public getModulePath (from BaseController)

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

public getNavigationName (from ManagedAdminController)

Returns the defined controller navigation name

public getParentInst (from CategoryAdminController)

Return the instance of the parent controller

public getTableName (from ManagedAdminController)

Returns the defined table name

public getTopnavName (from CategoryAdminController)

Proxy for top nav name => the main controller class

protected initRefineBar (from ManagedAdminController)

Initialises the refine bar if it isn't already set, with a search widget for the 'name' field if it exists
Most controllers which need a custom refine bar should call this before adding their own search widgets

protected initTableName (from ManagedAdminController)

Initialises the table name if it isn't already set, using the plural of the shorthand controller name

protected injectVisiblityFields (from ManagedAdminController)

Inject the visiblity fields into a loaded json configuration, so they actually save

public isPerSubsite (from ManagedAdminController)

If true, then a UI for editing the "subsite_id" for a record should be shown

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 postJsonMultiTag (from ManagedAdminController)

Multi-tag some items. Uses AJAX. Returns JSON.

public postMultiDelete (from ManagedAdminController)

Delete multiple records

public reorderCategoriesSave (from CategoryAdminController)

Saves a item reorder

public reorderSave (from CategoryAdminController)

Saves a item reorder

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.

protected saveJsonData (from Controller)

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