FileMutex

API reference › yii › mutex › FileMutex

class	yii\mutex\FileMutex
Extends	Mutex » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Uses traits	RetryAcquireTrait
Since	2.0
Source	framework/mutex/FileMutex.php

FileMutex implements mutex “lock” mechanism via local file system files.

This component relies on PHP flock() function.

Application configuration example:

[
    'components' => [
        'mutex' => [
            'class' => 'yii\mutex\FileMutex'
        ],
    ],
]

Note: this component can maintain the locks only for the single web server, it probably will not suffice in case you are using cloud server solution.

Warning: due to flock() function nature this component is unreliable when using a multithreaded server API like ISAPI.

See also: Mutex.

Properties

Property	Type	Description	Defined by
$autoRelease	bool	Whether all locks acquired in this process (i.e. local locks) must be released automatically before finishing script execution. Default: true.	Mutex
$behaviors read-only	array<yii\base\Behavior<static>>	List of behaviors attached to this component.	yii\base\Component
$dirMode	int	The permission to be set for newly created directories. Default: 0775.	FileMutex
$fileMode	int|null	The permission to be set for newly created mutex files. Default: null.	FileMutex
$isWindows	bool|null	Whether file handling should assume a Windows file system. Default: null. Available since 2.0.16.	FileMutex
$mutexPath	string	The directory to store mutex files. Default: '@runtime/mutex'.	FileMutex
$retryDelay	int	Number of milliseconds between each try in acquire() until specified timeout times out. Default: 50. Available since 2.0.16.	RetryAcquireTrait

Methods

Method	Description	Defined by
__construct()	Constructor.	yii\base\BaseObject
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
acquire()	Acquires a lock by name.	Mutex
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className() static	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes mutex component implementation dedicated for UNIX, GNU/Linux, Mac OS X, and other UNIX-like operating systems.	FileMutex
isAcquired()	Checks if a lock is acquired by the current process.	Mutex
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
release()	Releases acquired lock. This method will return false in case the lock was not found.	Mutex
trigger()	Triggers an event.	yii\base\Component
acquireLock() protected	Acquires lock by given name.	FileMutex
getLockFilePath() protected	Generate path for lock file.	FileMutex
releaseLock() protected	Releases lock by given name.	FileMutex

Property details

$dirMode

public int $dirMode = 0775

The permission to be set for newly created directories.

This value will be used by PHP chmod() function. No umask will be applied. Defaults to 0775, meaning the directory is read-writable by owner and group, but read-only for other users.

$fileMode

public int|null $fileMode = null

The permission to be set for newly created mutex files.

This value will be used by PHP chmod() function. No umask will be applied. If not set, the permission will be determined by the current environment.

$isWindows

public bool|null $isWindows = null

Whether file handling should assume a Windows file system.

This value will determine how releaseLock() goes about deleting the lock file. If not set, it will be determined by checking the DIRECTORY_SEPARATOR constant.

Since

2.0.16

$mutexPath

public string $mutexPath = '@runtime/mutex'

The directory to store mutex files.

You may use path alias here. Defaults to the “mutex” subdirectory under the application runtime path.

Method details

init()

public function init(): mixed

Initializes mutex component implementation dedicated for UNIX, GNU/Linux, Mac OS X, and other UNIX-like operating systems.

Returns

mixed

Throws

• yii\base\InvalidConfigException

acquireLock()

protected function acquireLock(string $name, int $timeout = 0): bool

Acquires lock by given name.

Parameters

Parameter	Type	Description
$name	string	Of the lock to be acquired.
$timeout	int	Time (in seconds) to wait for lock to become released.

Returns

bool: Acquiring result.

getLockFilePath()

protected function getLockFilePath(string $name): string

Generate path for lock file.

Parameters

Parameter	Type	Description
$name	string

Returns

string

Since

2.0.10

releaseLock()

protected function releaseLock(string $name): bool

Releases lock by given name.

Parameters

Parameter	Type	Description
$name	string	Of the lock to be released.

Returns

bool: Release result.