friendica
/
friendica
mirror of https://github.com/friendica/friendica
6
0
Fork 1
Code Issues Packages Projects Releases 1 Wiki Activity

Normalize start_time and end_time parameter names in Friendica API event endpoints

This commit is contained in:
Hypolite Petovan 2022-07-24 05:49:18 -04:00
parent bd02340162
commit 946db2ab45
4 changed files with 50 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/API-Entities.md
View File

@ -410,13 +410,13 @@ Ex: Wed May 23 06:01:13 +0000 2007
</tr> </tr>
<tr> <tr>
<td><code>startTime</code></td> <td><code>start_time</code></td>
<td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td> <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
<td></td> <td></td>
</tr> </tr>
<tr> <tr>
<td><code>endTime</code></td> <td><code>end_time</code></td>
<td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td> <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
<td>Optional (null date is <code>0001-01-01 00:00:00</code></td> <td>Optional (null date is <code>0001-01-01 00:00:00</code></td>
</tr> </tr>

8
doc/API-Friendica.md
View File

@ -32,11 +32,15 @@ Create a new event for the current logged in user.
- `id` : (optional) id of event, event will be amended if supplied - `id` : (optional) id of event, event will be amended if supplied
- `name` : name of the event (required) - `name` : name of the event (required)
- `startTime` : start of the event (ISO), required - `start_time` : start of the event (ISO), required
- `endTime` : (optional) end of the event, event is open end, if not supplied - `end_time` : (optional) end of the event, event is open end, if not supplied
- `desc` : (optional) description of the event - `desc` : (optional) description of the event
- `place` : (optional) location of the event - `place` : (optional) location of the event
- `publish` : (optional) create message for event - `publish` : (optional) create message for event
- `allow_cid` : (optional) ACL-formatted list of allowed contact ids if private event
- `allow_gid` : (optional) ACL-formatted list of disallowed contact ids if private event
- `deny_cid` : (optional) ACL-formatted list of allowed group ids if private event
- `deny_gid` : (optional) ACL-formatted list of disallowed group ids if private event
### POST api/friendica/event_delete ### POST api/friendica/event_delete

50
src/Module/Api/Friendica/Events/Create.php
View File

@ -45,17 +45,17 @@ class Create extends BaseApi
// params // params
$request = $this->getRequest([ $request = $this->getRequest([
'id' => 0, //if provided, event will be amended 'id' => 0, //if provided, event will be amended
'name' => '', //summary of the event 'name' => '', //summary of the event
'desc' => '', //description in BBCode 'desc' => '', //description in BBCode
'startTime' => '', //starttime, required 'start_time' => '', //start_time, required
'endTime' => '', //endtime, required if nofinish false 'end_time' => '', //endtime, required if nofinish false
'place' => '', //location of the event 'place' => '', //location of the event
'publish' => 0, //publish message 'publish' => 0, //publish message
'allow_cid' => '', //array of allowed person, if access restricted 'allow_cid' => '', //array of allowed person, if access restricted
'allow_gid' => '', //array of allowed groups, if access restricted 'allow_gid' => '', //array of allowed groups, if access restricted
'deny_cid' => '', //array of denied person, if access restricted 'deny_cid' => '', //array of denied person, if access restricted
'deny_gid' => '', //array of denied groups, if access restricted 'deny_gid' => '', //array of denied groups, if access restricted
], $request); ], $request);
// error if no name specified // error if no name specified
@ -64,33 +64,33 @@ class Create extends BaseApi
} }
// error startDate is not specified // error startDate is not specified
if (empty($request['startTime'])) { if (empty($request['start_time'])) {
throw new HTTPException\BadRequestException('startDate not specified'); throw new HTTPException\BadRequestException('startDate not specified');
} }
// nofinish if endTime is not specified // nofinish if end_time is not specified
if (empty($request['endTime'])) { if (empty($request['end_time'])) {
$finish = DBA::NULL_DATETIME; $finish = DBA::NULL_DATETIME;
$nofinish = true; $nofinish = true;
} else { } else {
$finish = DateTimeFormat::convert($request['endTime'], 'UTC', DI::app()->getTimeZone()); $finish = DateTimeFormat::convert($request['end_time'], 'UTC', DI::app()->getTimeZone());
$nofinish = false; $nofinish = false;
} }
$start = DateTimeFormat::convert($request['startTime'], 'UTC', DI::app()->getTimeZone()); $start = DateTimeFormat::convert($request['start_time'], 'UTC', DI::app()->getTimeZone());
// create event // create event
$event = []; $event = [];
$event['id'] = $request['id']; $event['id'] = $request['id'];
$event['uid'] = $uid; $event['uid'] = $uid;
$event['type'] = 'event'; $event['type'] = 'event';
$event['summary'] = $request['name']; $event['summary'] = $request['name'];
$event['desc'] = $request['desc']; $event['desc'] = $request['desc'];
$event['location'] = $request['place']; $event['location'] = $request['place'];
$event['start'] = $start; $event['start_time'] = $start;
$event['finish'] = $finish; $event['end_time'] = $finish;
$event['nofinish'] = $nofinish; $event['nofinish'] = $nofinish;
$event['allow_cid'] = $request['allow_cid']; $event['allow_cid'] = $request['allow_cid'];
$event['allow_gid'] = $request['allow_gid']; $event['allow_gid'] = $request['allow_gid'];

34
src/Module/Api/Friendica/Events/Index.php
View File

@ -49,23 +49,23 @@ class Index extends BaseApi
$items = []; $items = [];
foreach ($events as $event) { foreach ($events as $event) {
$items[] = [ $items[] = [
'id' => intval($event['id']), 'id' => intval($event['id']),
'uid' => intval($event['uid']), 'uid' => intval($event['uid']),
'cid' => $event['cid'], 'cid' => $event['cid'],
'uri' => $event['uri'], 'uri' => $event['uri'],
'name' => $event['summary'], 'name' => $event['summary'],
'desc' => BBCode::convertForUriId($event['uri-id'], $event['desc']), 'desc' => BBCode::convertForUriId($event['uri-id'], $event['desc']),
'startTime' => $event['start'], 'start_time' => $event['start'],
'endTime' => $event['finish'], 'end_time' => $event['finish'],
'type' => $event['type'], 'type' => $event['type'],
'nofinish' => $event['nofinish'], 'nofinish' => $event['nofinish'],
'place' => $event['location'], 'place' => $event['location'],
'adjust' => 1, 'adjust' => 1,
'ignore' => $event['ignore'], 'ignore' => $event['ignore'],
'allow_cid' => $event['allow_cid'], 'allow_cid' => $event['allow_cid'],
'allow_gid' => $event['allow_gid'], 'allow_gid' => $event['allow_gid'],
'deny_cid' => $event['deny_cid'], 'deny_cid' => $event['deny_cid'],
'deny_gid' => $event['deny_gid'] 'deny_gid' => $event['deny_gid']
]; ];
} }