Swift_MongoDbSpool::__construct() - Code Metrics - Inspection of "New 2.0.x; removing HHVM support; minimum PHP 7.0" - libreworks/swiftmailer-spools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 644335...699aed )

by Jonathan

created 2018-02-10 23:07 UTC

Swift_MongoDbSpool::__construct() A

↳ Parent: Swift_MongoDbSpool

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php
/**
 *
 * @copyright 2015 LibreWorks contributors
 * @license   http://opensource.org/licenses/MIT MIT License
 */

/**
 * A Swift spool that uses new MongoDB Drivers (http://docs.php.net/set.mongodb)
 *
 * @copyright 2015 LibreWorks contributors
 * @license   http://opensource.org/licenses/MIT MIT License
 */
class Swift_MongoDbSpool extends Swift_ConfigurableSpool
namespace YourVendor;

class YourClass { }
{
    /**
     * @var \MongoDB\Driver\Manager
     */
    private $manager;
    /**
     * @var string
     */
    private $collection;
    /**
     * @var \MongoDB\Driver\ReadPreference
     */
    private $rp;
    /**
     * @var MongoDB\Driver\WriteConcern
     */
    private $wc;

    private static $limit1 = array('limit' => 1);

    /**
     * Creates a new MongoDB spool.
     *
     * @param \MongoDB\Driver\Manager $manager The manager
     * @param string $collection The collection name (e.g. "mydb.emails")
     * @param \MongoDB\Driver\ReadPreference $rp Optional read preference
     * @param \MongoDB\Driver\WriteConcern $wc Optional write concern
     */
    public function __construct(\MongoDB\Driver\Manager $manager, $collection, \MongoDB\Driver\ReadPreference $rp = null, \MongoDB\Driver\WriteConcern $wc = null)
    {
        $this->manager = $manager;
        $this->collection = $this->checkBlank($collection);
        $this->rp = $rp;
        $this->wc = $wc;
    }

    private function checkBlank($value)
    {
        $value = trim($value);
        if (strlen($value) == 0) {
            throw new \InvalidArgumentException("This parameter cannot be blank");
        }
        return $value;
    }

    /**
     * Tests if this Spool mechanism has started.
     *
     * @return bool
     */
    public function isStarted()
    {
        return true;
    }

    /**
     * Starts this Spool mechanism.
     */
    public function start()
    {
    }

    /**
     * Stops this Spool mechanism.
     */
    public function stop()
    {
    }

    /**
     * Queues a message.
     *
     * @param Swift_Mime_SimpleMessage $message The message to store
     * @throws Swift_IoException
     * @return bool
     */
    public function queueMessage(Swift_Mime_SimpleMessage $message)
    {
        $bulk = new \MongoDB\Driver\BulkWrite();
        $bulk->insert(array(
            'message' => new \MongoDB\BSON\Binary(serialize($message), \MongoDB\BSON\Binary::TYPE_GENERIC)
        ));
        $this->write($bulk);
        return true;
    }

    /**
     * Execute a recovery if for any reason a process is sending for too long.
     *
     * @param int $timeout in second Defaults is for very slow smtp responses
     * @throws Swift_IoException
     */
    public function recover($timeout = 900)
    {
        $bulk = new \MongoDB\Driver\BulkWrite();
        $bulk->update(
            array('sentOn' => array('$lte' => $this->now(0 - ($timeout * 1000)))),
            array('$set' => array('sentOn' => null)),
            array('multi' => true)
        );
        $this->write($bulk);
    }

