Swift_Mime_Headers_PathHeader::getFieldBody() - Code Metrics - Inspection of "[+]: use "Swift::strtolowerWithStaticCache()" for..." - voku/swiftmailer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 5.x ( 801190...049872 )

by Lars

created 2016-05-28 11:14 UTC

Swift_Mime_Headers_PathHeader::getFieldBody() A

↳ Parent: Swift_Mime_Headers_PathHeader

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

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

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * A Path Header in Swift Mailer, such a Return-Path.
 *
 * @author Chris Corbyn
 */
class Swift_Mime_Headers_PathHeader extends Swift_Mime_Headers_AbstractHeader
namespace YourVendor;

class YourClass { }
{
    /**
     * The address in this Header (if specified).
     *
     * @var string
     */
    private $_address;

    /**
     * The strict EmailValidator
     *
     * @var Swift_EmailValidatorBridge
     */
    private $_emailValidator;

    /**
     * Creates a new PathHeader with the given $name.
     *
     * @param string                     $name
     * @param Swift_EmailValidatorBridge $emailValidator
     */
    public function __construct($name, $emailValidator)
    {
        $this->setFieldName($name);
        $this->_emailValidator = $emailValidator;
        parent::__construct();
    }

    /**
     * Get the type of Header that this instance represents.
     *
     * @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
     * @see TYPE_DATE, TYPE_ID, TYPE_PATH
     *
     * @return int
     */
    public function getFieldType()
    {
        return self::TYPE_PATH;
    }

    /**
     * Set the model for the field body.
     * This method takes a string for an address.
     *
     * @param string $model
     *
     * @throws Swift_RfcComplianceException
     */
    public function setFieldBodyModel($model)
    {
        $this->setAddress($model);
    }

    /**
     * Get the model for the field body.
     * This method returns a string email address.
     *
     * @return mixed
     */
    public function getFieldBodyModel()
    {
        return $this->getAddress();
    }

    /**
     * Set the Address which should appear in this Header.
     *
     * @param string $address
     *
     * @throws Swift_RfcComplianceException
     */
    public function setAddress($address)
    {
        if (null === $address) {
            $this->_address = null;
        } elseif ('' === $address) {
            $this->_address = '';
        } else {
            $this->_assertValidAddress($address);
            $this->_address = $address;
        }

        $this->setCachedValue(null);
    }

    /**
     * Get the address which is used in this Header (if any).
     *
     * Null is returned if no address is set.
     *
     * @return string
     */
    public function getAddress()
    {
        return $this->_address;
    }

    /**
     * Get the string value of the body in this Header.
     *
     * This is not necessarily RFC 2822 compliant since folding white space will
     * not be added at this stage (see {@link toString()} for that).
     *
     * @see toString()
     *
     * @return string
     */
    public function getFieldBody()
    {
        if (!$this->getCachedValue()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            if (isset($this->_address)) {
                $this->setCachedValue('<' . $this->_address . '>');
            }
        }

        return $this->getCachedValue();
    }

    /**
     * Throws an Exception if the address passed does not comply with RFC 2822.
     *
     * @param string $address
     *
     * @throws Swift_RfcComplianceException If address is invalid
     */
    private function _assertValidAddress($address)
    {
        if ($this->_emailValidator->isValidWrapper($address) === false) {
            throw new Swift_RfcComplianceException('Address set in PathHeader does not comply with addr-spec of RFC 2822.');
        }
    }
}


1		<?php
2
3		/*
4		* This file is part of SwiftMailer.
5		* (c) 2004-2009 Chris Corbyn
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		/**
12		* A Path Header in Swift Mailer, such a Return-Path.
13		*
14		* @author Chris Corbyn
15		*/
16		class Swift_Mime_Headers_PathHeader extends Swift_Mime_Headers_AbstractHeader
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
17		{
18		/**
19		* The address in this Header (if specified).
20		*
21		* @var string
22		*/
23		private $_address;
24
25		/**
26		* The strict EmailValidator
27		*
28		* @var Swift_EmailValidatorBridge
29		*/
30		private $_emailValidator;
31
32		/**
33		* Creates a new PathHeader with the given $name.
34		*
35		* @param string $name
36		* @param Swift_EmailValidatorBridge $emailValidator
37		*/
38	11	public function __construct($name, $emailValidator)
39		{
40	11	$this->setFieldName($name);
41	11	$this->_emailValidator = $emailValidator;
42	11	parent::__construct();
43	11	}
44
45		/**
46		* Get the type of Header that this instance represents.
47		*
48		* @see TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
49		* @see TYPE_DATE, TYPE_ID, TYPE_PATH
50		*
51		* @return int
52		*/
53	1	public function getFieldType()
54		{
55	1	return self::TYPE_PATH;
56		}
57
58		/**
59		* Set the model for the field body.
60		* This method takes a string for an address.
61		*
62		* @param string $model
63		*
64		* @throws Swift_RfcComplianceException
65		*/
66	2	public function setFieldBodyModel($model)
67		{
68	2	$this->setAddress($model);
69	2	}
70
71		/**
72		* Get the model for the field body.
73		* This method returns a string email address.
74		*
75		* @return mixed
76		*/
77	2	public function getFieldBodyModel()
78		{
79	2	return $this->getAddress();
80		}
81
82		/**
83		* Set the Address which should appear in this Header.
84		*
85		* @param string $address
86		*
87		* @throws Swift_RfcComplianceException
88		*/
89	8	public function setAddress($address)
90		{
91	8	if (null === $address) {
92		$this->_address = null;
93	8	} elseif ('' === $address) {
94	1	$this->_address = '';
95		} else {
96	7	$this->_assertValidAddress($address);
97	6	$this->_address = $address;
98		}
99
100	7	$this->setCachedValue(null);
101	7	}
102
103		/**
104		* Get the address which is used in this Header (if any).
105		*
106		* Null is returned if no address is set.
107		*
108		* @return string
109		*/
110	4	public function getAddress()
111		{
112	4	return $this->_address;
113		}
114
115		/**
116		* Get the string value of the body in this Header.
117		*
118		* This is not necessarily RFC 2822 compliant since folding white space will
119		* not be added at this stage (see {@link toString()} for that).
120		*
121		* @see toString()
122		*
123		* @return string
124		*/
125	3	public function getFieldBody()
126		{
127	3	if (!$this->getCachedValue()) {
		0 ignored issues – show Bug Best Practice introduced 2016-05-28 10:25 UTC by Report Bug Copy Issue Report The expression `$this->getCachedValue()` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
128	3	if (isset($this->_address)) {
129	3	$this->setCachedValue('<' . $this->_address . '>');
130		}
131		}
132
133	3	return $this->getCachedValue();
134		}
135
136		/**
137		* Throws an Exception if the address passed does not comply with RFC 2822.
138		*
139		* @param string $address
140		*
141		* @throws Swift_RfcComplianceException If address is invalid
142		*/
143	7	private function _assertValidAddress($address)
144		{
145	7	if ($this->_emailValidator->isValidWrapper($address) === false) {
146	1	throw new Swift_RfcComplianceException('Address set in PathHeader does not comply with addr-spec of RFC 2822.');
147		}
148	6	}
149		}
150

voku / swiftmailer

Push — 5.x ( 801190...049872 )

Swift_Mime_Headers_PathHeader::getFieldBody() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like