function DateHelper::seconds

Same name in other branches
  1. 9 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::seconds()
  2. 8.9.x core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::seconds()
  3. 11.x core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::seconds()

Constructs an array of seconds.

Parameters

string $format: (optional) A date format string that indicates the format to use for the seconds. Defaults to 's'.

bool $required: (optional) If FALSE, the returned array will include a blank value. Defaults to FALSE.

int $increment: An integer value to increment the values. Defaults to 1.

Return value

array An array of seconds in the selected format.

File

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

Class

DateHelper
Defines Gregorian Calendar date values.

Namespace

Drupal\Core\Datetime

Code

public static function seconds($format = 's', $required = FALSE, $increment = 1) {
    $seconds = [];
    // Ensure $increment has a value so we don't loop endlessly.
    if (empty($increment)) {
        $increment = 1;
    }
    for ($i = 0; $i < 60; $i += $increment) {
        $formatted = $format == 's' ? DrupalDateTime::datePad($i) : $i;
        $seconds[$i] = $formatted;
    }
    $none = [
        '' => '',
    ];
    return !$required ? $none + $seconds : $seconds;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.