SproutCMS

This is the code documentation for the SproutCMS project

Page options:

Inherited members

class UserAuth

Stub class for when the users module is not installed

Makes use of the fact that it's legal to call static
methods from instances

Will load the 'Helpers\UserAuth' class from the namespace
registered for the feature "users".

Variables

NameVisibilityDescription
$user_auth_inst (static)
Cached instance across multiple calls. FALSE = not yet loaded

Functions

NameVisibilityDescription
getIdpublic (static)Gets id of logged-in user
isLoggedInpublic (static)Stub method for when the users module is not installed
realUserAuthInstprotected (static)Create an instance of the "real" user perms class, if it's available.

public getId

int UserAuth::getId ( );

Gets id of logged-in user
See SproutModules\Karmabunny\Users\Helpers\UserAuth::getId

public isLoggedIn

bool UserAuth::isLoggedIn ( );

Stub method for when the users module is not installed
See SproutModules\Karmabunny\Users\Helpers\UserAuth::isLoggedIn

protected realUserAuthInst

null|object UserAuth::realUserAuthInst ( );

Create an instance of the "real" user perms class, if it's available.