Docs For Class Backreference

Description

Implements interfaces:

A module for tracking a users path through the applications

This module tracks user navigation to provide safe and "good" backreference links ("Go Back"). Often, taking users just back to the place they come from leads to confiusion and might be even incorrect behaviour.

It tracks up to 10 levels of navigation and can be used to provide breadcrumps like navigation elements.

Please note that tracking pages in simulatiously open browser windows will lead to unexpected behaviour.

Located in /phpsatk-lib/global/org.eenterphace.sat.backreference/backreference.php (line 44)

Method Summary

Backreference __construct ()

void __destruct ()

string backlink (string $expression, boolean $nothrow)

void clear ()

string getBacklink (integer $level)

array[string] getBackrefList ()

Backreference getInstance ()

void initialize ()

void preventMarking ()

void setTitle (string $title)

Methods

Constructor __construct (line 110)

Load backreference

Loads current backreferences from the session. Builds the backreference for the current page.

access: protected

Backreference __construct ()

Destructor __destruct (line 227)

Destructor

Saves the stored backreferences and captions to the user session. Adds the current link if not marked prevent.

access: public

void __destruct ()

backlink (line 255)

TALES expression evaluator

The "sat.back" modifier can take the following arguments:

No argument - Get the last backlink available
Integer - Get the backlink at position X (1 is latest)
'list' - Get an array of all backlinks

access: public
static:

string backlink (string $expression, boolean $nothrow)

string $expression: Expression to process
boolean $nothrow: Throw exceptions?

clear (line 213)

Clears the backreference list

Used e.g. when privileges are changed. Otherwise the old data will persist the destruction of the session.

access: public

void clear ()

getBacklink (line 158)

Gets a backlink

access: public

string getBacklink (integer $level)

integer $level: Levels to go back (By default 1, the latest link)

getBackrefList (line 196)

Gets an array of backlinks

Returns the backlinks in reverse order (most recent link first), associative with captions as keys.

access: public

array[string] getBackrefList ()

getInstance (line 68)

Gets the singleton instance of this module

access: public
static:

Backreference getInstance ()

initialize (line 58)

Initializes the Backreference module

Registers a template addon (TALES) "sat.back"

access: public
static:

void initialize ()

preventMarking (line 143)

Prevent a backreference to the current page

access: public

void preventMarking ()

setTitle (line 184)

Set the title for the current page

The page title will be stored as caption for the backlink on this page

access: public

void setTitle (string $title)

string $title: Title