Skip to content

Commit

Permalink
Rename abstract event classes
Browse files Browse the repository at this point in the history
  • Loading branch information
pdavide committed Apr 17, 2019
1 parent 0813504 commit 6c14318
Show file tree
Hide file tree
Showing 13 changed files with 29 additions and 34 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<?php

namespace App\Events\PublicAdministration\Contracts;
namespace App\Events\PublicAdministration;

use App\Models\PublicAdministration;
use Illuminate\Queue\SerializesModels;

/**
* Public Administration event contract.
*/
abstract class PublicAdministrationEvent
abstract class AbstractPublicAdministrationEvent
{
use SerializesModels;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

namespace App\Events\PublicAdministration;

use App\Events\PublicAdministration\Contracts\PublicAdministrationEvent;

/**
* PublicAdministration activated event.
*/
class PublicAdministrationActivated extends PublicAdministrationEvent
class PublicAdministrationActivated extends AbstractPublicAdministrationEvent
{
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@

namespace App\Events\PublicAdministration;

use App\Events\PublicAdministration\Contracts\PublicAdministrationEvent;
use App\Models\PublicAdministration;

/**
* Public Administration activation failed event.
*/
class PublicAdministrationActivationFailed extends PublicAdministrationEvent
class PublicAdministrationActivationFailed extends AbstractPublicAdministrationEvent
{
/**
* The activation error message.
Expand Down
12 changes: 6 additions & 6 deletions app/Events/PublicAdministration/PublicAdministrationPurged.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ class PublicAdministrationPurged
*
* @var string the JSON string
*/
protected $publicAdministration;
protected $publicAdministrationJson;

/**
* Event constructor.
*
* @param string $publicAdministration the JSON string of the public administration
* @param string $publicAdministrationJson the JSON string of the public administration
*/
public function __construct(string $publicAdministration)
public function __construct(string $publicAdministrationJson)
{
$this->publicAdministration = $publicAdministration;
$this->publicAdministrationJson = $publicAdministrationJson;
}

/**
* Get the JSON string representation.
*
* @return string the JSON string
*/
public function getPublicAdministration(): string
public function getPublicAdministrationJson(): string
{
return $this->publicAdministration;
return $this->publicAdministrationJson;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@

namespace App\Events\PublicAdministration;

use App\Events\PublicAdministration\Contracts\PublicAdministrationEvent;
use App\Models\PublicAdministration;

/**
* Public Administration updated event.
*/
class PublicAdministrationUpdated extends PublicAdministrationEvent
class PublicAdministrationUpdated extends AbstractPublicAdministrationEvent
{
/**
* The changes list.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@

namespace App\Events\PublicAdministration;

use App\Events\PublicAdministration\Contracts\PublicAdministrationEvent;
use App\Models\PublicAdministration;
use App\Models\Website;

/**
* Public Administration primary website changed event.
*/
class PublicAdministrationWebsiteUpdated extends PublicAdministrationEvent
class PublicAdministrationWebsiteUpdated extends AbstractPublicAdministrationEvent
{
/**
* The current primary website.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<?php

namespace App\Events\Website\Contracts;
namespace App\Events\Website;

use App\Models\Website;
use Illuminate\Queue\SerializesModels;

/**
* Website event contract.
*/
abstract class WebsiteEvent
abstract class AbstractWebsiteEvent
{
use SerializesModels;

Expand Down
4 changes: 1 addition & 3 deletions app/Events/Website/WebsiteActivated.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

namespace App\Events\Website;

use App\Events\Website\Contracts\WebsiteEvent;

/**
* Website activated event.
*/
class WebsiteActivated extends WebsiteEvent
class WebsiteActivated extends AbstractWebsiteEvent
{
}
12 changes: 6 additions & 6 deletions app/Events/Website/WebsitePurged.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ class WebsitePurged
*
* @var string the JSON string
*/
protected $website;
protected $websiteJson;

/**
* Event constructor.
*
* @param string $website the JSON string of the website
* @param string $websiteJson the JSON string of the website
*/
public function __construct(string $website)
public function __construct(string $websiteJson)
{
$this->website = $website;
$this->websiteJson = $websiteJson;
}

/**
* Get the JSON string representation.
*
* @return string the JSON string
*/
public function getWebsite(): string
public function getWebsiteJson(): string
{
return $this->website;
return $this->websiteJson;
}
}
4 changes: 1 addition & 3 deletions app/Events/Website/WebsitePurging.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

namespace App\Events\Website;

use App\Events\Website\Contracts\WebsiteEvent;

/**
* Website near to be purged event.
*/
class WebsitePurging extends WebsiteEvent
class WebsitePurging extends AbstractWebsiteEvent
{
}
4 changes: 3 additions & 1 deletion app/Listeners/PublicAdministrationEventsSubscriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@ public function onPrimaryWebsiteUpdated(PublicAdministrationWebsiteUpdated $even
*/
public function onPurged(PublicAdministrationPurged $event): void
{
logger()->info('Public Administration ' . $event->getPublicAdministration() . ' purged');
$publicAdministration = json_decode($event->getPublicAdministrationJson());
$publicAdministrationInfo = '"' . $publicAdministration->name . '" [' . $publicAdministration->ipa_code . ']';
logger()->info('Public Administration ' . $publicAdministrationInfo . ' purged');
}

/**
Expand Down
4 changes: 3 additions & 1 deletion app/Listeners/WebsiteEventsSubscriber.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ public function onPurging(WebsitePurging $event): void
*/
public function onPurged(WebsitePurged $event): void
{
logger()->info('Website ' . $event->getWebsite() . ' purged');
$website = json_decode($event->getWebsiteJson());
$websiteInfo = '"' . $website->name . '" [' . $website->slug . ']';
logger()->info('Website ' . $websiteInfo . ' purged');
}

/**
Expand Down
2 changes: 1 addition & 1 deletion tests/Unit/CheckWebsitesTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public function testCheckWebsitePurged(): void
$job->handle();

Event::assertDispatched(PublicAdministrationPurged::class, function ($event) use ($publicAdministration) {
return json_decode($event->getPublicAdministration())->ipa_code === $publicAdministration->ipa_code;
return json_decode($event->getPublicAdministrationJson())->ipa_code === $publicAdministration->ipa_code;
});

Event::assertDispatched(PendingWebsitesCheckCompleted::class, function ($event) use ($website) {
Expand Down

0 comments on commit 6c14318

Please sign in to comment.