[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: LinkParser

Source Location: /CORE/system/classes/parser/LinkParser.php

Class LinkParser

Class Overview

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.

Located in /CORE/system/classes/parser/LinkParser.php [line 40]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: LinkParser.php,v 1.25 2008/12/12 14:23:23 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Method Summary

LinkParser	LinkParser()
String	getAction()	Gets the called Action.
void	getCommand()	Returns the requested Command.
void	getDefinition()	Returns the requested Definition.
void	getDefinitionKey()	Returns the requested key within the Definition.
void	getExtensions()	Returns the array with all requested Extensions as key-value Pairs.
void	getFileName()	Returns the requested Filename.
void	getItemID()	Returns the requested ItemID.
String	getLanguage()	Returns the requested language or null, if none was set.
String	getLanguageFromRequest()	Returns the real requested Language ID or NULL.
void	getLink()	Returns the full - unparsed - Link that was requested.
String	getSubAction()	Returns the requested Sub-Action.
void	setLanguage()
void	splitID()	Splits the given ID and sets the inner class variables with the splitted values.

[ Top ]

Methods

Constructor LinkParser [line 79]

LinkParser LinkParser(

$li 
)

Parameters:

$li:

[ Top ]

getAction [line 197]

String getAction(
)

Gets the called Action.

API Tags:

Return:

the Action Name

[ Top ]

getCommand [line 167]

void getCommand(
)

Returns the requested Command.

[ Top ]

getDefinition [line 189]

void getDefinition(
)

Returns the requested Definition.

API Tags:

Deprecated:

use getAction() instead

[ Top ]

getDefinitionKey [line 213]

void getDefinitionKey(
)

Returns the requested key within the Definition.

API Tags:

Deprecated:

use getSubAction() instead

[ Top ]

getExtensions [line 181]

void getExtensions(
)

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

[ Top ]

getFileName [line 160]

void getFileName(
)

Returns the requested Filename.

[ Top ]

getItemID [line 174]

void getItemID(
)

Returns the requested ItemID.

[ Top ]

getLanguage [line 221]

String getLanguage(
)

Returns the requested language or null, if none was set.

API Tags:

Return:

a locale

[ Top ]

getLanguageFromRequest [line 233]

String getLanguageFromRequest(
)

Returns the real requested Language ID or NULL.

API Tags:

Return:

the Language ID or NULL

[ Top ]

getLink [line 153]

void getLink(
)

Returns the full - unparsed - Link that was requested.

[ Top ]

getSubAction [line 205]

String getSubAction(
)

Returns the requested Sub-Action.

API Tags:

Return:

the Subaction Name

[ Top ]

setLanguage [line 225]

void setLanguage(

$lang 
)

Parameters:

$lang:

[ Top ]

splitID [line 96]

void splitID(

$idToParse, [
$findUniqueID = false] 
)

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

Parameters:

	$idToParse:
	$findUniqueID:

[ Top ]