Yiisoft\Mutex\File\FileMutexFactory

Complexity

Total Complexity

2

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	create()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Mutex\File;

use Yiisoft\Mutex\MutexFactory;
use Yiisoft\Mutex\MutexInterface;

/**
 * Allows creating file mutex objects.
 */
final class FileMutexFactory extends MutexFactory
{
    private string $mutexPath;
    private int $directoryMode;
    private ?int $fileMode;

    /**
     * @param string $mutexPath The directory to store mutex files.
     * @param int $directoryMode The permission to be set for newly created directories.
     * This value will be used by PHP {@see 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.
     * @param int|null $fileMode The permission to be set for newly created mutex files.
     * This value will be used by PHP {@see chmod()} function. No umask will be applied.
     */
    public function __construct(string $mutexPath, int $directoryMode = 0775, int $fileMode = null)
    {
        $this->mutexPath = $mutexPath;
        $this->directoryMode = $directoryMode;
        $this->fileMode = $fileMode;
    }

    public function create(string $name): MutexInterface
    {
        return new FileMutex($name, $this->mutexPath, $this->directoryMode, $this->fileMode);
    }
}