    /**
     * Sends messages using the given transport instance.
     *
     * @param Swift_Transport $transport        A transport instance
     * @param string[]        $failedRecipients An array of failures by-reference
     * @throws Swift_IoException
     * @return int The number of sent e-mails
     */
    public function flushQueue(Swift_Transport $transport, &$failedRecipients = null)
    {
        if (!$transport->isStarted()) {
            $transport->start();
        }
        $limit = $this->getMessageLimit();
        $results = $this->find(array('sentOn' => null), $limit > 0 ? array('limit' => $limit) : array());
        $failedRecipients = (array) $failedRecipients;
        $count = 0;
        $time = time();
        $timeLimit = $this->getTimeLimit();
        foreach ($results as $result) {
            if (!isset($result->message) || !($result->message instanceof \MongoDB\BSON\Binary)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                continue;
            }
            $id = $result->_id;
            $this->setSentOn($id, $this->now());
            $count += $transport->send(unserialize($result->message->getData()), $failedRecipients);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $this->delete($id);
            if ($timeLimit && (time() - $time) >= $timeLimit) {
                break;
            }
        }
        return $count;
    }

    /**
     * Performs a query.
     *
     * @param array $query The query to perform
     * @param array $options Optional array of query options
     * @return \MongoDB\Driver\Cursor The results cursor
     * @throws Swift_IoException
     */
    protected function find(array $query, array $options = array())
    {
        try {
            $q = new \MongoDB\Driver\Query($query, $options);
            return $this->manager->executeQuery($this->collection, $q, $this->rp);
        } catch (\Exception $e) {
            throw new Swift_IoException("Could not query for emails", 0, $e);
        }
    }

    /**
     * Deletes a single record.
     *
     * @param \MongoDB\BSON\ObjectID $id The ID of the message to delete
     * @throws Swift_IoException
     */
    protected function delete(\MongoDB\BSON\ObjectID $id)
    {
        $bulk = new MongoDB\Driver\BulkWrite();
        $bulk->delete(array('_id' => $id), self::$limit1);
        $this->write($bulk);
    }

    /**
     * Sets a single record's sentOn field.
     *
     * @param \MongoDB\BSON\ObjectID $id The ID of the message to update
     * @param \MongoDB\BSON\UTCDateTime $time The time (or null) to set
     * @return \MongoDB\Driver\WriteResult the write result
     * @throws Swift_IoException
     */
    protected function setSentOn(\MongoDB\BSON\ObjectID $id, \MongoDB\BSON\UTCDateTime $time = null)
    {
        $bulk = new \MongoDB\Driver\BulkWrite();
        $bulk->update(array('_id' => $id), array('$set' => array('sentOn' => $time)));
        $this->write($bulk);
    }

    /**
     * Executes a bulk write to MongoDB, wrapping exceptions.
     *
     * @param \MongoDB\Driver\BulkWrite $bulk
     * @return \MongoDB\Driver\WriteResult the write result
     * @throws Swift_IoException if things go wrong
     */
    protected function write(\MongoDB\Driver\BulkWrite $bulk)
    {
        try {
            return $this->manager->executeBulkWrite($this->collection, $bulk, $this->wc);
        } catch (\Exception $e) {
            throw new Swift_IoException("Could not update email sent on date", 0, $e);
        }
    }

    /**
     * Gets the current date.
     *
     * @param int $offset Milliseconds offset
     * @return \MongoDB\BSON\UTCDateTime the current date
     */
    protected function now($offset = 0)
    {
        return new \MongoDB\BSON\UTCDateTime(microtime(true) * 1000 + $offset);
    }
}


GitHub Access Token became invalid

Push — master ( 644335...699aed )

Swift_MongoDbSpool::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1		<?php
2		/**
3		*
4		* @copyright 2015 LibreWorks contributors
5		* @license http://opensource.org/licenses/MIT MIT License
6		*/
7
8		/**
9		* A Swift spool that uses new MongoDB Drivers (http://docs.php.net/set.mongodb)
10		*
11		* @copyright 2015 LibreWorks contributors
12		* @license http://opensource.org/licenses/MIT MIT License
13		*/
14		class Swift_MongoDbSpool extends Swift_ConfigurableSpool
		0 ignored issues – show Coding Style Compatibility introduced 2016-02-11 02:49 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... Coding Style introduced 2016-02-11 02:49 UTC by Report Bug Copy Issue Report This class is not in CamelCase format. Classes in PHP are usually named in CamelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. The whole name starts with a capital letter as well. Thus the name database provider becomes `DatabaseProvider`. Loading history...
