1: <?php
2: namespace Charcoal\Cms\Support\Interfaces;
3:
4: interface EventManagerAwareInterface
5: {
6: /**
7: * Formatted event list
8: * Return the entries for the current page
9: * @return \Generator|void
10: */
11: public function eventsList();
12:
13: /**
14: * Formatted event archive list
15: * Returns the entries for the current page.
16: * @return \Generator|void
17: */
18: public function eventArchiveList();
19:
20: /**
21: * Current event.
22: * @return array The properties of the current event.
23: */
24: public function currentEvent();
25:
26: /**
27: * @return mixed
28: */
29: public function featEvents();
30:
31: /**
32: * Next event in list.
33: * @return array The next event properties.
34: */
35: public function nextEvent();
36:
37: /**
38: * Next event in list.
39: * @return array The next event properties.
40: */
41: public function prevEvent();
42:
43: /**
44: * Amount of events (total)
45: * @return integer How many events?
46: */
47: public function numEvent();
48:
49: /**
50: * @return float
51: */
52: public function numEventPages();
53:
54: /**
55: * @return boolean
56: */
57: public function eventHasPager();
58:
59: /**
60: * @return \Generator
61: */
62: public function eventCategoryList();
63: }
64: