Class craft\mutex\FileMutex

Inheritance: craft\mutex\FileMutex » yii\mutex\FileMutex » yii\mutex\Mutex » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/mutex/FileMutex.php

See also \craft\mutex\Mutex.

Public Properties
Property	Type	Description	Defined By
`$autoRelease`	boolean	Whether all locks acquired in this process (i.e. local locks) must be released automatically before finishing script execution.	yii\mutex\Mutex
`$dirMode`	integer	The permission to be set for newly created directories.	yii\mutex\FileMutex
`$fileMode`	integer	The permission to be set for newly created mutex files.	yii\mutex\FileMutex
`$mutexPath`	string	The directory to store mutex files.	yii\mutex\FileMutex

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`acquire()`	Acquires a lock by name.	yii\mutex\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\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	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\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes mutex component implementation dedicated for UNIX, GNU/Linux, Mac OS X, and other UNIX-like operating systems.	craft\mutex\FileMutex
`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.	yii\mutex\Mutex
`trigger()`	Triggers an event.	yii\base\Component

Protected Methods
Method	Description	Defined By
`acquireLock()`	Acquires lock by given name.	yii\mutex\FileMutex
`getLockFilePath()`	Generate path for lock file.	craft\mutex\FileMutex
`releaseLock()`	Releases lock by given name.	yii\mutex\FileMutex

Method Details

`getLockFilePath()` protected method #

Generate path for lock file.

protected string getLockFilePath ( $name )

$name string

`init()` public method #

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

public void init ( )

throws	yii\base\InvalidConfigException

Method Details

getLockFilePath() protected method #

init() public method #

`getLockFilePath()` protected method #

`init()` public method #