Skip to content

Commit 6df9297

Browse files
sander-bolsander-bol
committed
manual: Cleanup controllers a bit
1 parent b47f874 commit 6df9297

File tree

8 files changed

+57
-140
lines changed

8 files changed

+57
-140
lines changed

‎app/src/Application/ApplicationController.php‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,18 +135,12 @@ public function notAllowed(): void
135135
]);
136136
}
137137

138-
/**
139-
* @return EventApi
140-
*/
141-
private function getEventApi()
138+
private function getEventApi(): EventApi
142139
{
143140
return $this->application->container->get(EventApi::class);
144141
}
145142

146-
/**
147-
* @return ContactApi
148-
*/
149-
private function getContactApi()
143+
private function getContactApi(): ContactApi
150144
{
151145
return $this->application->container->get(ContactApi::class);
152146
}

‎app/src/Application/BaseApi.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ private function makeHttpCall(string $httpMethod, string $url, string $content =
7878

7979
protected function apiGet(string $url, array $params = []): string
8080
{
81-
$paramsString = count($params) > 0 ? '?' . http_build_query($params, '', '&') : '';
81+
$paramsString = $params !== [] ? '?' . http_build_query($params, '', '&') : '';
8282

8383
return $this->makeHttpCall('GET', $url . $paramsString)->get_body();
8484
}
@@ -89,7 +89,7 @@ protected function apiGet(string $url, array $params = []): string
8989
*/
9090
protected function apiDelete(string $url, array $params = []): array
9191
{
92-
$paramsString = count($params) > 0 ? '?' . http_build_query($params, '', '&') : '';
92+
$paramsString = $params !== [] ? '?' . http_build_query($params, '', '&') : '';
9393
$baseApiResult = $this->makeHttpCall('DELETE', $url . $paramsString);
9494
return [$baseApiResult->get_status_code(), $baseApiResult->get_body(), $baseApiResult->get_headers()];
9595
}

‎app/src/Application/BaseDb.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33

44
abstract class BaseDb
55
{
6-
protected \Application\CacheService $cache;
6+
protected CacheService $cache;
77

8-
/** @var string */
9-
protected $keyName;
8+
protected string $keyName;
109

1110
public function __construct(CacheService $cacheService)
1211
{

‎app/src/Event/EventController.php‎

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ public function eventDefault(string $friendly_name)
202202
return $this->$action($friendly_name);
203203
}
204204

205-
public function details(string $friendly_name)
205+
public function details(string $friendly_name): void
206206
{
207207
$eventApi = $this->getEventApi();
208208
$event = $eventApi->getByFriendlyUrl($friendly_name);
@@ -227,7 +227,7 @@ public function details(string $friendly_name)
227227
);
228228
}
229229

230-
public function attendees(string $friendly_name)
230+
public function attendees(string $friendly_name): void
231231
{
232232
$eventApi = $this->getEventApi();
233233
$event = $eventApi->getByFriendlyUrl($friendly_name);
@@ -249,7 +249,7 @@ public function attendees(string $friendly_name)
249249
);
250250
}
251251

252-
public function comments(string $friendly_name)
252+
public function comments(string $friendly_name): void
253253
{
254254
$eventApi = $this->getEventApi();
255255
$event = $eventApi->getByFriendlyUrl($friendly_name);
@@ -1102,7 +1102,7 @@ public function addHost(string $friendly_name): void
11021102
);
11031103
}
11041104

