https://github.com/vivait/twig-safe-date

https://github.com/vivait/twig-safe-date

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vivait/twig-safe-date
• Owner: vivait
• License: mit
• Created: 2017-10-27T14:06:37.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-07-21T09:18:40.000Z (11 months ago)
• Last Synced: 2024-05-14T03:45:41.645Z (about 1 month ago)
• Language: PHP
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-twig - Safe Date - A safe date function in twig that will not set null dates to today. (Twig / Extensions)
• awesome-twig - Safe Date - A safe date function in twig that will not set null dates to today. (Twig / Extensions)

README

        
# Twig Safe Date Extension

Simple filter in twig to help avoid problems with things like: `{{ null|date('Y-m-d') }}`

There are ways around it using twig - the [documentation](https://twig.symfony.com/doc/2.x/filters/date.html) even states:

> If the value passed to the date filter is null, it will return the current date by default. If an empty string is desired instead of the current date, use a ternary operator:

>

> `{{ post.published_at is empty ? "" : post.published_at|date("m/d/Y") }}`

But often, this is overlooked.

## Requirements

* PHP >=7.4 or >= 8.2

* Twig ^3.0

## Installation & Usage

`composer require vivait/twig-safe-date`

Once required, register the extension with Twig:

```php

$twig = new \Twig_Environment($loader);

$twig->addExtension(new TwigSafeDateExtension);

```

Once registered, you can use the filter `date` to output dates as before, with the change that: **null values will get turned into known content (default: `-`) rather than today's date**

The default format is `'F j, Y H:i.'` (the same as the core `date` filter in Twig)

```

{{ post.posted_at|date }}

```

If you wish to change the format of the date, pass it a parameter with your preferred format:

```

{{ post.posted_at|date("d/m/Y") }}

```

If `post.posted_at` is `null`, then by default the filter will output `-`, if you wish to change this to a different value, pass a new default as the third parameter:

```

{{ post.posted_at|date("d/m/Y", "Europe/London" "Content if null") }}

```