CSAuthenticationParameter
in package
This class defines CSAuthenticationParameter object
Tags
Table of Contents
- ORIGIN_ALL = self::ORIGIN_GET | self::ORIGIN_POST | self::ORIGIN_COOKIE | self::ORIGIN_SESSION | self::ORIGIN_HEADER
- ORIGIN_COOKIE = 4
- ORIGIN_GET = 1
- ORIGIN_HEADER = 16
- ORIGIN_POST = 2
- ORIGIN_SESSION = 8
- __construct() : mixed
- getName() : string
- Gets the name of the parameter
- getOrigin() : int
- Get the current origin of the parameter
- hasOrigin() : bool
- Checks if this parameter contains an origin
- isSensitive() : bool
- Returns whether this parameter is a sensitive one
Constants
ORIGIN_ALL
public
mixed
ORIGIN_ALL
= self::ORIGIN_GET | self::ORIGIN_POST | self::ORIGIN_COOKIE | self::ORIGIN_SESSION | self::ORIGIN_HEADER
Tags
ORIGIN_COOKIE
public
mixed
ORIGIN_COOKIE
= 4
Tags
ORIGIN_GET
public
mixed
ORIGIN_GET
= 1
Tags
ORIGIN_HEADER
public
mixed
ORIGIN_HEADER
= 16
Tags
ORIGIN_POST
public
mixed
ORIGIN_POST
= 2
Tags
ORIGIN_SESSION
public
mixed
ORIGIN_SESSION
= 8
Tags
Methods
__construct()
public
__construct(string $sName[, int $iOrigin = CSAuthenticationParameter::ORIGIN_ALL ][, bool $bSensitive = false ]) : mixed
Parameters
- $sName : string
- $iOrigin : int = CSAuthenticationParameter::ORIGIN_ALL
- $bSensitive : bool = false
Tags
Return values
mixed —getName()
Gets the name of the parameter
public
getName() : string
Tags
Return values
string —getOrigin()
Get the current origin of the parameter
public
getOrigin() : int
Tags
Return values
int —bitwise integer number for representing all origins this parameter is present in.
hasOrigin()
Checks if this parameter contains an origin
public
hasOrigin(int $iOrigin) : bool
Parameters
- $iOrigin : int
Tags
Return values
bool —isSensitive()
Returns whether this parameter is a sensitive one
public
isSensitive() : bool
