phpPeanuts  2.2.0
phpPeanuts framework
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Data Fields | Protected Member Functions
PntSessionBasedScout Class Reference

Public Member Functions

 __construct ($siteParam, $footprintsLimit=30)
 
sessionVar ($key)
 
 getReferrerId ($requestData)
 
 moved ($fromId, $direction=null, $requestData=null)
 
 getRequestUrl ($requestData)
 
 getFootprintUri ($url)
 
 getRootUrl ()
 
 getContextHref ($footprintId)
 
 getFootprintHref ($footprintId)
 
 getFootprint ($footprintId)
 

Data Fields

 $site
 
 $baseUrl
 
 $footprintsLimit
 
 $footprintUris
 
 $contextIds
 

Protected Member Functions

getFootprintUris ()
 
 getContextIds ()
 

Constructor & Destructor Documentation

__construct (   $siteParam,
  $footprintsLimit = 30 
)

Member Function Documentation

getContextHref (   $footprintId)
Parameters
string$footprintIdthe id of the footprint to get the context href from
Returns
String absolute url to context, or null if none
getContextIds ( )
protected

Returns the ids of the deeper context by context id

Returns
Array of int
getFootprint (   $footprintId)
getFootprintHref (   $footprintId)
Parameters
string$footprintIdthe id of the footprint to get the href from
Returns
String absolute url, or null if none
getFootprintUri (   $url)
& getFootprintUris ( )
protected
Returns
Array of requestData by footprint id
getReferrerId (   $requestData)

Returns the footprint id of the referrer PREREQUISITE: the footprint for the current request has nog yet been registered

Returns
string or null
getRequestUrl (   $requestData)
getRootUrl ( )
moved (   $fromId,
  $direction = null,
  $requestData = null 
)

Informs this about the current movement

Parameters
string$fromIdThe id of the footprint we are moving FROM
String$direction'up', 'down' or no direction
Array$requestDatathe data to be used for storing the request uri PRECONDITION: session is already started
& sessionVar (   $key)
Returns
a reference to a session variable for this baseUrl

Field Documentation

$baseUrl
$contextIds
$footprintsLimit
$footprintUris
$site

The documentation for this class was generated from the following file: