vB_Request_Test
extends vB_Request
in package
Table of Contents
- __construct() : mixed
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- adjustTimeNow() : mixed
- Change the request time for test purposes
- createSession() : mixed
- Creates a session based on client input
- createSessionForUser() : mixed
- Creates a session for a specific user
- getAltIp() : mixed
- getCachePageForGuestTime() : mixed
- getIpAddress() : mixed
- getLanguageid() : mixed
- getReferrer() : mixed
- getScriptPath() : mixed
- getSessionClass() : string
- Returns the name of session class associated to the request
- getSessionHost() : mixed
- getTimeNow() : mixed
- getUseEarlyFlush() : mixed
- getUserAgent() : mixed
- getVbHttpHost() : mixed
- getVbUrlBasePath() : mixed
- getVbUrlClean() : mixed
- getVbUrlPath() : mixed
- getVbUrlQuery() : mixed
- getVbUrlQueryRaw() : mixed
- getVbUrlScheme() : mixed
- These are mostly only meaningful for web requests, but we need to keep a consistant interface for requests so provide a trivial default here.
- getVbUrlWebroot() : mixed
- isBrowser() : bool
- Browser detection system - returns whether or not the visiting browser is the one specified
- setIpAddress() : mixed
- Allows setting the IP address for test purposes.
- setLanguageid() : mixed
- setSessionClass() : mixed
- setTimeNow() : mixed
- Set the request time for test purposes
Methods
__construct()
public
__construct(mixed $vars) : mixed
Parameters
- $vars : mixed
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed> —__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
Return values
void —__wakeup()
public
__wakeup() : void
Return values
void —adjustTimeNow()
Change the request time for test purposes
public
adjustTimeNow( $time) : mixed
Parameters
Return values
mixed —createSession()
Creates a session based on client input
public
createSession(mixed ...$args) : mixed
Parameters
- $args : mixed
Return values
mixed —createSessionForUser()
Creates a session for a specific user
public
createSessionForUser( $userid) : mixed
Used to create session for a particular user based on the current request information. Useful for creating a session after the user logs in. This will overwrite the current Session in this request class and the vB current session.
Parameters
Return values
mixed —getAltIp()
public
getAltIp() : mixed
Return values
mixed —getCachePageForGuestTime()
public
getCachePageForGuestTime() : mixed
Return values
mixed —getIpAddress()
public
getIpAddress() : mixed
Return values
mixed —getLanguageid()
public
getLanguageid() : mixed
Return values
mixed —getReferrer()
public
getReferrer() : mixed
Return values
mixed —getScriptPath()
public
getScriptPath() : mixed
Return values
mixed —getSessionClass()
Returns the name of session class associated to the request
public
getSessionClass() : string
Return values
string —getSessionHost()
public
getSessionHost() : mixed
Return values
mixed —getTimeNow()
public
getTimeNow() : mixed
Return values
mixed —getUseEarlyFlush()
public
getUseEarlyFlush() : mixed
Return values
mixed —getUserAgent()
public
getUserAgent() : mixed
Return values
mixed —getVbHttpHost()
public
getVbHttpHost() : mixed
Return values
mixed —getVbUrlBasePath()
public
getVbUrlBasePath() : mixed
Return values
mixed —getVbUrlClean()
public
getVbUrlClean() : mixed
Return values
mixed —getVbUrlPath()
public
getVbUrlPath() : mixed
Return values
mixed —getVbUrlQuery()
public
getVbUrlQuery() : mixed
Return values
mixed —getVbUrlQueryRaw()
public
getVbUrlQueryRaw() : mixed
Return values
mixed —getVbUrlScheme()
These are mostly only meaningful for web requests, but we need to keep a consistant interface for requests so provide a trivial default here.
public
getVbUrlScheme() : mixed
Return values
mixed —getVbUrlWebroot()
public
getVbUrlWebroot() : mixed
Return values
mixed —isBrowser()
Browser detection system - returns whether or not the visiting browser is the one specified
public
isBrowser(mixed $browser, mixed $version) : bool
Parameters
- $browser : mixed
- $version : mixed
Return values
bool —setIpAddress()
Allows setting the IP address for test purposes.
public
setIpAddress(mixed $ipaddress) : mixed
This should not be used by production code (nor should this entire class).
Parameters
- $ipaddress : mixed
Return values
mixed —setLanguageid()
public
setLanguageid(mixed $languageid) : mixed
Parameters
- $languageid : mixed
Return values
mixed —setSessionClass()
public
setSessionClass(mixed $class) : mixed
Parameters
- $class : mixed
Return values
mixed —setTimeNow()
Set the request time for test purposes
public
setTimeNow( $time) : mixed