PHPackages                             beaucal/beaucal-long-throttle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. beaucal/beaucal-long-throttle

ActiveLibrary[Utility & Helpers](/categories/utility)

beaucal/beaucal-long-throttle
=============================

Prevent an action for some long amount of time. Hours, day, months, years.

v0.6.0(10y ago)287MITPHPPHP >=5.4

Since May 4Pushed 10y ago2 watchersCompare

[ Source](https://github.com/BeauCal/beaucal-long-throttle)[ Packagist](https://packagist.org/packages/beaucal/beaucal-long-throttle)[ Docs](https://github.com/BeauCal/beaucal-long-throttle)[ RSS](/packages/beaucal-beaucal-long-throttle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (6)Versions (8)Used By (0)

BeaucalLongThrottle
===================

[](#beaucallongthrottle)

[![Build Status](https://camo.githubusercontent.com/21d7b4e5a904a36596195c89b0d9d51d0cc11fa5c0ec033b0706f4a77de9128c/68747470733a2f2f7472617669732d63692e6f72672f4265617543616c2f6265617563616c2d6c6f6e672d7468726f74746c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/BeauCal/beaucal-long-throttle)

**Now with 100% code coverage.**

Prevent an action for some amount of time. Hours, day, months, years, anything. Allows for multiple locks (e.g. 100/day) and clearing/releasing a lock just made. And it works just like it should, every single lock lasts exactly how long you specify and is taken atomically.

**N.B.** This is true/false throttling; this library does not `sleep()`;

### Installation

[](#installation)

1. In `application.config.php`, add as follows:

```
'modules' => [..., 'BeaucalLongThrottle', ...];
```

2. Import into your database `data/beaucal_throttle.sql`:

```
CREATE TABLE IF NOT EXISTS `beaucal_throttle` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY,
  `key` varchar(255) NOT NULL UNIQUE KEY,
  `end_datetime` DATETIME NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
ALTER TABLE `beaucal_throttle` ADD INDEX (`end_datetime`);
```

### To Use

[](#to-use)

Either you get the lock or you don't.

```
// in controller
$throttle = $this->getServiceLocator()->get('BeaucalLongThrottle');

// term?
$term = new DateTimeUnit(2, 'weeks'); // or
$term = new DateTimeEnd(new DateTime('+2 weeks'));

if ($throttle->takeLock('BiWeeklyReport', $term)) {
    // lock is taken atomically, made for 2 weeks: safe to do your work
}
else {
    // locked from before: leave it alone & perhaps try again later
}

/**
 * N.B. May throw \BeaucalLongThrottle\Exception\PhantomLockException, when
 * lock is reported to be set but upon verification step is actually not.
 * This is truly exceptional and shouldn't be just thrown aside.
 */
```

### Allow Multiple Locks

[](#allow-multiple-locks)

You can allow any number of locks e.g. 'lock1' => 5/hour, 'lock2' => 100/day. Here's how:

```
// copy beaucallongthrottle.global.php to your config/autoload/
$throttle = [
// ...
    'adapter_class' => 'BeaucalLongThrottle\Adapter\DbMultiple', // was Adapter\Db
// ...
]
$regexCounts = [
    /**
     * E.g. You can create 3 'do-stuff' locks before the lock can't be taken.
     * Those not matching here are allowed the usual 1.
     */
    '/^do-stuff$/' => 3
];

// in controller
$throttle = $this->getServiceLocator()->get('BeaucalLongThrottle');
$throttle->takeLock('do-stuff', new DateTimeUnit(1, 'day')); // YES
$throttle->takeLock('do-stuff', new DateTimeUnit(1, 'day')); // YES
$throttle->takeLock('do-stuff', new DateTimeUnit(1, 'day')); // YES
$throttle->takeLock('do-stuff', new DateTimeUnit(1, 'day')); // FALSE
// ...
// A DAY LATER
$throttle->takeLock('do-stuff', new DateTimeUnit(1, 'day')); // YES
```

### Clearing Locks

[](#clearing-locks)

```
$throttle = $this->getServiceLocator()->get('BeaucalLongThrottle');
$handle = $throttle->takeLock('year-end', new DateTimeUnit(1, 'year')); // YES
$throttle->takeLock('year-end', new DateTimeUnit(1, 'year')); // FALSE
if ($whoopsBackingOut) {
    $throttle->clearLock($handle);
}
$throttle->takeLock('year-end', new DateTimeUnit(1, 'year')); // YES
```

### Lock with APC

[](#lock-with-apc)

For something more quick-n-dirty, use APC locking. This is adequate for short-term throttling with the usual caveats regarding APC persistence (e.g. some other part of your app might flush the entire cache, a PHP restart, out of memory).

N.B. If `takeLock()` fails, don't try to `sleep()` it out; that won't work for some reason to do with how `apc_add()` works. Instead, handle the no-lock condition then try again next request.

```
// copy beaucallongthrottle.global.php to your config/autoload/
$throttle = [
// ...
    'adapter_class' => 'BeaucalLongThrottle\Adapter\Apc', // was Adapter\Db
// ...
]

// in controller
$throttle = $this->getServiceLocator()->get('BeaucalLongThrottle');

// alternatively, a shortcut factory that doesn't require config
$throttle = $this->getServiceLocator()->get('BeaucalLongThrottle_APC');
```

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~52 days

Recently: every ~77 days

Total

7

Last Release

3719d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/36c24140c7709b9015bdb1d58f0937b0c72801a63ae4b32cc18ba3f71a1eaa23?d=identicon)[dillchuk](/maintainers/dillchuk)

---

Top Contributors

[![dillchuk](https://avatars.githubusercontent.com/u/11740626?v=4)](https://github.com/dillchuk "dillchuk (94 commits)")

---

Tags

zf2throttle

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/beaucal-beaucal-long-throttle/health.svg)

```
[![Health](https://phpackages.com/badges/beaucal-beaucal-long-throttle/health.svg)](https://phpackages.com/packages/beaucal-beaucal-long-throttle)
```

###  Alternatives

[zf-commons/zfc-base

A set of genetic (abstract) classes which are commonly used across multiple modules.

1441.1M25](/packages/zf-commons-zfc-base)[snapshotpl/zf-snap-geoip

MaxMind GeoIP Module for Zend Framework 2

1512.9k](/packages/snapshotpl-zf-snap-geoip)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)