Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PHPDoc Cleanup #664

Merged
merged 3 commits into from
Apr 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions app/Bots/CasinoBot.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ class CasinoBot

/**
* NerdBot Constructor.
* @param ChatRepository $chat
*/
public function __construct(ChatRepository $chat)
{
Expand All @@ -49,6 +50,8 @@ public function __construct(ChatRepository $chat)

/**
* Replace Vars.
* @param $output
* @return mixed
*/
public function replaceVars($output)
{
Expand All @@ -68,6 +71,9 @@ public function replaceVars($output)

/**
* Send Bot Donation.
* @param int $amount
* @param string $note
* @return string
*/
public function putDonate($amount = 0, $note = '')
{
Expand Down Expand Up @@ -105,6 +111,8 @@ public function putDonate($amount = 0, $note = '')

/**
* Get Bot Donations.
* @param string $duration
* @return string
*/
public function getDonations($duration = 'default')
{
Expand Down Expand Up @@ -133,6 +141,11 @@ public function getHelp()

/**
* Process Message.
* @param $type
* @param User $target
* @param string $message
* @param int $targeted
* @return bool
*/
public function process($type, User $target, $message = '', $targeted = 0)
{
Expand Down
37 changes: 37 additions & 0 deletions app/Bots/NerdBot.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class NerdBot

/**
* NerdBot Constructor.
* @param ChatRepository $chat
*/
public function __construct(ChatRepository $chat)
{
Expand All @@ -53,6 +54,8 @@ public function __construct(ChatRepository $chat)

/**
* Replace Vars.
* @param $output
* @return mixed
*/
public function replaceVars($output)
{
Expand All @@ -72,6 +75,8 @@ public function replaceVars($output)

/**
* Get Banker.
* @param string $duration
* @return string
*/
public function getBanker($duration = 'default')
{
Expand All @@ -86,6 +91,8 @@ public function getBanker($duration = 'default')

/**
* Get Snatched.
* @param string $duration
* @return string
*/
public function getSnatched($duration = 'default')
{
Expand All @@ -100,6 +107,8 @@ public function getSnatched($duration = 'default')

/**
* Get Leeched.
* @param string $duration
* @return string
*/
public function getLeeched($duration = 'default')
{
Expand All @@ -114,6 +123,8 @@ public function getLeeched($duration = 'default')

/**
* Get Seeded.
* @param string $duration
* @return string
*/
public function getSeeded($duration = 'default')
{
Expand All @@ -128,6 +139,8 @@ public function getSeeded($duration = 'default')

/**
* Get FL.
* @param string $duration
* @return string
*/
public function getFreeleech($duration = 'default')
{
Expand All @@ -142,6 +155,8 @@ public function getFreeleech($duration = 'default')

/**
* Get DU.
* @param string $duration
* @return string
*/
public function getDoubleUpload($duration = 'default')
{
Expand All @@ -156,6 +171,8 @@ public function getDoubleUpload($duration = 'default')

/**
* Get Peers.
* @param string $duration
* @return string
*/
public function getPeers($duration = 'default')
{
Expand All @@ -170,6 +187,8 @@ public function getPeers($duration = 'default')

/**
* Get Bans.
* @param string $duration
* @return string
*/
public function getBans($duration = 'default')
{
Expand All @@ -184,6 +203,8 @@ public function getBans($duration = 'default')

/**
* Get Warnings.
* @param string $duration
* @return string
*/
public function getWarnings($duration = 'default')
{
Expand All @@ -198,6 +219,8 @@ public function getWarnings($duration = 'default')

/**
* Get Uploads.
* @param string $duration
* @return string
*/
public function getUploads($duration = 'default')
{
Expand All @@ -212,6 +235,8 @@ public function getUploads($duration = 'default')

/**
* Get Logins.
* @param string $duration
* @return string
*/
public function getLogins($duration = 'default')
{
Expand All @@ -226,6 +251,8 @@ public function getLogins($duration = 'default')

/**
* Get Registrations.
* @param string $duration
* @return string
*/
public function getRegistrations($duration = 'default')
{
Expand All @@ -240,6 +267,8 @@ public function getRegistrations($duration = 'default')

/**
* Get Bot Donations.
* @param string $duration
* @return string
*/
public function getDonations($duration = 'default')
{
Expand Down Expand Up @@ -276,6 +305,9 @@ public function getKing()

/**
* Send Bot Donation.
* @param int $amount
* @param string $note
* @return string
*/
public function putDonate($amount = 0, $note = '')
{
Expand Down Expand Up @@ -313,6 +345,11 @@ public function putDonate($amount = 0, $note = '')

/**
* Process Message.
* @param $type
* @param User $target
* @param string $message
* @param int $targeted
* @return bool
*/
public function process($type, User $target, $message = '', $targeted = 0)
{
Expand Down
12 changes: 12 additions & 0 deletions app/Bots/SystemBot.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class SystemBot

/**
* SystemBot Constructor.
* @param ChatRepository $chat
*/
public function __construct(ChatRepository $chat)
{
Expand All @@ -46,6 +47,8 @@ public function __construct(ChatRepository $chat)

/**
* Replace Vars.
* @param $output
* @return mixed
*/
public function replaceVars($output)
{
Expand Down Expand Up @@ -73,6 +76,10 @@ public function getHelp()

/**
* Send Gift.
* @param string $receiver
* @param int $amount
* @param string $note
* @return string
*/
public function putGift($receiver = '', $amount = 0, $note = '')
{
Expand Down Expand Up @@ -127,6 +134,11 @@ public function putGift($receiver = '', $amount = 0, $note = '')

/**
* Process Message.
* @param $type
* @param User $target
* @param string $message
* @param int $targeted
* @return bool
*/
public function process($type, User $target, $message = '', $targeted = 0)
{
Expand Down
1 change: 1 addition & 0 deletions app/Console/Commands/FetchGenres.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class FetchGenres extends Command
* Execute the console command.
*
* @return mixed
* @throws \ErrorException
*/
public function handle()
{
Expand Down
7 changes: 4 additions & 3 deletions app/Events/Chatter.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
namespace App\Events;

use App\Models\Message;
use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Foundation\Events\Dispatchable;
Expand All @@ -40,7 +39,9 @@ class Chatter implements ShouldBroadcastNow
/**
* Create a new event instance.
*
* @return void
* @param $type
* @param $target
* @param $payload
*/
public function __construct($type, $target, $payload)
{
Expand All @@ -62,7 +63,7 @@ public function __construct($type, $target, $payload)
/**
* Get the channels the event should broadcast on.
*
* @return Channel|array
* @return PrivateChannel
*/
public function broadcastOn()
{
Expand Down
5 changes: 2 additions & 3 deletions app/Events/MessageDeleted.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
namespace App\Events;

use App\Models\Message;
use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Foundation\Events\Dispatchable;
Expand All @@ -35,7 +34,7 @@ class MessageDeleted implements ShouldBroadcastNow
/**
* Create a new event instance.
*
* @return void
* @param Message $message
*/
public function __construct(Message $message)
{
Expand All @@ -45,7 +44,7 @@ public function __construct(Message $message)
/**
* Get the channels the event should broadcast on.
*
* @return Channel|array
* @return PresenceChannel
*/
public function broadcastOn()
{
Expand Down
5 changes: 2 additions & 3 deletions app/Events/MessageEdited.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
namespace App\Events;

use App\Models\Message;
use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use App\Http\Resources\ChatMessageResource;
use Illuminate\Broadcasting\PresenceChannel;
Expand All @@ -36,7 +35,7 @@ class MessageEdited implements ShouldBroadcastNow
/**
* Create a new event instance.
*
* @return void
* @param Message $message
*/
public function __construct(Message $message)
{
Expand All @@ -47,7 +46,7 @@ public function __construct(Message $message)
/**
* Get the channels the event should broadcast on.
*
* @return Channel|array
* @return PresenceChannel
*/
public function broadcastOn()
{
Expand Down
5 changes: 2 additions & 3 deletions app/Events/MessageSent.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
namespace App\Events;

use App\Models\Message;
use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use App\Http\Resources\ChatMessageResource;
use Illuminate\Broadcasting\PresenceChannel;
Expand All @@ -36,7 +35,7 @@ class MessageSent implements ShouldBroadcastNow
/**
* Create a new event instance.
*
* @return void
* @param Message $message
*/
public function __construct(Message $message)
{
Expand All @@ -54,7 +53,7 @@ public function __construct(Message $message)
/**
* Get the channels the event should broadcast on.
*
* @return Channel|array
* @return PresenceChannel
*/
public function broadcastOn()
{
Expand Down
6 changes: 3 additions & 3 deletions app/Events/Ping.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Queue\SerializesModels;
use Illuminate\Broadcasting\PresenceChannel;
use Illuminate\Foundation\Events\Dispatchable;
Expand All @@ -30,7 +29,8 @@ class Ping implements ShouldBroadcastNow
/**
* Create a new event instance.
*
* @return void
* @param $room
* @param $id
*/
public function __construct($room, $id)
{
Expand All @@ -41,7 +41,7 @@ public function __construct($room, $id)
/**
* Get the channels the event should broadcast on.
*
* @return Channel|array
* @return PresenceChannel
*/
public function broadcastOn()
{
Expand Down
Loading