<?php
/**
 * Helper class for calculating and displaying event times
 *
 * PHP version 5
 *
 * @category Data
 * @package  StatusNet
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
 * @link     http://status.net/
 *
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2011, StatusNet, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 *  Class to get fancy times for the dropdowns on the new event form
 */
class EventTimeList {

    /**
     * Round up to the nearest half hour
     *
     * @param string $time the time to round (date/time string)
     * @return DateTime    the rounded time
     */
    public static function nearestHalfHour($time)
    {
        $start = strtotime($time);

        $minutes = date('i', $start);
        $hour = date('H', $start);

        if ($minutes >= 30) {
            $minutes = '00';
            $hour++;
        } else {
            $minutes = '30';
        }

        $newTimeStr = date('m/d/y', $start) . " {$hour}:{$minutes}:00";
        return new DateTime($newTimeStr);
    }

    /**
     * Output a list of times in half-hour intervals
     *
     * @param string  $start       Time to start with (date/time string)
     * @param boolean $duration    Whether to include the duration of the event
     *                             (from the start)
     * @return array  $times (UTC time string => localized time string)
     */
    public static function getTimes($start = 'now', $duration = false)
    {
        $newTime = self::nearestHalfHour($start);

        $newTime->setTimezone(new DateTimeZone(common_timezone()));
        $times = array();
        $len   = 0;

        for ($i = 0; $i < 48; $i++) {

            // make sure we store the time as UTC
            $newTime->setTimezone(new DateTimeZone('UTC'));
            $utcTime = $newTime->format('H:i:s');

            // localize time for user
            $newTime->setTimezone(new DateTimeZone(common_timezone()));
            $localTime = $newTime->format('g:ia');

            // pretty up the end-time option list a bit
            if ($duration) {
                $len += 30;
                $hours    = $len / 60;
                // for i18n
                $hourStr  = _m('hour');
                $hoursStr = _m('hrs');
                $minStr   = _m('mins');
                switch ($hours) {
                case 0:
                    $total = " (0 {$minStr})";
                    break;
                case .5:
                    $total = " (30 {$minStr})";
                    break;
                case 1:
                    $total = " (1 {$hourStr})";
                    break;
                default:
                    $total = " ({$hours} " . $hoursStr . ')';
                    break;
                }
                $localTime .= $total;
            }

            $times[$utcTime] = $localTime;
            $newTime->modify('+30min'); // 30 min intervals
        }

        return $times;
    }

}