PEAR Manual
Prev |  | Next

# Auth::setIdle()

Auth::setIdle() -- set maximum idle time for authentication

## Synopsis

``void Auth::setIdle` (integer $time [, boolean $add = `FALSE`])`

## Description

With this function one can set the maximum idle time to a new value. The term "idle time" describes the maximum time interval (in seconds) between two actions by the user. If the maximum idle time is reached, the user will be automatically logged out. If on the other hand the user performs any action within the maximum idle time interval, the idle time is reset.

## Parameter

integer `$time`

  idle time in seconds

boolean `$add`

  if `TRUE` `$time` is added to the existing idle time, if `FALSE` the existing time value will be replaced.

## Note

This function can not be called statically.

Prev | Home | Next
Auth::setExpire() | Up | Auth::start()