Docs For Class LinkParser

Description

Class used for parsing any BIGACE Link.

It can handle both, Rewriten URLs and normal URLs with GET Parameter. It is also used for splitting the Request into its BIGACE specific parts.

version: $Id: LinkParser.php,v 1.14 2006/11/26 22:04:33 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

Method Summary

LinkParser LinkParser ( $li)

String getAction ()

void getCommand ()

void getDefinition ()

void getDefinitionKey ()

void getExtensions ()

void getFileName ()

void getItemID ()

String getLanguage ()

String getLanguageFromRequest ()

void getLink ()

String getSubAction ()

void parseNormalLink ( $li)

void parseRewritenLink ( $li)

void splitID ( $idToParse)

Methods

Constructor LinkParser (line 72)

LinkParser LinkParser ( $li)

$li

getAction (line 191)

Gets the called Action.

return: the Action Name

String getAction ()

getCommand (line 158)

Returns the requested Command.

void getCommand ()

getDefinition (line 183)

Returns the requested Definition.

deprecated: use getAction() instead

void getDefinition ()

getDefinitionKey (line 207)

Returns the requested key within the Definition.

deprecated: use getSubAction() instead

void getDefinitionKey ()

getExtensions (line 174)

Returns the array with all requested Extensions as key-value Pairs.

void getExtensions ()

getFileName (line 150)

Returns the requested Filename.

void getFileName ()

getItemID (line 166)

Returns the requested ItemID.

void getItemID ()

getLanguage (line 215)

Returns the Language ID for this Request. Will return the Session Language if none was submitted!

return: the Language ID

String getLanguage ()

getLanguageFromRequest (line 227)

Returns the real requested Language ID or NULL.

return: the Language ID or NULL

String getLanguageFromRequest ()

getLink (line 142)

Returns the full - unparsed - Link that was requested.

void getLink ()

getSubAction (line 199)

Returns the requested Sub-Action.

return: the Subaction Name

String getSubAction ()

parseNormalLink (line 85)

Parse a normal URL that uses URL Parameter.

void parseNormalLink ( $li)

$li

parseRewritenLink (line 95)

Parse a URL that was created by using Apaches Mod_Rewrite.

The Command and ID Parameter are hidden in the URL as Path Elements.

void parseRewritenLink ( $li)

$li

splitID (line 114)

Splits the given ID and sets the inner class variables with the splitted values.

void splitID ( $idToParse)

$idToParse