PageController class - Documentation for SproutCMS

Info Page:

Page options:

class PageController

Handles front-end processing for pages

File: /sprout/Controllers/PageController.php
Namespace: Sprout\Controllers
Extends: Controller
Implements:FrontEndSearch

Variables

Name	Visibility	Description
`$action_log`		Should this controller log add/edit/delete actions?
`$navigation_node`

Functions

Name	Visibility	Description
__call	public	Handles methods that do not exist.
__construct	public
_run	public	The router/kohana will invoke this method to invoke an action.
additionalCss	public	Gets the additional CSS for a page, if it has any
autoSetEmptyParam	protected	Auto-set the "empty" param for fields with foreign keys to be NULL
deleteRecord	protected	Deletes a record, and logs the deletion
displayPage	private	Called by the two display functions.
fourOhFour	public	404 error
frontEndSearch	public	Process the results of a search.
generateFormView	protected	Generates a form view from a JSON config file
getCssClassName	public	Return the class name for this controller, expressed in CSS style, i.e. with dashes
getModulePath	public	Gets the relative path to the module the controller lives in, or sprout itself
jsonExtraValidate	protected	Do any additional validation prior to saving the record
loadEditJson	protected	Loads a JSON config file for an automated edit-type form for this controller
loadFormJson	protected	Loads a config file for a JsonForm associated with this controller
loadRecord	protected	Fetches the pre-update record from the database.
loadWidgets	private	Loads the widgets from the database for this page.
logAction	protected	Stores a history item in the database, recording an add (i.e. insert), edit, or delete.
logAdd	protected	Logs an add action. This is a wrapper for Controller::logAction
logAddCategory	protected	Logs the adding of a record to a category. This is a wrapper for Controller::logAction
logDelete	protected	Logs a delete action. This is a wrapper for Controller::logAction
logDeleteCategory	protected	Logs the removal of a record from a category. This is a wrapper for Controller::logAction
logEdit	protected	Logs an edit action. This is a wrapper for Controller::logAction
replaceSet	protected	Inserts records which are in $new_records, but are not in the specified table
review	public	Action for reviewing a page - either approves or rejects the revision
saveJsonData	protected	Automatically saves the data associated with a submission on a JSON-generated form
setSocialMeta	private	Set the social meta data for a page
textTranslation	private	Makes alterations to the main text content
trackVisit	private	Rudimentary stats tracking
viewById	public	Displays a page.
viewByName	public	Displays a page.
viewSpecificRev	public	Displays a specific revision of a page.
widgetCondsEnvironment	private	Return the environment which is provided to the widget display conditions logic

public __call (from BaseController)

void $BaseController->__call ( string $method , array $args );

Handles methods that do not exist.

public __construct (from BaseController)

void $BaseController->__construct ( );

This function does not have a description

public _run (from BaseController)

void $BaseController->_run ( mixed $method , mixed $args );

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 additionalCss

void $PageController->additionalCss ( mixed $page_id [, mixed $junk ] );

Gets the additional CSS for a page, if it has any

protected autoSetEmptyParam (from Controller)

null $Controller->autoSetEmptyParam ( array &$conf );

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)

int $Controller->deleteRecord ( string $table , int $record_id [, int $parent_log_id ] );

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

private displayPage

string $PageController->displayPage ( array $page [, string $approval_code ] );

Called by the two display functions.
Does the actual display.

public fourOhFour

void $PageController->fourOhFour ( mixed $name );

404 error

public frontEndSearch

string $PageController->frontEndSearch ( array $item_id , mixed $relevancy , mixed $keywords );

Process the results of a search.

protected generateFormView (from Controller)

array $Controller->generateFormView ( mixed $file_name );

Generates a form view from a JSON config file

public getCssClassName (from BaseController)

string $BaseController->getCssClassName ( );

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)

string $BaseController->getModulePath ( );

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

protected jsonExtraValidate (from Controller)

void $Controller->jsonExtraValidate ( int $id , Validator $validator );

Do any additional validation prior to saving the record

protected loadEditJson (from Controller)

array $Controller->loadEditJson ( );

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

protected loadFormJson (from Controller)

array $Controller->loadFormJson ( string $file_name );

Loads a config file for a JsonForm associated with this controller

protected loadRecord (from Controller)

bool|array $Controller->loadRecord ( string $table , int $record_id );

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

private loadWidgets

void $PageController->loadWidgets ( array $conds_env , array $page );

Loads the widgets from the database for this page.

protected logAction (from Controller)

int $Controller->logAction ( string $table , int $record_id , int $type , array $data [, int $parent_log_id ] );

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)

int $Controller->logAdd ( string $table , int $record_id );

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

protected logAddCategory (from Controller)

int $Controller->logAddCategory ( string $table , int $record_id , int $cat_id );

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

protected logDelete (from Controller)

int $Controller->logDelete ( string $table , int $record_id , array $data [, int $parent_log_id ] );

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

protected logDeleteCategory (from Controller)

int $Controller->logDeleteCategory ( string $table , int $record_id , int $cat_id );

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

protected logEdit (from Controller)

int $Controller->logEdit ( string $table , int $record_id , array $data );

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

protected replaceSet (from Controller)

void $Controller->replaceSet ( string $table , array $new_records , array $conditions );

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 review

void $PageController->review ( mixed $rev_id );

Action for reviewing a page - either approves or rejects the revision

protected saveJsonData (from Controller)

bool $Controller->saveJsonData ( array $conf , int &$item_id [, string $mode ] );

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

private setSocialMeta

void $PageController->setSocialMeta ( array $page , string $content_html );

Set the social meta data for a page

private textTranslation

unknown $PageController->textTranslation ( mixed $page_id , mixed $text );

Makes alterations to the main text content

private trackVisit

void $PageController->trackVisit ( mixed $page_id );

Rudimentary stats tracking

public viewById

void $PageController->viewById ( int $id );

Displays a page.
The page is specified by the page id

public viewByName

void $PageController->viewByName ( string $name );

Displays a page.
The page is specified by the page friendly name

public viewSpecificRev

void $PageController->viewSpecificRev ( int $page_id , int $rev_id [, string $approval_code ] );

Displays a specific revision of a page.

private widgetCondsEnvironment

array $PageController->widgetCondsEnvironment ( array $page );

Return the environment which is provided to the widget display conditions logic

SproutCMS

Search documentation