..include::/components/require_autoload.rst.inc

.. _clock_usage:

Usage

The ``now()`` function takes an optional ``modifier`` argument

You can use any string `accepted by the DateTime constructor`_.

Later on this page you can learn how to use this clock in your services and tests.

When using the Clock component, you manipulate

:class:`Symfony\\Component\\Clock\\DatePoint` instances. You can learn more

about it in:ref:`the dedicated section<clock_date-point>`.

..versionadded::6.3

The:class:`Symfony\\Component\\Clock\\ClockAwareTrait` was introduced in Symfony 6.3.

.. _clock_date-point:

The ``DatePoint`` Class

When using the Clock component, you manipulate instances of

:class:`Symfony\\Component\\Clock\\DatePoint`. The main purpose of this

class is to leverage the Clock component to get the "current time". When

creating a new ``DatePoint`` object, the date and time are fetched

from the:class:`Symfony\\Component\\Clock\\Clock` class. This means

that if you did any changes to the clock as stated in the

:ref:`usage section<clock_usage>`, it will be reflected when creating

a new ``DatePoint``. This can be particularly useful when

:ref:`writing time-sensitive tests<clock_writing-tests>`.

Creating a new ``DatePoint`` is as straightforward as creating other date

objects::

``DatePoint`` extends ``DateTimeImmutable`` so that you can use it seamlessly

everywhere a ``DateTimeImmutable`` is needed. In addition ``DatePoint`` offers

stricter return types and provides consistent error handling across versions of

PHP, thanks to polyfilling `PHP 8.3's behavior`_ on the topic.

..versionadded::6.4

The:class:`Symfony\\Component\\Clock\\DatePoint` class was introduced

in Symfony 6.4.

.. _clock_writing-tests:

Writing Time-Sensitive Tests

.. _`accepted by the DateTime constructor`:https://www.php.net/manual/en/datetime.formats.php

.. _`PHP DateTime exceptions`:https://wiki.php.net/rfc/datetime-exceptions

.. _`symfony/polyfill-php83`:https://github.com/symfony/polyfill-php83

.. _`PHP 8.3's behavior`:https://wiki.php.net/rfc/datetime-exceptions