Docs For Class Router

Class Router

Description

abstract: Manages urls and relation to our application

Located in /router/Router.php (line 15)

Method Summary

Router __construct ()

mixed arg (integer $index)

string decodeForRewriteUrl (string $var)

string encodeForRewriteUrl (string $var)

string getApplicationUrl ()

string getDomainUrl ()

string getFullUrl ()

string getInterfaceUrl ([string $interface = false])

array getMappedArguments ()

string getModulePath ([ $module = false], [ $interface = false])

string getModuleUrl ([string $module_name = false])

string getParentModule ()

string getPath ()

integer getPort ()

string getSelectedArguments ()

string getSelectedMethod ()

string getSelectedModule ()

string getStaticContentUrl ()

string getUploadsUrl ()

boolean here ([string $module = false], [string $method = false])

string identifyModuleForLoad ()

void loadFromUrl ()

void redirect ([string $method = false], [array $bits = false], [string $module = false])

void returnToReferrer ()

void setReturnToReferrer ()

Methods

Constructor __construct (line 53)

abstract: Constructor
access: public

Router __construct ()

arg (line 400)

abstract: Check for an argument index
access: public

mixed arg (integer $index)

integer $index

decodeForRewriteUrl (line 599)

abstract: Decodes a string for use in the url
access: public

string decodeForRewriteUrl (string $var)

string $var

encodeForRewriteUrl (line 583)

abstract: Encodes a string for use in the url
access: public

string encodeForRewriteUrl (string $var)

string $var

getApplicationUrl (line 435)

abstract: Returns the absolute url to the aspen installation path.
access: public

string getApplicationUrl ()

getDomainUrl (line 459)

abstract: Returns the protocol / domain name only
access: public

string getDomainUrl ()

getFullUrl (line 420)

abstract: Returns a full URL path for the current page, query string and all
access: public

string getFullUrl ()

getInterfaceUrl (line 533)

abstract: Returns an absolute url to the current interface application.
access: public

string getInterfaceUrl ([string $interface = false])

string $interface

getMappedArguments (line 410)

abstract: Return an array of current arguments
access: public

array getMappedArguments ()

getModulePath (line 614)

abstract: Returns the server path to our module
access: public

string getModulePath ([ $module = false], [ $interface = false])

$module
$interface

getModuleUrl (line 570)

abstract: Returns an absolute URL to the module folder
access: public

string getModuleUrl ([string $module_name = false])

string $module_name

getParentModule (line 255)

abstract: Determines the parent of the current module, mainly for navigation purposes.
access: public

string getParentModule ()

getPath (line 478)

abstract: Attempts to return the post-domain name path to our application (minus interface)
access: public

string getPath ()

getPort (line 449)

abstract: Returns the current port number
access: public

integer getPort ()

getSelectedArguments (line 245)

abstract: Returns all current method arguments
access: public

string getSelectedArguments ()

getSelectedMethod (line 235)

abstract: Returns the currently selected method
access: public

string getSelectedMethod ()

getSelectedModule (line 225)

abstract: Returns the currently selected module
access: public

string getSelectedModule ()

getStaticContentUrl (line 558)

abstract: Returns the static content path if set in config, otherwise just interfaceUrl
access: public

string getStaticContentUrl ()

getUploadsUrl (line 544)

abstract: Returns the url to the file upoads directory
access: public

string getUploadsUrl ()

here (line 633)

abstract: Answers whether or not the user is in a specific location
access: public

boolean here ([string $module = false], [string $method = false])

string $module
string $method

identifyModuleForLoad (line 135)

abstract: Identifies which module needs to be loaded
access: public

string identifyModuleForLoad ()

loadFromUrl (line 306)

abstract: Calls the module/method with arguments from the url
access: public

void loadFromUrl ()

redirect (line 696)

abstract: Redirects user to an inner-application module/method address.
access: public

void redirect ([string $method = false], [array $bits = false], [string $module = false])

string $method
array $bits
string $module

returnToReferrer (line 680)

abstract: Returns the user to the referring page when called
access: public

void returnToReferrer ()

setReturnToReferrer (line 667)

abstract: Sets the referring page for future reference
access: public

void setReturnToReferrer ()

Documentation generated on Wed, 15 Apr 2009 17:03:40 -0700 by phpDocumentor 1.4.1