LogWritten::toMail() - Code Metrics - SierraTecnologia/Audit - Measure and Improve Code Quality continuously with Scrutinizer

LogWritten::toMail() B
last analyzed 2021-05-30 00:16 UTC

↳ Parent: LogWritten

Complexity

Conditions	6
Paths	24

Size

Total Lines

Duplication

Lines	5
Ratio	11.36 %

Importance

Changes

Metric	Value
dl	5
loc	44
rs	8.5937
c	0
b	0
f	0
cc	6
nc	24
nop	1

<?php

namespace Audit\Notifications\Logs;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
use Illuminate\Notifications\Messages\SlackMessage;
use Audit\Models\Logs\Finger;

class LogWritten extends Notification implements ShouldQueue
{
    use Queueable;

    private $laraLogsLog;

    private $requestInfo;

    private $notificationLevels;

    /**
     * Create a new notification instance.
     *
     * @return void

     */
    public function __construct(Finger $laraLogsLog)
    {
        $this->laraLogsLog = $laraLogsLog;

        $this->requestInfo = array(
            'id' => $laraLogsLog->id,
            'level' => $laraLogsLog->level,
            'message' => $laraLogsLog->message,
            'user_id' => $laraLogsLog->user_id ? $laraLogsLog->user_id : null,
            'email' => $laraLogsLog->email ? $laraLogsLog->email : null
        );

        $this->notificationLevels = array(
            'error' => [
                'emergency',
                'alert',
                'critical',
                'error'
            ],
            'warning' => [
                'warning',
                'notice'
            ],
            'success' => [
                'info',
                'debug'
            ]
        );
    }

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

