SproutCMS

This is the code documentation for the SproutCMS project

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".

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-29
**/
class NewClassName extends UserAuth {
    
    /**
    * Create an instance of the &quot;real&quot; user perms class, if it's available.
    **/
    protected function realUserAuthInst () {
        // Method code goes here
    }
    
    /**
    * Stub method for when the users module is not installed
    * See {@see SproutModules\Karmabunny\Users\Helpers\UserAuth::isLoggedIn}
    **/
    public function isLoggedIn () {
        // Method code goes here
    }
    
    /**
    * Gets id of logged-in user
    * See {@see SproutModules\Karmabunny\Users\Helpers\UserAuth::getId}
    **/
    public function getId () {
        // Method code goes here
    }
    
}
?>