-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.xml
503 lines (503 loc) · 13.3 KB
/
README.xml
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
<version>
4.0.11
</version>
<whatsnew>
1. In view templates/header, added link navbar to redirect to view event/view if CurrentEventID is set, else do nothing.
</whatsnew>
<author>
J. V. Ambata
</author>
<changelog>
<model>
<tlkpdivision>
<getAuthorCompanyDivisions>
Get all divisions with DivisionID > 0 (DivisionID = -1 is "other")
</getAuthorCompanyDivisions>
<getDivision>
Get a specific division, based on a given DivisionID
</getDivision>
</tlkpdivision>
<tlkpfile>
<getFiles>
Get files for specified session IDs
</getFiles>
<getFile>
Get file for a specified file ID
</getFile>
</tlkpfile>
<tlkpsettings>
<getAppSettings>
Get the app settings such as AuthorCompany, AuthorDivision, Version, etc.
</getAppSettings>
</tlkpsettings>
<tmasevent>
<getAllEvents>
Get all events regardless of privacy
</getAllEvents>
<getEventsByPrivacy>
Get all events based on the privacy set in the app settings
</getEventsByPrivacy>
<getEvent>
Get a specific event based on a given EventID
</getEvent>
</tmasevent>
<tmassession>
<getSessions>
Get all sessions for an event
</getSessions>
</tmassession>
<tmasspeaker>
<getSpeakers>
Get speakers for selected sessions
</getSpeakers>
</tmasspeaker>
<tmasuser>
<getUser>
Get a specific user based on a given UserID
</getUser>
<getUsers>
Get users with UserID in the array specified
</getUsers>
<getUserSignin>
Get a specific user based on his sign in credentials
</getUserSignin>
<updateUserField>
Update a field of a user based on a given UserID
</updateUserField>
</tmasuser>
<trelsessionspeaker>
<getEventSpeakers>
Get speakers for the specified event
</getEventSpeakers>
<getSessionSpeakers>
Get speakers for a session
</getSessionSpeakers>
</trelsessionspeaker>
<treluserevent>
<getUsersEvent>
Get users in the specified event
</getUsersEvent>
<getUserEvent>
Get user-event relationship based on given UserID, and EventID
</getUserEvent>
</treluserevent>
<trelusersession>
<getUserSessions>
Get sessions of a specified user
</getUserSessions>
<insertUserSession>
Insert a user-session relationship entry
</insertUserSession>
<deleteUserSession>
Delete a user-session relationship entry
</deleteUserSession>
</trelusersession>
<ttrnalert>
<getAlerts>
Get alerts in the specified event
</getAlerts>
</ttrnalert>
<ttrncomment>
<getComments>
Get comments for specified post ids
</getComments>
<getPostComments>.
Get comments for a specified post
</getPostComments>
<insertComment>
Insert a comment
</insertComment>
</ttrncomment>
<ttrnpost>
<getPosts>
Get posts for a specified event, and optionally for a specific recipient ("To" field)
</getPosts>
<insertPost>
Insert a post
</insertPost>
</ttrnpost>
</model>
<view>
<alert>
<listing>
Display alert list
</listing>
</alert>
<app>
<about>
<version>
Display the version number based on the app settings; Lorem ipsum placeholder
</version>
<team>
Thumbnail, and text placeholders
</team>
</about>
<contactus>
</contactus>
<help>
</help>
</app>
<event>
<about>
Display event summary
</about>
<info>
</info>
<listing>
Display event list
</listing>
<view>
Display ongoing (current) session; Allow the signed-in user to write/publish a post (-1: public, 0: private; >0: specific session)
</view>
</event>
<file>
<listing>
Display all files available for download
</listing>
</file>
<session>
<listing>
Display list of sessions (schedule)
</listing>
<view>
Display session details
</view>
</session>
<speaker>
<listing>
Display list of speakers
</listing>
</speaker>
<templates>
<footer>
Display the AuthorDivision, and the links for help, about, and contact us.
</footer>
<header>
Display the AppName, sign in form if not yet signed in (my account button, and sign out button otherwise), alert message, and page header
</header>
<event-offcanvas>
Left offcanvas navigation area, and the right part as the content (to be specified by the controller); added a badge in the alerts link (BAD PRACTICE! Accessing the model through the view - for the counter)
</event-offcanvas>
<event-nav-pills>
Top nav-pills navigation area, and the bottom part as the content (to be specified by the controller)
</event-nav-pills>
</templates>
<user>
<details>
Display the signed-in user details
</details>
<edit>
Edit a specific field
</edit>
<listing>
Display list of users (attendees)
</listing>
<view>
Display user details, and posts
</view>
</user>
<usersession>
<listing>
Display sessions of a user for a particular event (aka "My Schedule")
</listing>
</usersession>
</view>
<controller>
<alert>
<main-functions>
<construct>
Load: model, form helper, session library
</construct>
<listing>
Get alert list, display on listing page
</listing>
</main-functions>
<helper-functions>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</alert>
<app>
<main-functions>
<construct>
Load: model, form helper, form validation library, session library
</construct>
<help>
Go to help page
</help>
<about>
Go to about page
</about>
<contactus>
Go to contactus page
</contactus>
</main-functions>
<helper-functions>
</helper-functions>
</app>
<comment>
<main-functions>
<construct>
Load: model, form helper, session library
</construct>
<write>
Insert comment in a post
</write>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<IsSessionSelected>
Determines if the user has selected a valid SessionID
</IsSessionSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</comment>
<event>
<main-functions>
<construct>
Load: model, form helper, form validation library, session library
</construct>
<listing>
Get events list, display on listing page
</listing>
<view>
Params: EventID; Display the home page of the event (posts, alerts, etc.)
</view>
<about>
Params: EventID; Displays the summary of the event
</about>
<info>
Params: EventID; Displays the helpful information (organizing team, contact info, etc.)
</info>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</event>
<file>
<main-functions>
<construct>
Load: model, form helper, download helper, session library
</construct>
<listing>
Get files list, display on listing page
</listing>
<download>
Get file, force download to user
</download>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<IsFileSelected>
Determines if the user has selected a valid FileID
</IsFileSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</file>
<post>
<main-functions>
<construct>
Load: model, form helper, session library
</construct>
<write>
Write/publish post
</write>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<IsSessionSelected>
Determines if the user has selected a valid SessionID
</IsSessionSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</post>
<session>
<main-functions>
<construct>
Load: model, form helper, form validation library, session library
</construct>
<listing>
Get sessions list, display on listing page
</listing>
<view>
Display session details, and speakers for the session
</view>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<IsSessionSelected>
Determines if the user has selected a valid SessionID
</IsSessionSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</session>
<speaker>
<main-functions>
<construct>
Load: model, form helper, form validation library, session library
</construct>
<listing>
Get speakers list, display on listing page
</listing>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</speaker>
<user>
<main-functions>
<construct>
Load: model, form helper, session library
</construct>
<signin>
Processes the sign in credentials provided by the user. If valid, allow app access; else, reject.
</signin>
<signout>
Unsets all userdata (session)
</signout>
<view>
Params: UserID; Display the user's details, and posts for the current event
</view>
<details>
Displays the signed-in user details (my account)
</details>
<edit>
Params: Field; Display the editing page of a specific field of the user
</edit>
<update>
Params: Field; Updates a specific field of the user
</update>
<listing>
Get users list (attendees), display on listing page
</listing>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<goToMyAccount>
Redirect to my account
</goToMyAccount>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</user>
<usersession>
<main-functions>
<construct>
Load: model, form helper, form validation library, session library
</construct>
<update>
Include/remove a session from the user's schedule
</update>
<listing>
Get sessions list of the user, display on listing page (aka "My Schedule")
</listing>
</main-functions>
<helper-functions>
<setAlertStatusAndMessage>
Set AlertStatus, and AlertMessage in templates/header.php
</setAlertStatusAndMessage>
<IsUserSignedIn>
Determines if the user is signed in, or not
</IsUserSignedIn>
<IsEventSelected>
Determines if the user has selected a valid EventID
</IsEventSelected>
<IsSessionSelected>
Determines if the user has selected a valid SessionID
</IsSessionSelected>
<DoesUserHaveAccess>
Determines if the user has access to the selected event
</DoesUserHaveAccess>
</helper-functions>
</usersession>
</controller>
<others>
<index>
Set default timezone to be Asia/Manila (not working)
</index>
<htaccess>
Updated .htaccess with Debug, and Release RewriteBase
</htaccess>
<config>
In application/config/config.php, set index_page = ''
</config>
</others>
</changelog>