vB_Request
in package
implements
vB_Interface_Timenow
uses
vB_Trait_NoSerialize
AbstractYes
Table of Contents
Interfaces
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- createSession() : mixed
- Creates a session based on client input
- createSessionForUser() : vB_Session
- Creates a session for a specific user
- getAltIp() : mixed
- getCachePageForGuestTime() : mixed
- getIpAddress() : mixed
- getLanguageid() : mixed
- getReferrer() : mixed
- getRequestingUrl() : string
- getScriptPath() : mixed
- getSessionClass() : string
- Returns the name of session class associated to the request
- getSessionHost() : mixed
- getTimeNow() : int
- 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
- setLanguageid() : mixed
Methods
__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>
__wakeup()
public
__wakeup() : void
createSession()
Creates a session based on client input
public
createSession(mixed ...$args) : mixed
Parameters
- $args : mixed
createSessionForUser()
Creates a session for a specific user
public
createSessionForUser(mixed $userid) : vB_Session
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
- $userid : mixed
-
integer The user to create the session for.
Return values
vB_Session —The session created. Not that this will be a subclass of the abstract vB_Session Class
getAltIp()
public
getAltIp() : mixed
getCachePageForGuestTime()
public
getCachePageForGuestTime() : mixed
getIpAddress()
public
getIpAddress() : mixed
getLanguageid()
public
getLanguageid() : mixed
getReferrer()
public
getReferrer() : mixed
getRequestingUrl()
public
getRequestingUrl() : string
Return values
stringgetScriptPath()
public
getScriptPath() : mixed
getSessionClass()
Returns the name of session class associated to the request
public
getSessionClass() : string
Return values
stringgetSessionHost()
public
getSessionHost() : mixed
getTimeNow()
public
getTimeNow() : int
Return values
intgetUseEarlyFlush()
public
getUseEarlyFlush() : mixed
getUserAgent()
public
getUserAgent() : mixed
getVbHttpHost()
public
getVbHttpHost() : mixed
getVbUrlBasePath()
public
getVbUrlBasePath() : mixed
getVbUrlClean()
public
getVbUrlClean() : mixed
getVbUrlPath()
public
getVbUrlPath() : mixed
getVbUrlQuery()
public
getVbUrlQuery() : mixed
getVbUrlQueryRaw()
public
getVbUrlQueryRaw() : 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
getVbUrlWebroot()
public
getVbUrlWebroot() : mixed
isBrowser()
Browser detection system - returns whether or not the visiting browser is the one specified
public
isBrowser(mixed $browser[, mixed $version = 0 ]) : bool
Parameters
- $browser : mixed
- $version : mixed = 0
Return values
boolsetLanguageid()
public
setLanguageid(mixed $languageid) : mixed
Parameters
- $languageid : mixed