Class idle

Description

Located in /includes/class/Class.idle.php (line 28)


	
			
Method Summary
bool add (string $nick)
bool check_dosave ([bool $if_ready = true])
bool exists (string $nick)
mixed get_object (string $nick)
int get_points (string $nick)
mixed get_time (string $nick)
unknown_type remove ($nick $nick, [$save $save = true])
Methods
add (line 39)

Starts the idle monitor for the given nickname.

bool add (string $nick)
  • string $nick
check_dosave (line 179)

Checks for all users that should receive a idle bonus

and performs the updates. $if_ready can be set to false to force an update, even if the given time since last update is less than 3 hours. --- currently broken.

bool check_dosave ([bool $if_ready = true])
  • bool $if_ready
exists (line 160)

Check if the given user is getting bonuses

bool exists (string $nick)
  • string $nick
get_object (line 73)

Get an already active idle clients object.

Returns false or an idle object.

mixed get_object (string $nick)
  • string $nick
get_points (line 91)

Get the current idle points for a user.

int get_points (string $nick)
  • string $nick
get_time (line 108)

Get the time the user started getting idle bonus this session.

Returns it or false.

mixed get_time (string $nick)
  • string $nick
remove (line 128)

Remove a user from the idle monitoring, and save their current settings.

-- currently disabled

unknown_type remove ($nick $nick, [$save $save = true])
  • $nick $nick
  • $save $save

Documentation generated on Thu, 19 Nov 2009 20:25:17 -0700 by phpDocumentor 1.4.1