MailResult::__construct() - Code Metrics - acelaya/ZF2-AcMailer - Measure and Improve Code Quality continuously with Scrutinizer

MailResult::__construct() A
last analyzed 2017-12-09 14:22 UTC

↳ Parent: MailResult

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	3
crap	1

<?php
declare(strict_types=1);

namespace AcMailer\Result;

use AcMailer\Model\Email;

/**
 * Object returned by send method in MailService
 * @see \AcMailer\Service\MailServiceInterface
 * @author Alejandro Celaya Alastrué
 * @link http://www.alejandrocelaya.com
 */
class MailResult implements ResultInterface
{
    /**
     * @var bool
     */
    private $valid;
    /**
     * @var Email
     */
    private $email;
    /**
     * @var \Throwable
     */
    private $exception;

    public function __construct(Email $email, bool $valid = true, \Throwable $exception = null)
    {
        $this->email = $email;
        $this->valid = $valid;
        $this->exception = $exception;
    }

    /**
     * Returns the email that was tried to be sent
     * @return Email
     */
    public function getEmail(): Email
    {
        return $this->email;
    }

    /**
     * Tells if the MailService that produced this result was properly sent
     * @return bool
     */
    public function isValid(): bool
    {
        return $this->valid;
    }

    /**
     * Tells if this Result has an exception. Usually only non-valid result should wrap an exception
     * @return bool
     */
    public function hasException(): bool
    {
        return $this->exception !== null;
    }

    /**
     * Returns the exception wrapped by this Result if any, or null otherwise
     * @return \Throwable|null
     */
    public function getException()
    {
        return $this->exception;
    }

    /**
     * Tells if the email sending was cancelled, usually by a preSend listener
     * @return bool
     */
    public function isCancelled(): bool
    {
        return ! $this->isValid() && ! $this->hasException();
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace AcMailer\Result;
5
6		use AcMailer\Model\Email;
7
8		/**
9		* Object returned by send method in MailService
10		* @see \AcMailer\Service\MailServiceInterface
11		* @author Alejandro Celaya Alastrué
12		* @link http://www.alejandrocelaya.com
13		*/
14		class MailResult implements ResultInterface
15		{
16		/**
17		* @var bool
18		*/
19		private $valid;
20		/**
21		* @var Email
22		*/
23		private $email;
24		/**
25		* @var \Throwable
26		*/
27		private $exception;
28
29	18	public function __construct(Email $email, bool $valid = true, \Throwable $exception = null)
30		{
31	18	$this->email = $email;
32	18	$this->valid = $valid;
33	18	$this->exception = $exception;
34	18	}
35
36		/**
37		* Returns the email that was tried to be sent
38		* @return Email
39		*/
40	5	public function getEmail(): Email
41		{
42	5	return $this->email;
43		}
44
45		/**
46		* Tells if the MailService that produced this result was properly sent
47		* @return bool
48		*/
49	11	public function isValid(): bool
50		{
51	11	return $this->valid;
52		}
53
54		/**
55		* Tells if this Result has an exception. Usually only non-valid result should wrap an exception
56		* @return bool
57		*/
58	3	public function hasException(): bool
59		{
60	3	return $this->exception !== null;
61		}
62
63		/**
64		* Returns the exception wrapped by this Result if any, or null otherwise
65		* @return \Throwable\|null
66		*/
67	3	public function getException()
68		{
69	3	return $this->exception;
70		}
71
72		/**
73		* Tells if the email sending was cancelled, usually by a preSend listener
74		* @return bool
75		*/
76		public function isCancelled(): bool
77		{
78		return ! $this->isValid() && ! $this->hasException();
79		}
80		}
81

acelaya / ZF2-AcMailer

MailResult::__construct() A last analyzed 2017-12-09 14:22 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

MailResult::__construct() A
last analyzed 2017-12-09 14:22 UTC