Skip to content

Commit ade1d8c

Browse files
author
Bizley
authored
Merge pull request #5 from yii-podium/0.2.0
Updates for AR
2 parents 4ef1521 + 191b253 commit ade1d8c

File tree

9 files changed

+40
-40
lines changed

9 files changed

+40
-40
lines changed

‎docs/en/installation.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ file:
88

99
```php
1010
[
11-
'modules' => [
12-
'podium' => \Podium\Api\Module::class,
11+
'components' => [
12+
'podium' => \Podium\Api\Podium::class,
1313
],
1414
]
1515
```
1616

17-
In this case the _module ID_ is `podium`. All application's modules must use unique IDs, so if yours is already using
17+
In this case the _component ID_ is `podium`. All application's components must use unique IDs, so if yours is already using
1818
`podium`, or you would like to choose another word, you can do so, but notice that this documentation is always assuming
1919
the default ID.
2020

2121
# Usage
2222

23-
To use any of Podium components simply call it with module's ID:
23+
To use any of Podium components simply call it with ID chosen above like:
2424

2525
```php
2626
\Yii::$app->podium->componentName->componentMethod();

‎src/Components/Account.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
use Podium\Api\Interfaces\PostRepositoryInterface;
2525
use Podium\Api\Interfaces\ThreadInterface;
2626
use Podium\Api\Interfaces\ThreadRepositoryInterface;
27-
use Podium\Api\Module;
27+
use Podium\Api\Podium;
2828
use Podium\Api\PodiumResponse;
2929
use yii\base\Component;
3030
use yii\base\InvalidConfigException;
@@ -44,17 +44,17 @@ final class Account extends Component implements AccountInterface, PodiumBridgeI
4444
*/
4545
public $userConfig = 'user';
4646

47-
private ?Module $podium = null;
47+
private ?Podium $podium = null;
4848

49-
public function setPodium(Module $podium): void
49+
public function setPodium(Podium $podium): void
5050
{
5151
$this->podium = $podium;
5252
}
5353

5454
/**
5555
* @throws InvalidConfigException
5656
*/
57-
public function getPodium(): Module
57+
public function getPodium(): Podium
5858
{
5959
if (null === $this->podium) {
6060
throw new InvalidConfigException('Podium module is not set!');

‎src/Interfaces/GroupMemberRepositoryInterface.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,6 @@ public function fetchOne(GroupRepositoryInterface $group, MemberRepositoryInterf
1313
public function getErrors(): array;
1414

1515
public function delete(): bool;
16+
17+
public function getParent(): RepositoryInterface;
1618
}

‎src/Interfaces/MemberRepositoryInterface.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ public function register($id, array $data = []): bool;
1717

1818
public function isBanned(): bool;
1919

20-
public function isIgnoring(MemberRepositoryInterface $member): bool;
20+
public function isIgnoring(MemberRepositoryInterface $target): bool;
2121
}

‎src/Interfaces/PodiumBridgeInterface.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
namespace Podium\Api\Interfaces;
66

7-
use Podium\Api\Module;
7+
use Podium\Api\Podium;
88

99
interface PodiumBridgeInterface
1010
{
1111
/**
1212
* Sets Podium module's link.
1313
*/
14-
public function setPodium(Module $podium): void;
14+
public function setPodium(Podium $podium): void;
1515

1616
/**
1717
* Returns Podium module.
1818
*/
19-
public function getPodium(): Module;
19+
public function getPodium(): Podium;
2020
}

‎src/Module.php‎ renamed to ‎src/Podium.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
* @property RankInterface $rank
6262
* @property ThreadInterface $thread
6363
*/
64-
class Module extends ServiceLocator
64+
class Podium extends ServiceLocator
6565
{
6666
private string $version = '0.1.0';
6767

‎tests/Unit/Account/AccountComponentTest.php‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
use Podium\Api\Interfaces\PostRepositoryInterface;
2626
use Podium\Api\Interfaces\ThreadInterface;
2727
use Podium\Api\Interfaces\ThreadRepositoryInterface;
28-
use Podium\Api\Module;
28+
use Podium\Api\Podium;
2929
use Podium\Api\PodiumResponse;
3030
use yii\base\InvalidConfigException;
3131
use yii\web\User;
@@ -135,7 +135,7 @@ public function testJoinGroupShouldCallGroupComponentJoin(): void
135135
$group = $this->createMock(GroupInterface::class);
136136
$group->expects(self::once())->method('join')->willReturn(PodiumResponse::success());
137137

138-
$podium = $this->createMock(Module::class);
138+
$podium = $this->createMock(Podium::class);
139139
$podium->expects(self::once())->method('getGroup')->willReturn($group);
140140
$this->component->setPodium($podium);
141141

@@ -147,7 +147,7 @@ public function testLeaveGroupShouldCallGroupComponentLeave(): void
147147
$group = $this->createMock(GroupInterface::class);
148148
$group->expects(self::once())->method('leave')->willReturn(PodiumResponse::success());
149149

150-
$podium = $this->createMock(Module::class);
150+
$podium = $this->createMock(Podium::class);
151151
$podium->expects(self::once())->method('getGroup')->willReturn($group);
152152
$this->component->setPodium($podium);
153153

@@ -159,7 +159,7 @@ public function testCreateCategoryShouldCallCategoryComponentCreate(): void
159159
$category = $this->createMock(CategoryInterface::class);
160160
$category->expects(self::once())->method('create')->willReturn(PodiumResponse::success());
161161

162-
$podium = $this->createMock(Module::class);
162+
$podium = $this->createMock(Podium::class);
163163
$podium->expects(self::once())->method('getCategory')->willReturn($category);
164164
$this->component->setPodium($podium);
165165

@@ -171,7 +171,7 @@ public function testCreateForumShouldCallForumComponentCreate(): void
171171
$forum = $this->createMock(ForumInterface::class);
172172
$forum->expects(self::once())->method('create')->willReturn(PodiumResponse::success());
173173

174-
$podium = $this->createMock(Module::class);
174+
$podium = $this->createMock(Podium::class);
175175
$podium->expects(self::once())->method('getForum')->willReturn($forum);
176176
$this->component->setPodium($podium);
177177

@@ -183,7 +183,7 @@ public function testCreateThreadShouldCallThreadComponentCreate(): void
183183
$thread = $this->createMock(ThreadInterface::class);
184184
$thread->expects(self::once())->method('create')->willReturn(PodiumResponse::success());
185185

186-
$podium = $this->createMock(Module::class);
186+
$podium = $this->createMock(Podium::class);
187187
$podium->expects(self::once())->method('getThread')->willReturn($thread);
188188
$this->component->setPodium($podium);
189189

@@ -195,7 +195,7 @@ public function testCreatePostShouldCallPostComponentCreate(): void
195195
$post = $this->createMock(PostInterface::class);
196196
$post->expects(self::once())->method('create')->willReturn(PodiumResponse::success());
197197

198-
$podium = $this->createMock(Module::class);
198+
$podium = $this->createMock(Podium::class);
199199
$podium->expects(self::once())->method('getPost')->willReturn($post);
200200
$this->component->setPodium($podium);
201201

@@ -207,7 +207,7 @@ public function testMarkThreadShouldCallThreadComponentMark(): void
207207
$thread = $this->createMock(ThreadInterface::class);
208208
$thread->expects(self::once())->method('mark')->willReturn(PodiumResponse::success());
209209

210-
$podium = $this->createMock(Module::class);
210+
$podium = $this->createMock(Podium::class);
211211
$podium->expects(self::once())->method('getThread')->willReturn($thread);
212212
$this->component->setPodium($podium);
213213

@@ -219,7 +219,7 @@ public function testSubscribeThreadShouldCallThreadComponentSubscribe(): void
219219
$thread = $this->createMock(ThreadInterface::class);
220220
$thread->expects(self::once())->method('subscribe')->willReturn(PodiumResponse::success());
221221

222-
$podium = $this->createMock(Module::class);
222+
$podium = $this->createMock(Podium::class);
223223
$podium->expects(self::once())->method('getThread')->willReturn($thread);
224224
$this->component->setPodium($podium);
225225

@@ -231,7 +231,7 @@ public function testUnsubscribeThreadShouldCallThreadComponentUnsubscribe(): voi
231231
$thread = $this->createMock(ThreadInterface::class);
232232
$thread->expects(self::once())->method('unsubscribe')->willReturn(PodiumResponse::success());
233233

234-
$podium = $this->createMock(Module::class);
234+
$podium = $this->createMock(Podium::class);
235235
$podium->expects(self::once())->method('getThread')->willReturn($thread);
236236
$this->component->setPodium($podium);
237237

@@ -243,7 +243,7 @@ public function testThumbUpPostShouldCallPostComponentThumbUp(): void
243243
$post = $this->createMock(PostInterface::class);
244244
$post->expects(self::once())->method('thumbUp')->willReturn(PodiumResponse::success());
245245

246-
$podium = $this->createMock(Module::class);
246+
$podium = $this->createMock(Podium::class);
247247
$podium->expects(self::once())->method('getPost')->willReturn($post);
248248
$this->component->setPodium($podium);
249249

@@ -255,7 +255,7 @@ public function testThumbDownPostShouldCallPostComponentThumbDown(): void
255255
$post = $this->createMock(PostInterface::class);
256256
$post->expects(self::once())->method('thumbDown')->willReturn(PodiumResponse::success());
257257

258-
$podium = $this->createMock(Module::class);
258+
$podium = $this->createMock(Podium::class);
259259
$podium->expects(self::once())->method('getPost')->willReturn($post);
260260
$this->component->setPodium($podium);
261261

@@ -267,7 +267,7 @@ public function testThumbResetPostShouldCallPostComponentThumbReset(): void
267267
$post = $this->createMock(PostInterface::class);
268268
$post->expects(self::once())->method('thumbReset')->willReturn(PodiumResponse::success());
269269

270-
$podium = $this->createMock(Module::class);
270+
$podium = $this->createMock(Podium::class);
271271
$podium->expects(self::once())->method('getPost')->willReturn($post);
272272
$this->component->setPodium($podium);
273273

@@ -279,7 +279,7 @@ public function testVotePollShouldCallPostComponentVotePoll(): void
279279
$post = $this->createMock(PollPostInterface::class);
280280
$post->expects(self::once())->method('votePoll')->willReturn(PodiumResponse::success());
281281

282-
$podium = $this->createMock(Module::class);
282+
$podium = $this->createMock(Podium::class);
283283
$podium->expects(self::once())->method('getPost')->willReturn($post);
284284
$this->component->setPodium($podium);
285285

@@ -291,7 +291,7 @@ public function testEditShouldCallMemberComponentEdit(): void
291291
$member = $this->createMock(MemberInterface::class);
292292
$member->expects(self::once())->method('edit')->willReturn(PodiumResponse::success());
293293

294-
$podium = $this->createMock(Module::class);
294+
$podium = $this->createMock(Podium::class);
295295
$podium->expects(self::once())->method('getMember')->willReturn($member);
296296
$this->component->setPodium($podium);
297297

@@ -303,7 +303,7 @@ public function testBefriendMemberShouldCallMemberComponentBefriend(): void
303303
$member = $this->createMock(MemberInterface::class);
304304
$member->expects(self::once())->method('befriend')->willReturn(PodiumResponse::success());
305305

306-
$podium = $this->createMock(Module::class);
306+
$podium = $this->createMock(Podium::class);
307307
$podium->expects(self::once())->method('getMember')->willReturn($member);
308308
$this->component->setPodium($podium);
309309

@@ -315,7 +315,7 @@ public function testUnfriendMemberShouldCallMemberComponentUnfriend(): void
315315
$member = $this->createMock(MemberInterface::class);
316316
$member->expects(self::once())->method('unfriend')->willReturn(PodiumResponse::success());
317317

318-
$podium = $this->createMock(Module::class);
318+
$podium = $this->createMock(Podium::class);
319319
$podium->expects(self::once())->method('getMember')->willReturn($member);
320320
$this->component->setPodium($podium);
321321

@@ -327,7 +327,7 @@ public function testIgnoreMemberShouldCallMemberComponentIgnore(): void
327327
$member = $this->createMock(MemberInterface::class);
328328
$member->expects(self::once())->method('ignore')->willReturn(PodiumResponse::success());
329329

330-
$podium = $this->createMock(Module::class);
330+
$podium = $this->createMock(Podium::class);
331331
$podium->expects(self::once())->method('getMember')->willReturn($member);
332332
$this->component->setPodium($podium);
333333

@@ -339,7 +339,7 @@ public function testUnignoreMemberShouldCallMemberComponentUnignore(): void
339339
$member = $this->createMock(MemberInterface::class);
340340
$member->expects(self::once())->method('unignore')->willReturn(PodiumResponse::success());
341341

342-
$podium = $this->createMock(Module::class);
342+
$podium = $this->createMock(Podium::class);
343343
$podium->expects(self::once())->method('getMember')->willReturn($member);
344344
$this->component->setPodium($podium);
345345

@@ -351,7 +351,7 @@ public function testSendMessageShouldCallMessageComponentSend(): void
351351
$message = $this->createMock(MessageInterface::class);
352352
$message->expects(self::once())->method('send')->willReturn(PodiumResponse::success());
353353

354-
$podium = $this->createMock(Module::class);
354+
$podium = $this->createMock(Podium::class);
355355
$podium->expects(self::once())->method('getMessage')->willReturn($message);
356356
$this->component->setPodium($podium);
357357

@@ -363,7 +363,7 @@ public function testRemoveMessageShouldCallMessageComponentRemove(): void
363363
$message = $this->createMock(MessageInterface::class);
364364
$message->expects(self::once())->method('remove')->willReturn(PodiumResponse::success());
365365

366-
$podium = $this->createMock(Module::class);
366+
$podium = $this->createMock(Podium::class);
367367
$podium->expects(self::once())->method('getMessage')->willReturn($message);
368368
$this->component->setPodium($podium);
369369

@@ -375,7 +375,7 @@ public function testArchiveMessageShouldCallMessageComponentArchive(): void
375375
$message = $this->createMock(MessageInterface::class);
376376
$message->expects(self::once())->method('archive')->willReturn(PodiumResponse::success());
377377

378-
$podium = $this->createMock(Module::class);
378+
$podium = $this->createMock(Podium::class);
379379
$podium->expects(self::once())->method('getMessage')->willReturn($message);
380380
$this->component->setPodium($podium);
381381

@@ -387,7 +387,7 @@ public function testReviveMessageShouldCallMessageComponentRevive(): void
387387
$message = $this->createMock(MessageInterface::class);
388388
$message->expects(self::once())->method('revive')->willReturn(PodiumResponse::success());
389389

390-
$podium = $this->createMock(Module::class);
390+
$podium = $this->createMock(Podium::class);
391391
$podium->expects(self::once())->method('getMessage')->willReturn($message);
392392
$this->component->setPodium($podium);
393393

@@ -399,7 +399,7 @@ public function testLogShouldCallLoggerComponentCreate(): void
399399
$logger = $this->createMock(LoggerInterface::class);
400400
$logger->expects(self::once())->method('create')->willReturn(PodiumResponse::success());
401401

402-
$podium = $this->createMock(Module::class);
402+
$podium = $this->createMock(Podium::class);
403403
$podium->expects(self::once())->method('getLogger')->willReturn($logger);
404404
$this->component->setPodium($podium);
405405

‎tests/Unit/PodiumTest.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
use Podium\Api\Interfaces\PostInterface;
2525
use Podium\Api\Interfaces\RankInterface;
2626
use Podium\Api\Interfaces\ThreadInterface;
27-
use Podium\Api\Module as Podium;
27+
use Podium\Api\Podium;
2828
use Podium\Tests\AppTestCase;
2929
use Yii;
3030

‎tests/bootstrap.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,3 @@
1111

1212
require_once __DIR__ . '/../vendor/autoload.php';
1313
require_once __DIR__ . '/../vendor/yiisoft/yii2/Yii.php';
14-
15-
Yii::setAlias('@bizley/podium/api', __DIR__ . '/../src/');

0 commit comments

Comments
 (0)