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
`$navigation_node`

Functions

Name	Visibility	Description
additionalCss	public	Gets the additional CSS for a page, if it has any
displayPage	private	Called by the two display functions.
fourOhFour	public	404 error
frontEndSearch	public	Process the results of a search.
loadWidgets	private	Loads the widgets from the database for this page.
review	public	Action for reviewing a page - either approves or rejects the revision
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 additionalCss

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

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

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.

private loadWidgets

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

Loads the widgets from the database for this page.

public review

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

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

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