15		{
16		/**
17		* @var \MongoDB\Driver\Manager
18		*/
19		private $manager;
20		/**
21		* @var string
22		*/
23		private $collection;
24		/**
25		* @var \MongoDB\Driver\ReadPreference
26		*/
27		private $rp;
28		/**
29		* @var MongoDB\Driver\WriteConcern
30		*/
31		private $wc;
32
33		private static $limit1 = array('limit' => 1);
34
35		/**
36		* Creates a new MongoDB spool.
37		*
38		* @param \MongoDB\Driver\Manager $manager The manager
39		* @param string $collection The collection name (e.g. "mydb.emails")
40		* @param \MongoDB\Driver\ReadPreference $rp Optional read preference
41		* @param \MongoDB\Driver\WriteConcern $wc Optional write concern
42		*/
43	2	public function __construct(\MongoDB\Driver\Manager $manager, $collection, \MongoDB\Driver\ReadPreference $rp = null, \MongoDB\Driver\WriteConcern $wc = null)
44		{
45	2	$this->manager = $manager;
46	2	$this->collection = $this->checkBlank($collection);
47	1	$this->rp = $rp;
48	1	$this->wc = $wc;
49	1	}
50
51	1	private function checkBlank($value)
52		{
53	1	$value = trim($value);
54	1	if (strlen($value) == 0) {
55	1	throw new \InvalidArgumentException("This parameter cannot be blank");
56		}
57		return $value;
58		}
59
60		/**
61		* Tests if this Spool mechanism has started.
62		*
63		* @return bool
64		*/
65	1	public function isStarted()
66		{
67	1	return true;
68		}
69
70		/**
71		* Starts this Spool mechanism.
72		*/
73		public function start()
74		{
75		}
76
77		/**
78		* Stops this Spool mechanism.
79		*/
80		public function stop()
81		{
82		}
83
84		/**
85		* Queues a message.
86		*
87		* @param Swift_Mime_SimpleMessage $message The message to store
88		* @throws Swift_IoException
89		* @return bool
90		*/
91	1	public function queueMessage(Swift_Mime_SimpleMessage $message)
92		{
93	1	$bulk = new \MongoDB\Driver\BulkWrite();
94	1	$bulk->insert(array(
95	1	'message' => new \MongoDB\BSON\Binary(serialize($message), \MongoDB\BSON\Binary::TYPE_GENERIC)
96		));
97	1	$this->write($bulk);
98	1	return true;
99		}
100
101		/**
102		* Execute a recovery if for any reason a process is sending for too long.
103		*
104		* @param int $timeout in second Defaults is for very slow smtp responses
105		* @throws Swift_IoException
106		*/
107	1	public function recover($timeout = 900)
108		{
109	1	$bulk = new \MongoDB\Driver\BulkWrite();
110	1	$bulk->update(
111	1	array('sentOn' => array('$lte' => $this->now(0 - ($timeout * 1000)))),
112	1	array('$set' => array('sentOn' => null)),
113	1	array('multi' => true)
114		);
115	1	$this->write($bulk);
116	1	}
117
118		/**
119		* Sends messages using the given transport instance.
120		*
121		* @param Swift_Transport $transport A transport instance
122		* @param string[] $failedRecipients An array of failures by-reference
123		* @throws Swift_IoException
124		* @return int The number of sent e-mails
125		*/
126	1	public function flushQueue(Swift_Transport $transport, &$failedRecipients = null)
127		{
128	1	if (!$transport->isStarted()) {
129		$transport->start();
130		}
131	1	$limit = $this->getMessageLimit();
132	1	$results = $this->find(array('sentOn' => null), $limit > 0 ? array('limit' => $limit) : array());
133	1	$failedRecipients = (array) $failedRecipients;
134	1	$count = 0;
135	1	$time = time();
136	1	$timeLimit = $this->getTimeLimit();
137	1	foreach ($results as $result) {
138	1	if (!isset($result->message) \|\| !($result->message instanceof \MongoDB\BSON\Binary)) {
		0 ignored issues – show Bug introduced 2016-02-11 02:49 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\Binary` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
139	1	continue;
140		}
141	1	$id = $result->_id;
142	1	$this->setSentOn($id, $this->now());
143	1	$count += $transport->send(unserialize($result->message->getData()), $failedRecipients);
		0 ignored issues – show Bug introduced 2016-02-11 02:49 UTC by Report Bug Copy Issue Report It seems like `$failedRecipients` defined by `(array) $failedRecipients` on line `133` can also be of type `array`; however, `Swift_Transport::send()` does only seem to accept `array<integer,string>\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
144	1	$this->delete($id);
145	1	if ($timeLimit && (time() - $time) >= $timeLimit) {
146	1	break;
147		}
148		}
149	1	return $count;
150		}
151
152		/**
153		* Performs a query.
154		*
155		* @param array $query The query to perform
156		* @param array $options Optional array of query options
157		* @return \MongoDB\Driver\Cursor The results cursor
158		* @throws Swift_IoException
159		*/
160	1	protected function find(array $query, array $options = array())
161		{
162		try {
163	1	$q = new \MongoDB\Driver\Query($query, $options);
164	1	return $this->manager->executeQuery($this->collection, $q, $this->rp);
165		} catch (\Exception $e) {
166		throw new Swift_IoException("Could not query for emails", 0, $e);
167		}
168		}
169
170		/**
171		* Deletes a single record.
172		*
173		* @param \MongoDB\BSON\ObjectID $id The ID of the message to delete
174		* @throws Swift_IoException
175		*/
176	1	protected function delete(\MongoDB\BSON\ObjectID $id)
177		{
178	1	$bulk = new MongoDB\Driver\BulkWrite();
179	1	$bulk->delete(array('_id' => $id), self::$limit1);
180	1	$this->write($bulk);
181	1	}
182
183		/**
184		* Sets a single record's sentOn field.
185		*
186		* @param \MongoDB\BSON\ObjectID $id The ID of the message to update
187		* @param \MongoDB\BSON\UTCDateTime $time The time (or null) to set
188		* @return \MongoDB\Driver\WriteResult the write result
189		* @throws Swift_IoException
190		*/
191	1	protected function setSentOn(\MongoDB\BSON\ObjectID $id, \MongoDB\BSON\UTCDateTime $time = null)
192		{
193	1	$bulk = new \MongoDB\Driver\BulkWrite();
194	1	$bulk->update(array('_id' => $id), array('$set' => array('sentOn' => $time)));
195	1	$this->write($bulk);
196	1	}
197
198		/**
199		* Executes a bulk write to MongoDB, wrapping exceptions.
200		*
201		* @param \MongoDB\Driver\BulkWrite $bulk
202		* @return \MongoDB\Driver\WriteResult the write result
203		* @throws Swift_IoException if things go wrong
204		*/
205	3	protected function write(\MongoDB\Driver\BulkWrite $bulk)
206		{
207		try {
208	3	return $this->manager->executeBulkWrite($this->collection, $bulk, $this->wc);
209		} catch (\Exception $e) {
210		throw new Swift_IoException("Could not update email sent on date", 0, $e);
211		}
212		}
213
214		/**
215		* Gets the current date.
216		*
217		* @param int $offset Milliseconds offset
218		* @return \MongoDB\BSON\UTCDateTime the current date
219		*/
220	1	protected function now($offset = 0)
221		{
222	1	return new \MongoDB\BSON\UTCDateTime(microtime(true) * 1000 + $offset);
223		}
224		}
225

libreworks / swiftmailer-spools

GitHub Access Token became invalid

Push — master ( 644335...699aed )

Swift_MongoDbSpool::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like