ice framework documentation ice doc v1.6.2
Methods
  • autoLogin() : void
    Logs a user in, based on the autologin cookie.
  • completeLogin(variable $user, array $roles) : void
    Complete the login for a user by setting session data and eg. incrementing the logins.
  • getUser(variable $defaultValue) : void
    Gets the currently logged in user from the session. Returns NULL if no user is currently logged in.
  • hasRole(variable $user, string $role) : bool
    Check if user has the role.
  • login(variable $username, string $password, bool $remember, bool $force) : bool | null
    Logs a user in.
  • loginBy(variable $social, bool $remember) : void
    Logs a user in through social network.
  • logout(bool $destroy, bool $logoutAll) : bool
    Log a user out and remove any autologin cookies.
  • refreshUser() : void
    Refresh user data stored in the session.
Methods Details
  • public function autoLogin()

    Logs a user in, based on the autologin cookie.
  • protected function completeLogin(variable $user, array $roles)

    Complete the login for a user by setting session data and eg. incrementing the logins.
  • public function getUser(variable $defaultValue)

    Gets the currently logged in user from the session. Returns NULL if no user is currently logged in.
  • public function hasRole(variable $user, string $role)

    Check if user has the role.
  • public function login(variable $username, string $password, bool $remember, bool $force)

    Logs a user in.
  • public function loginBy(variable $social, bool $remember)

    Logs a user in through social network.
  • public function logout(bool $destroy, bool $logoutAll)

    Log a user out and remove any autologin cookies.
  • public function refreshUser()

    Refresh user data stored in the session.
    Returns null if no user is currently logged in.