Docs For Class jUrlBase

Class jUrlBase

Description

base class for jUrl and jUrlAction

author: Laurent Jouanneau
copyright: 2005-2006 Laurent Jouanneau
abstract:

Located in /core/jUrl.class.php (line 49)

Direct descendents

Class	Description
jUrlAction	A container to store url data for an action
jUrl	Object that contains url data, and which provides static method helpers

Variable Summary

mixed $params

Method Summary

void clearParam ()

void delParam (string $name)

string getParam (string $name, [string $defaultValue = null])

void setParam (string $name, string $value)

string toString ([boolean $forxml = false])

void __toString ()

Variables

mixed $params = array() (line 54)

parameters

access: public

Methods

clearParam (line 87)

Clear parameters

access: public

void clearParam ()

delParam (line 69)

delete a parameter

access: public

void delParam (string $name)

string $name: parameter name

getParam (line 80)

get a parameter value

return: the value
access: public

string getParam (string $name, [string $defaultValue = null])

string $name: parameter name
string $defaultValue: the default value returned if the parameter doesn't exists

setParam (line 61)

add or change the value of a parameter

access: public

void setParam (string $name, string $value)

string $name: parameter name
string $value: parameter value

toString (line 97)

get the url string corresponding to the url/action

abstract:
access: public

string toString ([boolean $forxml = false])

boolean $forxml: true: some characters will be escaped

Redefined in descendants as:

jUrlAction::toString() : get the url string corresponding to the action
jUrl::toString() : converts the url to a string

__toString (line 103)

magic method for echo and others...

access: public

void __toString ()

Documentation generated on Wed, 07 Sep 2011 13:48:12 +0200 by phpDocumentor 1.4.3