Exponent v2.4.3
Back to top  

expRouter

This is the class expRouter

package

Subsystems
subpackage

Subsystems

Methods

__construct

__construct()

buildCurrentUrl

buildCurrentUrl()

Get the SEF URL from the server if we got an old school url, it will only contain the 'index.php'

buildSEFPath()

buildUrlByPageId

buildUrlByPageId( $id = null)

Arguments

$id

remove trailing slash

cleanLink( $fulllink) : string
static

Arguments

$fulllink

Response

string

Convert url_parts() or $_REQUEST to $params

convertPartsToParams() : array|string

Response

array|string

convertToOldSchoolUrl

convertToOldSchoolUrl()

decode

decode( $url)
static

Arguments

$url

encode

encode( $url)
static

Arguments

$url

exportAsPDFLink

exportAsPDFLink( $link_text = "Export as PDF",  $class = null,  $width = 800,  $height = 600,  $view = '',  $orientation = false,  $limit = '',  $title_text = "Export as PDF")

Arguments

$link_text

$class

$width

$height

$view

$orientation

$limit

$title_text

Attempt to locate a page by name or id

getPageByName( $url_name) : null|object|void

Arguments

$url_name

Response

null|object|void

getRouterMaps

getRouterMaps()

getSection

getSection()

getSectionObj

getSectionObj( $section)

Arguments

$section

getSefUrlByPageId

getSefUrlByPageId( $id = null)

Arguments

$id

getTrackingId

getTrackingId()

figure out if this action is mapped via the mapping file (router_maps.php)

isMappedURL()

Will build url to a module/page/etc (determined by what is passed to the $params array).

makeLink(array $params, boolean $force_old_school = false, boolean $secure = false, boolean $no_map = false) : string

Arguments

$params

array

The params that are passed will determine what link is make section action sef_name module controller action

$force_old_school

boolean

Old School as in not SEF.

$secure

boolean

If you set $secure true but ENABLE_SSL is not turned on in the config this will be forced false

$no_map

boolean

Ignore router_maps

Response

string

A url

Returns a cleaner canonical link sans 'src' param

plainPath() : string

Response

string

printerFriendlyLink

printerFriendlyLink( $link_text = "Printer Friendly",  $class = null,  $width = 800,  $height = 600,  $view = '',  $title_text = "Printer Friendly")

Arguments

$link_text

$class

$width

$height

$view

$title_text

Check and set up for an action request

routeActionRequest() : boolean

Response

boolean

Set up for page request, but check store category/product also

routePageRequest() : boolean
Throws
\ReflectionException

Response

boolean

routeRequest

routeRequest()

Assign url_type & url_style

splitURL()

updateHistory

updateHistory( $section = null)

Arguments

$section

Properties

maps

maps :

Type(s)

url_parts

url_parts :

Type(s)

current_url

current_url :

Type(s)

Type of url either 'base' (default page), 'page', 'action', or 'malformed'

url_type : string
var

Type(s)

string

Style of url either 'sef' or 'query'

url_style : string
var

Type(s)

string

params

params :

Type(s)

sefPath

sefPath :

Type(s)