aboutsummaryrefslogtreecommitdiff
path: root/engine/classes/Notable.php
blob: e36699dfc4588f3ccb0d1ef8818bc4f7ddfe10d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?php
/**
 * Calendar interface for events.
 *
 * @package    Elgg.Core
 * @subpackage DataModel.Notable
 *
 * @todo Implement or remove.
 */
interface Notable {
	/**
	 * Calendar functionality.
	 * This function sets the time of an object on a calendar listing.
	 *
	 * @param int $hour     If ommitted, now is assumed.
	 * @param int $minute   If ommitted, now is assumed.
	 * @param int $second   If ommitted, now is assumed.
	 * @param int $day      If ommitted, now is assumed.
	 * @param int $month    If ommitted, now is assumed.
	 * @param int $year     If ommitted, now is assumed.
	 * @param int $duration Duration of event, remainder of the day is assumed.
	 *
	 * @return bool
	 */
	public function setCalendarTimeAndDuration($hour = NULL, $minute = NULL, $second = NULL,
		$day = NULL, $month = NULL, $year = NULL, $duration = NULL);

	/**
	 * Return the start timestamp.
	 *
	 * @return int
	 */
	public function getCalendarStartTime();

	/**
	 * Return the end timestamp.
	 *
	 * @return int
	 */
	public function getCalendarEndTime();
}