Download the PHP package olafnorge/console-mutex without Composer

Laravel Console Mutex

Prevents overlapping for Laravel console commands.

Table of contents

• Requirements
• Usage
• Strategies
• Advanced
  • Set custom timeout
  • Handle several commands
• Troubleshooting
  • Trait included, but nothing happens?
  • Several traits conflict?

Requirements

• PHP >=5.5.9
• Laravel >=5.1

Usage

1. Install package through composer:

2. Use olafnorge\Console\WithoutOverlapping trait:

Strategies

Overlapping can be prevented by various strategies:

• file (default)
• mysql
• redis
• memcached

Default file strategy is fine for a small applications, which are deployed on a single server. If your application is more complex and, for example, is deployed on a several nodes, then you probably would like to use some other mutex strategy.

You can change mutex strategy by specifying $mutexStrategy field:

Or by using setMutexStrategy method:

Advanced

Set custom timeout

By default mutex is checking for a running command, and if it finds such, it just exits. However, you can manually set timeout for a mutex, so it can wait for another command to finish it's execution, instead of just quitting immediately.

You can change mutex timeout by specifying $mutexTimeout field:

Or by using setMutexTimeout method:

There are three possible options for $mutexTimeout field:

• 0 - check without waiting (default);
• {milliseconds} - check, and wait for a maximum of milliseconds specified;
• null - wait, till running command finish it's execution;

Handle several commands

Sometimes it is useful to set common mutex for a several commands. You can easily achieve this by setting them the same mutex name. By default, mutex name is generated based on a command's name and arguments. To change this, just override getMutexName method in your command:

Troubleshooting

Trait included, but nothing happens?

Note, that WithoutOverlapping trait is overriding initialize method:

If your command is overriding initialize method too, then you should call initializeMutex method by yourself:

Several traits conflict?

If you're using some other cool olafnorge/console-% packages, well, then you can find yourself getting "traits conflict". For example, if you're trying to build loggable command, which is protected against overlapping:

You'll get fatal error, the "traits conflict", because both of these traits are overriding initialize method:

If two traits insert a method with the same name, a fatal error is produced, if the conflict is not explicitly resolved.

But don't worry, solution is very simple. Override initialize method by yourself, and initialize traits in required order: