SPath Class Reference

Builds all the URLs commonly needed by web apps. More...

Inheritance diagram for SPath:

[legend]

List of all members.

Static Public Member Functions
static	getFullPath ($type)
	Build a complete URL (includes protocol/host).
static	getRelPath ($type)
	Build a relative URL (does not include protocol/host).

---

Detailed Description

Builds all the URLs commonly needed by web apps.

SPath generates a number of commonly used URLs, such as those to the server, project home, public and UI directories, etc.

Author:

Jonathan (jwsm@shodor.org)

Date:

Updated 11/21/08

Definition at line 11 of file SPath.php5.

---

Member Function Documentation

static SPath::getFullPath

(

$

type

)

[static]

Build a complete URL (includes protocol/host).

Parameters:

$type

[string]: The type of URL to construct (see documentation for getRelPath)

Returns:

[string]: The URL string

Calls getRelPath() to build the URL, then prepends the protocol and server name from SConfig.

Definition at line 82 of file SPath.php5.

References SConfig::getOption(), and getRelPath().

Referenced by SDRServiceRequest::__construct(), and SShodorLayout::layoutBottomBar().

static SPath::getRelPath

(

$

type

)

[static]

Build a relative URL (does not include protocol/host).

Parameters:

$type

[string]: The type of URL to construct (see list below)

Returns:

[string]: The URL string

Allowed URL types:

• BaseURL - The base URL after which common and projects are added
• Project - URL for the current site/web app
• UI - URL for the UI directory
• DefaultSkin - The URL (including UI) for the default skin
• CustomSkin - The URL (including UI) for the custom skin
• ProjectCSS - The CSS directory inside the project/public directory
• ProjectJS - The JS directory inside the project/public directory
• ProjectImage - The image directory inside the project
• Common - The base URL for the common directory
• Self - The URL for the currently running script

The values to construct these URLs come from SConfig

Definition at line 33 of file SPath.php5.

References SConfig::getOption(), and SObject::setStaticPrettyError().

Referenced by Pictcha::__construct(), getFullPath(), PageRender2::includeCSS(), PageRender2::includeJS(), SLayout::layoutHead(), Toolkit::prm_getCSSSource(), Toolkit::prm_getJSSource(), PageRender2::renderPrint(), LatexRenderModule::transform(), and STransListXML::translateListPage().

---

The documentation for this class was generated from the following file:

• helpers/SPath.php5