JobApis\JobsToMail\Notifications\JobsCollected

Complexity

Total Complexity

6

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	via()	0	4	1
A	toArray()	0	7	1
B	toMail()	0	33	3

<?php namespace JobApis\JobsToMail\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\SerializesModels;
use JobApis\JobsToMail\Models\Search;
use JobApis\JobsToMail\Notifications\Messages\JobMailMessage;

class JobsCollected extends Notification implements ShouldQueue
{
    use Queueable, SerializesModels;

    /**
     * @var array of Job objects
     */
    protected $jobs;

    /**
     * @var Search
     */
    protected $search;

    /**
     * Create a new notification instance.
     *
     * @param array $jobs
     * @param Search $search
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(array $jobs, Search $search)
    {
        $this->jobs = $jobs;
        $this->search = $search;
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)

The parameter $notifiable is not used and could be removed.

    {
        return ['mail', 'database'];
    }

    /**
     * Get the array representation of the notification for saving to the database.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function toArray($notifiable)

The parameter $notifiable is not used and could be removed.

    {
        return [
            'search_id' => $this->search->id,
            'jobs' => $this->jobs,
        ];
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        // Instantiate the message
        $message = new JobMailMessage();

        // Add user and search ID to view data
        $message->viewData['user_id'] = $notifiable->id;
        $message->viewData['search_id'] = $this->search->id;

        // Update the subject
        $message->subject(count($this->jobs).' job listings found especially for you');

        // Update the message text
        $message->greeting('Hello,')
            ->line('We found the following jobs that we think 
                you\'ll be interested in based on your search:')
            ->line("\"{$this->search->keyword}\" in \"{$this->search->location}\"");

        // Add jobs
        foreach ($this->jobs as $job) {
            $message->listing($job);
        }

        // Add a link to download the collection
        if ($notifiable->isPremium()) {
            $message->action(
                'Download CSV',
                url('/collections/' . $this->id . '/download')

It seems like url('/collections/' . $this->id . '/download') targeting url() can also be of type object<Illuminate\Contracts\Routing\UrlGenerator>; however, Illuminate\Notifications\Messages\SimpleMessage::action() does only seem to accept string, maybe add an additional type check?

            );
        }

        return $message;
    }
}