SessionStats class - Documentation for SproutCMS

Info Page:

Page options:

class SessionStats

File: /sprout/Helpers/SessionStats.php
Namespace: Sprout\Helpers

Variables

Name	Visibility	Description
`$do_tracking`	(static)	Should tracking be done? Determined at request start time
`$untracked`	(static)	Prefixes of URLs to ignore

Functions

Name	Visibility	Description
autoDetectSourceMedium	private (static)	Auto-generate UTM params based on the initial request referrer
init	public (static)	Check whether this content should be tracked, and enable tracking in this case
numPageviews	public (static)	Return the number of page views for a given url
referrer	public (static)	The initial HTTP referrer when the session was first started
timeOnSite	public (static)	How long the user has been on the site
timeStart	public (static)	Time the session started
totalPageviews	public (static)	Return the total number of page views
trackPageView	public (static)	Track a page view in the session
trackSession	protected (static)	Session level tracking - utm tags, referrer, etc
uniquePageviews	public (static)	Return the total number of unique page views
utmCampaign	public (static)	Value of the 'utm_campaign' query string parameter
utmContent	public (static)	Value of the 'utm_content' query string parameter
utmMedium	public (static)	Value of the 'utm_medium' query string parameter
utmSource	public (static)	Value of the 'utm_source' query string parameter
utmTerm	public (static)	Value of the 'utm_term' query string parameter

private autoDetectSourceMedium

array SessionStats::autoDetectSourceMedium ( string $referrer );

Auto-generate UTM params based on the initial request referrer

public init

unknown SessionStats::init ( );

Check whether this content should be tracked, and enable tracking in this case

public numPageviews

int SessionStats::numPageviews ( int $url );

Return the number of page views for a given url

public referrer

string SessionStats::referrer ( );

The initial HTTP referrer when the session was first started

public timeOnSite

DateInterval SessionStats::timeOnSite ( );

How long the user has been on the site

public timeStart

DateTime SessionStats::timeStart ( );

Time the session started

public totalPageviews

int SessionStats::totalPageviews ( );

Return the total number of page views

public trackPageView

void SessionStats::trackPageView ( );

Track a page view in the session

protected trackSession

void SessionStats::trackSession ( );

Session level tracking - utm tags, referrer, etc

public uniquePageviews

int SessionStats::uniquePageviews ( );

Return the total number of unique page views

public utmCampaign

string SessionStats::utmCampaign ( );

Value of the 'utm_campaign' query string parameter
from the most recent request which contained this parameter

public utmContent

string SessionStats::utmContent ( );

Value of the 'utm_content' query string parameter
from the most recent request which contained this parameter

public utmMedium

string SessionStats::utmMedium ( );

Value of the 'utm_medium' query string parameter
from the most recent request which contained this parameter

public utmSource

string SessionStats::utmSource ( );

Value of the 'utm_source' query string parameter
from the most recent request which contained this parameter

public utmTerm

string SessionStats::utmTerm ( );

Value of the 'utm_term' query string parameter
from the most recent request which contained this parameter

SproutCMS

Search documentation