Can be done on the throttle provider (global) level or on a throttle instance itself.

Example

Enables the throttling feature.

Can be done on the throttle provider (global) level or on a throttle instance itself.

Example

$throttleProvider = Sentry::getThrottleProvider();
// Enable the Throttling Feature
$throttleProvider->enable();

Checks to see if the throttling feature is enabled or disabled.

Example

// Get the Throttle Provider
$provider = Sentry::getThrottleProvider();
// Check if the Throttling feature is enabled or disabled
if($provider->isEnabled())
{
    // The Throttling Feature is Enabled
}
else
{
    // The Throttling Feature is Disabled
}

Ban user(s)

Bans the user associated with the throttle.

try
{
    // Find the user using the user id
    $throttle = Sentry::findThrottlerByUserId(1);
    // Ban the user
    $throttle->ban();
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Unban user(s)

Unbans the user associated with the throttle.

try
{
    // Find the user using the user id
    $throttle = Sentry::findThrottlerByUserId(1);
    // Unban the user
    $throttle->unBan();
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Check if a User is Banned

{
    $throttle = Sentry::findThrottlerByUserId(1);
    if($banned = $throttle->isBanned())
    {
        // User is Banned
    }
    else
    {
        // User is not Banned
    }
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Suspend user(s)

Suspends a user temporarily. Length of the suspension is set by the driver or setSuspensionTime($minutes).

Unsuspend user(s)

Unsuspends a login. This also clears all previous attempts by the specified login if they were suspended.

try
    // Find the user using the user id
    $throttle = Sentry::findThrottlerByUserId(1);
    // Unsuspend the user
    $throttle->unsuspend();
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Check if a User is Suspended

Checks to see if the user is suspended.

try
{
    $throttle = Sentry::findThrottlerByUserId(1);
    if($suspended = $throttle->isSuspended())
    {
        // User is Suspended
    }
    else
    {
        // User is not Suspended
    }
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Set the User Suspension Time

Sets the length of the suspension.

try
{
    $throttle = Sentry::findThrottlerByUserId(1);
    $throttle->setSuspensionTime(10);
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Get the User Suspension Time

Retrieves the length of the suspension time set by the throttling driver.

try
{
    $throttle = Sentry::findThrottlerByUserId(1);
    $suspensionTime = $throttle->getSuspensionTime();
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Add a Login Attempt

Adds an attempt to the throttle object.

try
{
    $throttle->addLoginAttempt();
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Get Login Attempts

Clear Login Attempts

Clears all login attempts, it also unsuspends them. This does not unban a login.

try
    $throttle = Sentry::findThrottlerByUserId(1);
    $throttle->clearLoginAttempts();
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Check the User Throttle Status

Checks the login throttle status and throws a number of Exceptions upon failure.

try
{
    $throttle = Sentry::findThrottlerByUserId(1);
    if ($throttle->check())
    {
        echo 'Good to go.';
    }
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}
catch (Cartalyst\Sentry\Throttling\UserSuspendedException $e)
{
    $time = $throttle->getSuspensionTime();
    echo "User is suspended for [$time] minutes.";
}
catch (Cartalyst\Sentry\Throttling\UserBannedException $e)
{
    ehco 'User is banned.';
}

Set Attempt Limit

Sets the number of attempts allowed before suspension.

try
{
    $throttle = Sentry::findThrottlerByUserId(1);
    $throttle->setAttemptLimit(3);
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Get Attempt Limit

Retrieves the number of attempts allowed by the throttle object.

try
{
    $throttle = Sentry::findThrottlerByUserId(1);
    $attemptLimit = $throttle->getAttemptLimit();
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';
}

Exceptions

Below is a list of exceptions that the methods can throw.

Find a User by their Id

Retrieves a throttle object based on the user ID provided. Will always retrieve a throttle object.

try
{
    $throttle = Sentry::findThrottlerByUserId(1);
}
catch (Cartalyst\Sentry\Users\UserNotFoundException $e)
{
    echo 'User was not found.';

Find a User by their Login

Exceptions

Below is a list of exceptions that the methods can throw.