Skip to content

Added a tip about the TMPDIR env variable #7150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions components/filesystem/lock_handler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,19 @@ the file, so you can pass any value for this argument.
to avoid name collisions, ``LockHandler`` also appends a hash to the name of
the lock file.

By default, the lock will be created in the temporary directory, but you can
optionally select the directory where locks are created by passing it as the
second argument of the constructor.
By default, the lock will be created in the system's temporary directory, but
you can optionally select the directory where locks are created by passing it as
the second argument of the constructor.

.. tip::

Another way to configure the directory where the locks are created is to
define a special environment variable, because PHP will use that value to
override the default temporary directory. In Unix-based systems, define the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On Unix-based systems [...]?

``TMPDIR`` variable. In Windows systems, define any of these variables:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here (On Windows Systems [...])?

``TMP``, ``TEMP`` or ``USERPROFILE`` (they are checked in this order). This
technique is useful for example when deploying a third-party Symfony
application whose code can't be modified.

The :method:`Symfony\\Component\\Filesystem\\LockHandler::lock` method tries to
acquire the lock. If the lock is acquired, the method returns ``true``,
Expand Down