1105-
private function appoveClaimPendingTalk($talkApi, $claim, array $data): void
1105+
private function appoveClaimPendingTalk(\Talk\TalkApi $talkApi, $claim, array $data): void
11061106
{
11071107
$talkApi->claimTalk($claim->approve_claim_uri, $data);
11081108

@@ -1112,7 +1112,7 @@ private function appoveClaimPendingTalk($talkApi, $claim, array $data): void
11121112
/**
11131113
* Reject a talk claim
11141114
*/
1115-
private function rejectClaimPendingTalk($talkApi, $claim, array $data): void
1115+
private function rejectClaimPendingTalk(\Talk\TalkApi $talkApi, $claim, array $data): void
11161116
{
11171117
$talkApi->rejectTalkClaim($claim->approve_claim_uri, $data);
11181118

@@ -1122,7 +1122,7 @@ private function rejectClaimPendingTalk($talkApi, $claim, array $data): void
11221122
/**
11231123
* Add a talk to the event
11241124
*/
1125-
public function addTalk(string $friendly_name)
1125+
public function addTalk(string $friendly_name): void
11261126
{
11271127
$eventApi = $this->getEventApi();
11281128
$event = $eventApi->getByFriendlyUrl($friendly_name);
@@ -1200,7 +1200,7 @@ public function addTalk(string $friendly_name)
12001200
/**
12011201
* Edit tracks for this event
12021202
*/
1203-
public function editTracks(string $friendly_name)
1203+
public function editTracks(string $friendly_name): void
12041204
{
12051205
$eventApi = $this->getEventApi();
12061206
$event = $eventApi->getByFriendlyUrl($friendly_name);
@@ -1400,34 +1400,22 @@ private function getTalkSlugsFromApi(EventEntity $eventEntity): array
14001400
return $slugs;
14011401
}
14021402

1403-
/**
1404-
* @return CacheService
1405-
*/
1406-
private function getCache()
1403+
private function getCache(): CacheService
14071404
{
14081405
return $this->application->container->get(CacheService::class);
14091406
}
14101407

1411-
/**
1412-
* @return TalkDb
1413-
*/
1414-
private function getTalkDb()
1408+
private function getTalkDb(): TalkDb
14151409
{
14161410
return $this->application->container->get(TalkDb::class);
14171411
}
14181412

1419-
/**
1420-
* @return TalkApi
1421-
*/
1422-
private function getTalkApi()
1413+
private function getTalkApi(): TalkApi
14231414
{
14241415
return $this->application->container->get(TalkApi::class);
14251416
}
14261417

1427-
/**
1428-
* @return UserApi
1429-
*/
1430-
private function getUserApi()
1418+
private function getUserApi(): UserApi
14311419
{
14321420
return $this->application->container->get(UserApi::class);
14331421
}

‎app/src/Search/SearchController.php‎

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,9 @@
22
namespace Search;
33

44
use Application\BaseController;
5-
use Application\CacheService;
65
use Event\EventApi;
7-
use Event\EventDb;
86
use Slim\Slim;
97
use Talk\TalkApi;
10-
use Talk\TalkDb;
11-
use User\UserDb;
128
use User\UserApi;
139

1410
/**
@@ -197,26 +193,17 @@ private function searchUsersByKeyword($page, string $keyword): array
197193
return $this->getUserApi()->getCollection($apiQueryParams);
198194
}
199195

200-
/**
201-
* @return EventApi
202-
*/
203-
protected function getEventApi()
196+
protected function getEventApi(): EventApi
204197
{
205198
return $this->application->container->get(EventApi::class);
206199
}
207200

208-
/**
209-
* @return TalkApi
210-
*/
211-
protected function getTalkApi()
201+
protected function getTalkApi(): TalkApi
212202
{
213203
return $this->application->container->get(TalkApi::class);
214204
}
215205

216-
/**
217-
* @return UserApi
218-
*/
219-
private function getUserApi()
206+
private function getUserApi(): UserApi
220207
{
221208
return $this->application->container->get(UserApi::class);
222209
}

‎app/src/Talk/TalkApi.php‎

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,8 @@ public function getCollection($talks_uri, array $queryParams = []): array
5454
return $collectionData;
5555
}
5656

57-
/**
58-
* @param integer $talkId
59-
* @return TalkEntity|null
60-
*/
61-
public function getTalkByTalkId($talkId)
57+
public function getTalkByTalkId(int $talkId): ?\Talk\TalkEntity
6258
{
63-
$talkId = (int)$talkId;
6459
if ($talkId === 0) {
6560
return null;
6661
}
@@ -92,9 +87,8 @@ public function getTalkBySlug($talkSlug, $eventUri)
9287
*
9388
* @param string $talk_uri API talk uri
9489
* @param bool $verbose Return verbose data?
95-
* @return TalkEntity|false
9690
*/
97-
public function getTalk(string $talk_uri, $verbose = false)
91+
public function getTalk(string $talk_uri, bool $verbose = false): ?TalkEntity
9892
{
9993
if ($verbose) {
10094
$talk_uri .= '?verbose=yes';
@@ -103,7 +97,7 @@ public function getTalk(string $talk_uri, $verbose = false)
10397
$collection = (array)json_decode($this->apiGet($talk_uri));
10498

10599
if (!isset($collection['talks'])) {
106-
return false;
100+
return null;
107101
}
108102

109103
$talkEntity = new TalkEntity($collection['talks'][0]);
@@ -121,10 +115,10 @@ public function getTalk(string $talk_uri, $verbose = false)
121115
/**
122116
* Get Comments for given talk
123117
*
124-
* @param bool $verbose
118+
*
125119
* @return TalkCommentEntity[]
126120
*/
127-
public function getComments(string $comment_uri, $verbose = false, $limitTo = null): array
121+
public function getComments(string $comment_uri, bool $verbose = false, $limitTo = null): array
128122
{
129123
$params = [];
130124
if ($verbose) {
@@ -146,34 +140,27 @@ public function getComments(string $comment_uri, $verbose = false, $limitTo = nu
146140
return $commentData;
147141
}
148142

149-
/**
150-
* Add a comment
151-
*
152-
* @param TalkEntity $talk
153-
* @param int $rating
154-
* @param string $comment
155-
*/
156-
public function addComment($talk, $rating, $comment): bool
143+
public function addComment(TalkEntity $talkEntity, int $rating, string $comment): bool
157144
{
158-
$uri = $talk->getCommentsUri();
145+
$uri = $talkEntity->getCommentsUri();
159146
$params = [
160147
'rating' => $rating,
161148
'comment' => $comment,
162149
];
163150
[$status, $result] = $this->apiPost($uri, $params);
164151

165-
if ($status == 201) {
152+
if ($status === 201) {
166153
return true;
167154
}
168155

169156
throw new Exception("Failed to add comment: " . $result);
170157
}
171158

172-
public function reportComment($uri): bool
159+
public function reportComment(string $uri): bool
173160
{
174161
[$status, $result] = $this->apiPost($uri);
175162

176-
if ($status == 202) {
163+
if ($status === 202) {
177164
return true;
178165
}
179166

@@ -189,12 +176,12 @@ public function toggleStar($talk)
189176
{
190177
if ($talk->getStarred()) {
191178
[$status, $result] = $this->apiDelete($talk->getStarredUri(), []);
192-
if ($status == 200) {
179+
if ($status === 200) {
193180
return ['starred' => false];
194181
}
195182
} else {
196183
[$status, $result] = $this->apiPost($talk->getStarredUri(), []);
197-
if ($status == 201) {
184+
if ($status === 201) {
198185
return ['starred' => true];
199186
}
200187
}
@@ -233,10 +220,9 @@ public function getAgenda(string $talksUri): array
233220
/**
234221
* Add a talk to an event
235222
*
236-
* @param string $talksUri
237223
* @param array $data
238224
*/
239-
public function addTalk($talksUri, $data)
225+
public function addTalk(string $talksUri, $data)
240226
{
241227
array_walk($data, function (&$value): void {
242228
if ($value instanceof \DateTimeInterface) {
@@ -281,10 +267,9 @@ public function addTalk($talksUri, $data)
281267
/**
282268
* Edit a talk
283269
*
284-
* @param string $talkUri
285270
* @param array $data
286271
*/
287-
public function editTalk($talkUri, $data)
272+
public function editTalk(string $talkUri, $data)
288273
{
289274
array_walk($data, function (&$value): void {
290275
if ($value instanceof \DateTimeInterface) {
@@ -324,7 +309,7 @@ public function editTalk($talkUri, $data)
324309
throw new \RuntimeException($result);
325310
}
326311

327-
public function claimTalk($talkSpeakersUri, $data): bool
312+
public function claimTalk(string $talkSpeakersUri, $data): bool
328313
{
329314
[$status, $result, $headers] = $this->apiPost($talkSpeakersUri, $data);
330315

@@ -355,10 +340,9 @@ public function rejectTalkClaim(string $talkSpeakersUri, $data): bool
355340
/**
356341
* Add a talk to a track
357342
*
358-
* @param string $talkTracksUri
359343
* @param string $trackUri
360344
*/
361-
public function addTalkToTrack($talkTracksUri, $trackUri): bool
345+
public function addTalkToTrack(string $talkTracksUri, $trackUri): bool
362346
{
363347
$params = [
364348
'track_uri' => $trackUri,

0 commit comments

Comments
 (0)