ice framework documentation ice doc v1.10.1
Source GitHub
Class Ice Auth

Driver

Methods
  • __construct(array $options) : void
    Loads services and configuration options.
  • checkHash(string $password, string $hash) : bool
    Checks a plain text password and its hash version to check if the password matches.
  • completeLogin(string $user, array $roles) : void
    Complete the login for a user by setting session data and eg. incrementing the logins.
  • getOption(string $key, variable $defaultValue) : void
    Get option value with key.
  • setOption(string $key, variable $value) : void
    Assigns a value to the specified options.
  • getUser(variable $defaultValue) : void
    Gets the currently logged in user from the session. Returns NULL if no user is currently logged in.
  • hash(string $password) : void
    Perform a hmac hash, using the configured method.
  • loggedIn(string $role) : void
    Check if there is an active session. Optionally allows checking for a specific role.
  • logout(bool $destroy, bool $logoutAll) : bool
    Log out a user by removing the related session variables.
  • zephir_init_properties_Ice_Auth_Driver() : void
Methods Details

  • public function __construct(array $options)

    Loads services and configuration options.

  • public function checkHash(string $password, string $hash)

    Checks a plain text password and its hash version to check if the password matches.

  • protected function completeLogin(string $user, array $roles)

    Complete the login for a user by setting session data and eg. incrementing the logins.

  • public function getOption(string $key, variable $defaultValue)

    Get option value with key.

  • public function setOption(string $key, variable $value)

    Assigns a value to the specified options.

  • 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 hash(string $password)

    Perform a hmac hash, using the configured method.

  • public function loggedIn(string $role)

    Check if there is an active session. Optionally allows checking for a specific role.

  • public function logout(bool $destroy, bool $logoutAll)

    Log out a user by removing the related session variables.

  • internal function zephir_init_properties_Ice_Auth_Driver()