Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2015 (original work) Open Assessment Technologies SA;
19 *
20 *
21 */
22
23namespace oat\tao\helpers\dateFormatter;
24
25/**
26 * Interface for the dateFormatter
27 *
28 * @author Joel Bout, <joel@taotesting.com>
29 */
30interface DateFormatterInterface
31{
32    /**
33     * Formats a datetime in the given format.
34     *
35     * @see format constants tao_helpers_Date::FORMAT_*
36     *
37     * @param float         $timestamp
38     * @param string        $format see constants of tao_helpers_Date for possible values
39     * @param \DateTimeZone $timeZone
40     *
41     * @return string the formatted date
42     * @throws \common_exception_Error
43     */
44    public function format($timestamp, $format, \DateTimeZone $timeZone);
45
46    /**
47     * Returns the format used by DateTime::format.
48     *
49     * @param int $format
50     *
51     * @return mixed|string
52     */
53    public function getFormat($format);
54
55    /**
56     * Returns the format used by DateTime::format.
57     *
58     * @param int $format
59     *
60     * @return mixed|string
61     */
62    public function getJavascriptFormat($format);
63}