    {
        switch($notifiable->notify_by) {
        case 'email':
            return ['mail'];
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'slack':
            return ['slack'];
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        case 'email_slack':
            return ['mail', 'slack'];
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
    }

    /**
     * Get the mail representation of the notification.
     *
     * @param  mixed $notifiable
     * @return \Illuminate\Notifications\Messages\MailMessage
     */
    public function toMail($notifiable)
    {
        $content = 'A log on ' . url('/') . ' has been written to.';
        if($notifiable->filter !== '*') {
            $content .= " You're being notified because the log contains `" . $notifiable->filter . "`";
        }

        $status = 'success';
        foreach($this->notificationLevels as $triggerLevel => $childLevels) {

            if(in_array($this->requestInfo['level'], $childLevels)) {
                $status = $triggerLevel;
            }
        }

        $fields = array(
            'Level' => $this->requestInfo['level'],
            'Message' => $this->requestInfo['message']
        );

        if($this->requestInfo['user_id']) {
            $fields['User ID'] = $this->requestInfo['user_id'];
        }

        if($this->requestInfo['email']) {
            $fields['Associated Email'] = $this->requestInfo['email'];
        }

        $statusColors = array(
            'success' => '#00B945',
            'warning' => '#ff9f00',
            'error' => '#BC001A'
        );

        return (new MailMessage)
            ->subject(env('LARALogs_LOG_SUBJECT', '[LaraLogs Alert] The application log has been written to'))
            ->from(env('LARALogs_FROM_EMAIL', '[email protected]'), env('LARALogs_FROM_NAME', 'LaraLogs Alerts'))
            ->view(
                'laraLogs::emails.log-written', [
                'requestInfo' => $this->requestInfo,
                'content' => $content,
                'alertColor' => $statusColors[$status]
                ]
            );
    }

    public function toSlack($notifiable)
    {
        $content = 'A log on ' . url('/') . ' has been written to.';
        if($notifiable->filter !== '*') {
            $content .= " You're being notified because the log contains `" . $notifiable->filter . "`";
        }

        $status = 'success';
        foreach($this->notificationLevels as $triggerLevel => $childLevels) {

            if(in_array($this->requestInfo['level'], $childLevels)) {
                $status = $triggerLevel;
            }
        }

        $fields = array(
            'Level' => $this->requestInfo['level'],
            'Message' => $this->requestInfo['message']
        );

        if($this->requestInfo['user_id']) {
            $fields['User ID'] = $this->requestInfo['user_id'];
        }

        if($this->requestInfo['email']) {
            $fields['Associated Email'] = $this->requestInfo['email'];
        }

        $requestInfo = $this->requestInfo;

        return (new SlackMessage)
            ->{ $status }()
            ->attachment(
                function ($attachment) use ($requestInfo, $fields, $content) {
                    $attachment->title('Log #' . $requestInfo['id'], route('laraLogs::logs.show', $requestInfo['id']))
                        ->content($content)
                        ->fields($fields);
                }
            );
    }

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

    {
        return [
            //
        ];
    }
}


1		<?php
2
3		namespace Audit\Notifications\Logs;
4
5		use Illuminate\Bus\Queueable;
6		use Illuminate\Notifications\Notification;
7		use Illuminate\Contracts\Queue\ShouldQueue;
8		use Illuminate\Notifications\Messages\MailMessage;
9		use Illuminate\Notifications\Messages\SlackMessage;
10		use Audit\Models\Logs\Finger;
11
12		class LogWritten extends Notification implements ShouldQueue
13		{
14		use Queueable;
15
16		private $laraLogsLog;
17
18		private $requestInfo;
19
20		private $notificationLevels;
21
22		/**
23		* Create a new notification instance.
24		*
25		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
26		*/
27		public function __construct(Finger $laraLogsLog)
28		{
29		$this->laraLogsLog = $laraLogsLog;
30
31		$this->requestInfo = array(
32		'id' => $laraLogsLog->id,
33		'level' => $laraLogsLog->level,
34		'message' => $laraLogsLog->message,
35		'user_id' => $laraLogsLog->user_id ? $laraLogsLog->user_id : null,
36		'email' => $laraLogsLog->email ? $laraLogsLog->email : null
37		);
38
39		$this->notificationLevels = array(
40		'error' => [
41		'emergency',
42		'alert',
43		'critical',
44		'error'
45		],
46		'warning' => [
47		'warning',
48		'notice'
49		],
50		'success' => [
51		'info',
52		'debug'
53		]
54		);
55		}
56
57		/**
58		* Get the notification's delivery channels.
59		*
60		* @param mixed $notifiable
61		* @return array
62		*/
63	View Code Duplication	public function via($notifiable)
		0 ignored issues – show Duplication introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
64		{
65		switch($notifiable->notify_by) {
66		case 'email':
67		return ['mail'];
68		break;
		0 ignored issues – show Unused Code introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
69		case 'slack':
70		return ['slack'];
71		break;
		0 ignored issues – show Unused Code introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
72		case 'email_slack':
73		return ['mail', 'slack'];
74		break;
		0 ignored issues – show Unused Code introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
75		}
76		}
77
78		/**
79		* Get the mail representation of the notification.
80		*
81		* @param mixed $notifiable
82		* @return \Illuminate\Notifications\Messages\MailMessage
83		*/
84		public function toMail($notifiable)
85		{
86		$content = 'A log on ' . url('/') . ' has been written to.';
87		if($notifiable->filter !== '*') {
88		$content .= " You're being notified because the log contains `" . $notifiable->filter . "`";
89		}
90
91		$status = 'success';
92	View Code Duplication	foreach($this->notificationLevels as $triggerLevel => $childLevels) {
		0 ignored issues – show Duplication introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
93		if(in_array($this->requestInfo['level'], $childLevels)) {
94		$status = $triggerLevel;
95		}
96		}
97
98		$fields = array(
99		'Level' => $this->requestInfo['level'],
100		'Message' => $this->requestInfo['message']
101		);
102
103		if($this->requestInfo['user_id']) {
104		$fields['User ID'] = $this->requestInfo['user_id'];
105		}
106
107		if($this->requestInfo['email']) {
108		$fields['Associated Email'] = $this->requestInfo['email'];
109		}
110
111		$statusColors = array(
112		'success' => '#00B945',
113		'warning' => '#ff9f00',
114		'error' => '#BC001A'
115		);
116
117		return (new MailMessage)
118		->subject(env('LARALogs_LOG_SUBJECT', '[LaraLogs Alert] The application log has been written to'))
119		->from(env('LARALogs_FROM_EMAIL', '[email protected]'), env('LARALogs_FROM_NAME', 'LaraLogs Alerts'))
120		->view(
121		'laraLogs::emails.log-written', [
122		'requestInfo' => $this->requestInfo,
123		'content' => $content,
124		'alertColor' => $statusColors[$status]
125		]
126		);
127		}
128
129		public function toSlack($notifiable)
130		{
131		$content = 'A log on ' . url('/') . ' has been written to.';
132		if($notifiable->filter !== '*') {
133		$content .= " You're being notified because the log contains `" . $notifiable->filter . "`";
134		}
135
136		$status = 'success';
137	View Code Duplication	foreach($this->notificationLevels as $triggerLevel => $childLevels) {
		0 ignored issues – show Duplication introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
138		if(in_array($this->requestInfo['level'], $childLevels)) {
139		$status = $triggerLevel;
140		}
141		}
142
143		$fields = array(
144		'Level' => $this->requestInfo['level'],
145		'Message' => $this->requestInfo['message']
146		);
147
148		if($this->requestInfo['user_id']) {
149		$fields['User ID'] = $this->requestInfo['user_id'];
150		}
151
152		if($this->requestInfo['email']) {
153		$fields['Associated Email'] = $this->requestInfo['email'];
154		}
155
156		$requestInfo = $this->requestInfo;
157
158		return (new SlackMessage)
159		->{ $status }()
160		->attachment(
161		function ($attachment) use ($requestInfo, $fields, $content) {
162		$attachment->title('Log #' . $requestInfo['id'], route('laraLogs::logs.show', $requestInfo['id']))
163		->content($content)
164		->fields($fields);
165		}
166		);
167		}
168
169		/**
170		* Get the array representation of the notification.
171		*
172		* @param mixed $notifiable
173		* @return array
174		*/
175		public function toArray($notifiable)
		0 ignored issues – show Unused Code introduced 2020-07-23 04:03 UTC by Report Bug Copy Issue Report The parameter `$notifiable` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
176		{
177		return [
178		//
179		];
180		}
181		}
182

SierraTecnologia / Audit

LogWritten::toMail() B last analyzed 2021-05-30 00:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

LogWritten::toMail() B
last analyzed 2021-05-30 00:16 UTC