require_once('yoslogin.lib.php');

//retrieve user information from your database (or any source of your choice)
function myOwnGetUserFunction($login) {
    //must return an array with at least those items: array('login' => '', 'password' => '')
}

$logger = new \Yosko\YosLogin(
    //required: the name to give to the session on your users computers
    'exampleSessionName',

    //required: callback function/method to let YosLogin retrieve a user's login & password hash
    'myOwnGetUserFunction',

    //optional: path to a log file where YosLogin should trace authentication actions
    'yoslogin.log'
);

//when user asks to log out from your website, destroy his/her sessions
$logger->logOut();

//when user just filled the login form
$user = $logger->logIn($_POST['login'], $_POST['password']);

//if no specific action was done, check if user is logged in
$user = $logger->authUser();

//when user reenter his password to do important actions such as changing email/password
$user = $logger->authUser($_POST['password']);

//check if authenticated user or anonymous
if($user['isLoggedIn'] === true) {
    //check if user recently entered his/her password, and didn't change IP since
    //use it for important actions such as when the user wants to change his/her email or password
    if($user['secure'] === true) {

    }
} else {
    //show the login form if you are on a user restricted area
}

//optional: redirection page after a successful login/logout/secure/unsecure
//if not used or empty value given (''), redirection to the same URL without GET parameters
//if false, no redirection is done at all
$logger->setRedirectionPage('');

//optional: whether to allow local IPs or not (default if not called: false. Setting it to true can be less secure)
$logger->setAllowLocalIp(true);

  class MyLongTermSessionManager {
  	    //duration of a session (in seconds)
      public static $LTDuration = 2592000;

      //store these information on your server
      public static function setLTSession($login, $sid, $value) {}
      
      //retrieve the $value information based on the two other information
      //or return false if session doesn't exist
      public static function getLTSession($login, $sid) {}
      
      //unset a specific long-term session based on login & sid
      public static function unsetLTSession($login, $sid) {}
      
      //unset all long-term session for this user
      public static function unsetLTSessions($login) {}
      
      //delete sessions older than $LTDuration
      //feel free to also define a maximum number of session to handle at the same time
      public static function flushOldLTSessions() {}
  }

$logger->ltSessionConfig(
    //callbacks
    array(
        //callback for storing a session
        'setLTSession' => array('MyLongTermSessionManager', 'setLTSession'),

        //callback for retrieving a session
        'getLTSession' => array('MyLongTermSessionManager', 'getLTSession'),

        //callback for deleting a session
        'unsetLTSession' => array('MyLongTermSessionManager', 'unsetLTSession'),

        //callback for deleting all sessions of a user
        'unsetLTSessions' => array('MyLongTermSessionManager', 'unsetLTSessions'),

        //callback for flushing old sessions
        'flushOldLTSessions' => array('MyLongTermSessionManager', 'flushOldLTSessions')
    ),

    //duration allowed for a long-term session
    MyLongTermSessionManager::$LTDuration
);

//when user just filled the login form
$user = $logger->logIn($_POST['login'], $_POST['password'], isset($_POST['remember']));

// a function name (string)
// this is the method used for the "getUser" example above
$callback = 'myFunction';

// a class name and a function name (for static call)
// this is the method used in the long-term example above
$callback = array('myClass', 'myMethod');

// an object instanciated from a class, and the method name (for non-static call)
$callback = array($myObject, 'myMethod');