aboutsummaryrefslogtreecommitdiff
path: root/engine/classes/Notable.php
diff options
context:
space:
mode:
Diffstat (limited to 'engine/classes/Notable.php')
-rw-r--r--engine/classes/Notable.php25
1 files changed, 18 insertions, 7 deletions
diff --git a/engine/classes/Notable.php b/engine/classes/Notable.php
index ae88b521f..e36699dfc 100644
--- a/engine/classes/Notable.php
+++ b/engine/classes/Notable.php
@@ -2,29 +2,40 @@
/**
* 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 $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);
+ 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();
} \ No newline at end of file