function DateHelper::hours

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

Constructs an array of hours.

Parameters

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

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

Return value

array An array of hours in the selected format.

File

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

Class

DateHelper
Defines Gregorian Calendar date values.

Namespace

Drupal\Core\Datetime

Code

public static function hours($format = 'H', $required = FALSE) {
    $hours = [];
    if ($format == 'h' || $format == 'g') {
        $min = 1;
        $max = 12;
    }
    else {
        $min = 0;
        $max = 23;
    }
    for ($i = $min; $i <= $max; $i++) {
        $formatted = $format == 'H' || $format == 'h' ? DrupalDateTime::datePad($i) : $i;
        $hours[$i] = $formatted;
    }
    $none = [
        '' => '',
    ];
    return !$required ? $none + $hours : $hours;
}

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