SproutCMS

This is the code documentation for the SproutCMS project

function logHit()

Log a hit against the rate-limit system

Usage

void RateLimit::logHit ( string $event , bool $success , string $username );

Arguments

  1. string $event
    The event being done by the user, e.g. 'user-auth-action' or 'form-submit-action'
  2. bool $success
    The status of the event, true for success, false for failure
  3. string $username
    $user The user who performed the event

Return value

  • void