AuthToken Class Reference
Create, remove or validate token, which can be used for API autentification. More...
Inheritance diagram for AuthToken:
Public Member Functions | |
| __construct ($expireSeconds=1800) | |
| Create AuthToken object. More... | |
| validate ($token, $refresh=true) | |
| Validate token. More... | |
| remove ($token) | |
| Remove token. More... | |
| create ($userId) | |
| Create token for user $userId. More... | |
| clear () | |
| Clear expired session from database. | |
 Public Member Functions inherited from BaseObject | |
| loadDefaults ($className=null) | |
| Load default parameters of class $className into object instance. | |
| setProperties (array $defaults) | |
| Set public properties of object from the array. More... | |
| toArray () | |
| Convert object to array. More... | |
Data Fields | |
| $db | |
| var Db | |
| Data Fields inherited from BaseObject | |
| $serviceLocator | |
| var function() Return service object when requested with service(). | |
Additional Inherited Members | |
| Static Public Member Functions inherited from BaseObject | |
| static | defaults (... $args) |
| Set or retireve default parameters of the object. More... | |
| Protected Member Functions inherited from BaseObject | |
| service ($service, $default=null) | |
| Try acquire $service and load it into property $this->$service. More... | |
Detailed Description
Create, remove or validate token, which can be used for API autentification.
Tokens are stored in database table PCLIB_TOKENS.
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | $expireSeconds = 1800 | ) |
Create AuthToken object.
- Parameters
-
int $expireSeconds Token time to live
Member Function Documentation
◆ create()
| create | ( | $userId | ) |
Create token for user $userId.
- Parameters
-
int $userId
- Returns
- string $token
◆ remove()
| remove | ( | $token | ) |
Remove token.
- Parameters
-
string $token
◆ validate()
| validate | ( | $token, | |
$refresh = true |
|||
| ) |
Validate token.
- Parameters
-
string $token bool $refresh If true, token time to live will be updated bool $isValid
The documentation for this class was generated from the following file:
