jUrlAction
extends jUrlBase
in package
A container to store url data for an action.
Tags
Table of Contents
- $needsHttps : mixed
- $params : mixed
- parameters.
- $requestType : string
- the request type.
- __construct() : mixed
- constructor.
- __toString() : mixed
- magic method for echo and others.
- clearParam() : mixed
- Clear parameters.
- delParam() : mixed
- delete a parameter.
- getParam() : string
- get a parameter value.
- setParam() : mixed
- add or change the value of a parameter.
- toString() : string
- get the url string corresponding to the action.
- toUrl() : jUrl
- get the jUrl object corresponding to the action.
Properties
$needsHttps
public
mixed
$needsHttps
= \false
Tags
$params
parameters.
public
mixed
$params
= array()
Tags
$requestType
the request type.
public
string
$requestType
= ''
Tags
Methods
__construct()
constructor.
public
__construct([mixed $params = array() ][, mixed $request = '' ]) : mixed
..
Parameters
- $params : mixed = array()
- $request : mixed = ''
Tags
Return values
mixed —__toString()
magic method for echo and others.
public
__toString() : mixed
..
Tags
Return values
mixed —clearParam()
Clear parameters.
public
clearParam() : mixed
Tags
Return values
mixed —delParam()
delete a parameter.
public
delParam(string $name) : mixed
Parameters
- $name : string
-
parameter name
Tags
Return values
mixed —getParam()
get a parameter value.
public
getParam(string $name[, string $defaultValue = null ]) : string
Parameters
- $name : string
-
parameter name
- $defaultValue : string = null
-
the default value returned if the parameter doesn't exists
Tags
Return values
string —the value
setParam()
add or change the value of a parameter.
public
setParam(string $name, string $value) : mixed
Parameters
- $name : string
-
parameter name
- $value : string
-
parameter value
Tags
Return values
mixed —toString()
get the url string corresponding to the action.
public
toString([bool $forxml = false ]) : string
Parameters
- $forxml : bool = false
-
true: some characters will be escaped
Tags
Return values
string —toUrl()
get the jUrl object corresponding to the action.
public
toUrl() : jUrl