Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::dayOfWeek()
2. 8.9.x core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::dayOfWeek()
3. 10 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::dayOfWeek()

Returns day of week for a given date (0 = Sunday).

Parameters

mixed $date: (optional) A DrupalDateTime object or a date string. Defaults to NULL, which means use the current date.

Return value

int|null The number of the day in the week, or null if the $date has errors.

2 calls to DateHelper::dayOfWeek()

DateHelper::dayOfWeekName in core/lib/Drupal/Core/Datetime/DateHelper.php

Returns translated name of the day of week for a given date.

DateHelperTest::testDayOfWeek in core/tests/Drupal/Tests/Core/Datetime/DateHelperTest.php

@covers ::dayOfWeek

File

core/lib/Drupal/Core/Datetime/DateHelper.php, line 503

Class

DateHelper

Defines Gregorian Calendar date values.

Namespace

Drupal\Core\Datetime

Code

public static function dayOfWeek($date = NULL) {
    $date = $date ?? 'now';
    if (!$date instanceof DrupalDateTime) {
        $date = new DrupalDateTime($date);
    }
    if (!$date->hasErrors()) {
        return $date->format('w');
    }
    return NULL;
}

---