{"id":14966457,"url":"https://github.com/yiisoft/mutex-file","last_synced_at":"2025-10-19T09:31:24.646Z","repository":{"id":34835964,"uuid":"181288753","full_name":"yiisoft/mutex-file","owner":"yiisoft","description":"File-based mutex implementation for yiisoft/mutex.","archived":false,"fork":false,"pushed_at":"2024-04-04T11:13:31.000Z","size":92,"stargazers_count":12,"open_issues_count":2,"forks_count":5,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-04-13T22:58:00.723Z","etag":null,"topics":["file","hacktoberfest","mutex","yii3"],"latest_commit_sha":null,"homepage":"https://www.yiiframework.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yiisoft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"open_collective":"yiisoft","github":["yiisoft"]}},"created_at":"2019-04-14T09:50:54.000Z","updated_at":"2023-11-25T03:48:06.000Z","dependencies_parsed_at":"2024-04-11T03:00:20.212Z","dependency_job_id":"76489945-fc80-4039-bc47-84eb1eac9f5e","html_url":"https://github.com/yiisoft/mutex-file","commit_stats":{"total_commits":73,"total_committers":12,"mean_commits":6.083333333333333,"dds":0.4794520547945206,"last_synced_commit":"691e41d877ea00ebf3335ae975b961e65dc84d8a"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fmutex-file","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fmutex-file/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fmutex-file/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yiisoft%2Fmutex-file/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yiisoft","download_url":"https://codeload.github.com/yiisoft/mutex-file/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219869479,"owners_count":16555292,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["file","hacktoberfest","mutex","yii3"],"created_at":"2024-09-24T13:36:24.761Z","updated_at":"2025-10-19T09:31:24.639Z","avatar_url":"https://github.com/yiisoft.png","language":"PHP","funding_links":["https://opencollective.com/yiisoft","https://github.com/sponsors/yiisoft"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/yiisoft\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://yiisoft.github.io/docs/images/yii_logo.svg\" height=\"100px\"\u003e\n    \u003c/a\u003e\n    \u003ch1 align=\"center\"\u003eYii Mutex Library - File Driver\u003c/h1\u003e\n    \u003cbr\u003e\n\u003c/p\u003e\n\n[![Latest Stable Version](https://poser.pugx.org/yiisoft/mutex-file/v)](https://packagist.org/packages/yiisoft/mutex-file)\n[![Total Downloads](https://poser.pugx.org/yiisoft/mutex-file/downloads)](https://packagist.org/packages/yiisoft/mutex-file)\n[![Build status](https://github.com/yiisoft/mutex-file/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/mutex-file/actions/workflows/build.yml)\n[![Code Coverage](https://codecov.io/gh/yiisoft/mutex-file/branch/master/graph/badge.svg)](https://codecov.io/gh/yiisoft/mutex-file)\n[![Mutation testing badge](https://img.shields.io/endpoint?style=flat\u0026url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fmutex-file%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/mutex-file/master)\n[![static analysis](https://github.com/yiisoft/mutex-file/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/mutex-file/actions?query=workflow%3A%22static+analysis%22)\n[![type-coverage](https://shepherd.dev/github/yiisoft/mutex-file/coverage.svg)](https://shepherd.dev/github/yiisoft/mutex-file)\n\nThis library provides a File mutex implementation for [yiisoft/mutex](https://github.com/yiisoft/mutex).\n\n## Requirements\n\n- PHP 7.4 or higher.\n\n## Installation\n\nThe package could be installed with [Composer](https://getcomposer.org):\n\n```shell\ncomposer require yiisoft/mutex-file\n```\n\n## General usage\n\nThe package provides two classes implementing `MutexInterface` and `MutexFactoryInterface`\nfrom the [yiisoft/mutex](https://github.com/yiisoft/mutex) package:\n\n```php\n$mutex = new \\Yiisoft\\Mutex\\File\\FileMutex(\n    'mutex-name',\n    '/path/to/directory/for/storing/mutex/files',\n    0775, // Optional. The permission to be set for newly created mutex directory. Default is `0775`.\n    0777, // Optional. The permission to be set for newly created mutex files. Default is `null`.\n);\n\n$mutexFactory = new \\Yiisoft\\Mutex\\File\\FileMutexFactory(\n    '/path/to/directory/for/storing/mutex/files',\n    0775, // Optional. The permission to be set for newly created mutex directory. Default is `0775`.\n    0777, // Optional. The permission to be set for newly created mutex files. Default is `null`.\n);\n```\n\nThere are multiple ways you can use the package. You can execute a callback in a synchronized mode i.e. only a\nsingle instance of the callback is executed at the same time:\n\n```php\n$synchronizer = new \\Yiisoft\\Mutex\\Synchronizer($mutexFactory);\n\n$newCount = $synchronizer-\u003eexecute('critical', function () {\n    return $counter-\u003eincrease();\n}, 10);\n```\n\nAnother way is to manually open and close mutex:\n\n```php\n$simpleMutex = new \\Yiisoft\\Mutex\\SimpleMutex($mutexFactory);\n\nif (!$simpleMutex-\u003eacquire('critical', 10)) {\n    throw new \\Yiisoft\\Mutex\\Exception\\MutexLockedException('Unable to acquire the \"critical\" mutex.');\n}\n\n$newCount = $counter-\u003eincrease();\n$simpleMutex-\u003erelease('critical');\n```\n\nIt could be done on lower level:\n\n```php\n$mutex = $mutexFactory-\u003ecreateAndAcquire('critical', 10);\n$newCount = $counter-\u003eincrease();\n$mutex-\u003erelease();\n```\n\nAnd if you want even more control, you can acquire mutex manually:\n\n```php\n$mutex = $mutexFactory-\u003ecreate('critical');\n\nif (!$mutex-\u003eacquire(10)) {\n    throw new \\Yiisoft\\Mutex\\Exception\\MutexLockedException('Unable to acquire the \"critical\" mutex.');\n}\n\n$newCount = $counter-\u003eincrease();\n$mutex-\u003erelease();\n```\n\nThe `FileMutex` supports the \"wait for a lock for a certain time\" functionality. Using the `withRetryDelay()`\nmethod, you can override the number of milliseconds between each try until specified timeout times out:\n\n```php\n$mutex = $mutex-\u003ewithRetryDelay(100);\n```\n\nBy default, it is 50 milliseconds - it means that we may try to acquire lock up to 20 times per second.\n\n## Documentation\n\n- [Internals](docs/internals.md)\n\nIf you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.\nYou may also check out other [Yii Community Resources](https://www.yiiframework.com/community).\n\n## License\n\nThe Yii Mutex Library - File Driver is free software. It is released under the terms of the BSD License.\nPlease see [`LICENSE`](./LICENSE.md) for more information.\n\nMaintained by [Yii Software](https://www.yiiframework.com/).\n\n## Support the project\n\n[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective\u0026logoColor=7eadf1\u0026labelColor=555555)](https://opencollective.com/yiisoft)\n\n## Follow updates\n\n[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)\n[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter\u0026logoColor=1DA1F2\u0026labelColor=555555?style=flat)](https://twitter.com/yiiframework)\n[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat\u0026logo=telegram)](https://t.me/yii3en)\n[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat\u0026logo=facebook\u0026logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)\n[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat\u0026logo=slack)](https://yiiframework.com/go/slack)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiisoft%2Fmutex-file","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyiisoft%2Fmutex-file","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyiisoft%2Fmutex-file/lists"}