vB_Request_WebApi
extends vB_Request_Web
in package
Table of Contents
Constants
- COOKIE_SALT = "OmrGuEyxxgTOo4oXhwI6C6GR47iqYgwwn"
Properties
- $COOKIE_SALT : mixed
Methods
- __construct() : mixed
- createSession() : mixed
- createSessionNew() : mixed
- Creates a session object and attach it to the request. May reuse an existing session in the database.
- getScriptPath() : mixed
- getVbHttpHost() : mixed
- getVbUrlBasePath() : mixed
- getVbUrlClean() : mixed
- getVbUrlPath() : mixed
- getVbUrlQuery() : mixed
- getVbUrlQueryRaw() : mixed
- getVbUrlScheme() : mixed
- getVbUrlWebroot() : mixed
- setCookieSalt() : mixed
- Overrides the default cookie salt. Required for vB Cloud.
- stripSessionhash() : string
- Strips out the s=gobbledygook& rubbish from URLs Extracted from vB_Input_Cleaner
Constants
COOKIE_SALT
public
mixed
COOKIE_SALT
= "OmrGuEyxxgTOo4oXhwI6C6GR47iqYgwwn"
Properties
$COOKIE_SALT
public
static mixed
$COOKIE_SALT
= "OmrGuEyxxgTOo4oXhwI6C6GR47iqYgwwn"
Methods
__construct()
public
__construct() : mixed
createSession()
public
createSession(mixed ...$args) : mixed
Parameters
- $args : mixed
createSessionNew()
Creates a session object and attach it to the request. May reuse an existing session in the database.
public
createSessionNew(string $sessionhash, array<string|int, mixed> $restoreSessionInfo) : mixed
Parameters
- $sessionhash : string
-
-- the token given to the client for session handling. If the client has this token they can use the session.
- $restoreSessionInfo : array<string|int, mixed>
-
-- Information to handle "remember me" logic.
- remembermetoken -- Token value for "remember me". Stored in the "password" cookie for legacy reasons. There are so special values to indicate that we should reauthentic via a method other than the internal vB remember me system.
- userid -- user we are remembering
- fbsr_{appid} (optional) -- Only valid if facebook is enabled, and only used if "remembermetoken" is "facebook".
@return array
- sessionhash -- the session hash for the session created. This may be different from the passed sessionhash if that session was expired or otherwise unusable.
- remembermetoken -- token for remembering the user. This should only be set if the user requests it (or if the there is already a token present but the token changed). It is possible for this to change and if it does and is not passed back to the client future attempts to "remember" the session (using the old value) will fail.
getScriptPath()
public
getScriptPath() : 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()
public
getVbUrlScheme() : mixed
getVbUrlWebroot()
public
getVbUrlWebroot() : mixed
setCookieSalt()
Overrides the default cookie salt. Required for vB Cloud.
public
static setCookieSalt(string $salt) : mixed
Parameters
- $salt : string
stripSessionhash()
Strips out the s=gobbledygook& rubbish from URLs Extracted from vB_Input_Cleaner
public
static stripSessionhash(mixed $string) : string
Parameters
- $string : mixed