DoctrineAdapter - Code Metrics - Inspection of "[Doctrine] Added retry and forget commands" - heristop/HeriJobQueueBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (b61033)

by Alexandre

created 2016-07-06 15:00 UTC

DoctrineAdapter B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	509
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	30
Bugs	4	Features	11

Metric	Value
wmc	40
c	30
b	4
f	11
lcom	1
cbo	6
dl	0
loc	509
rs	8.2608

18 Methods

Rating	Name	Size	Complexity
A	isExists()	10	2
A	create()	16	3
B	delete()	24	2
A	getQueues()	13	2
A	count()	20	2
B	send()	31	5
B	receive()	40	4
A	deleteMessage()	13	1
A	getCapabilities()	13	1
A	retry()	16	2
A	forget()	8	1
A	setPriority()	4	1
A	showMessages()	19	2
A	flush()	6	1
B	logException()	29	2
B	createMessage()	25	2
B	getMessages()	34	5
A	getQueueEntity()	14	2

How to fix Complexity

<?php

/**
 * This file is part of HeriJobQueueBundle.
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Heri\Bundle\JobQueueBundle\Adapter;

use ZendQueue\Adapter\AbstractAdapter;
use ZendQueue\Message;
use ZendQueue\Queue;
use Heri\Bundle\JobQueueBundle\Exception\AdapterRuntimeException;

/**
 * Doctrine adapter.
 *
 * @see ZendQueue\Adapter\AbstractAdapter
 */
class DoctrineAdapter extends AbstractAdapter implements AdapterInterface
{
    /**
     * @var Doctrine\ORM\EntityManager.
     */
    public $em;

    /**
     * @var int.
     */
    public $priority = 0;

    /**
     * Does a queue already exist?
     *
     * Throws an exception if the adapter cannot determine if a queue exists.
     * use isSupported('isExists') to determine if an adapter can test for
     * queue existance.
     *
     * @param string $name
     *
     * @return bool
     *
     * @throws ZendQueue\Exception
     */
    public function isExists($name)
    {
        $repo = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
            ->findOneBy([
                'name' => $name,
            ]);

        return ($repo) ? true : false;
    }

    /**
     * Create a new queue.
     *
     * Visibility timeout is how long a message is left in the queue "invisible"
     * to other readers.  If the message is acknowleged (deleted) before the
     * timeout, then the message is deleted.  However, if the timeout expires
     * then the message will be made available to other queue readers.
     *
     * @param string $name    Queue name
     * @param int    $timeout Default visibility timeout
     *
     * @return bool
     *
     * @throws ZendQueue\Exception - database error
     */
    public function create($name, $timeout = null)
    {
        if ($this->isExists($name)) {
            return false;
        }

        $queue = new \Heri\Bundle\JobQueueBundle\Entity\Queue();
        $queue->setName($name);
        $newtimeout = (is_null($timeout)) ? self::CREATE_TIMEOUT_DEFAULT : (int) $timeout;
        $queue->setTimeout($newtimeout);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->em->persist($queue);
        $this->em->flush();

        return true;
    }

    /**
     * Delete a queue and all of it's messages.
     *
     * Returns false if the queue is not found, true if the queue exists
     *
     * @param string $name Queue name
     *
     * @return bool
     *
     * @throws ZendQueue\Exception
     */
    public function delete($name)
    {
        // Get primary key
        $id = $this->getQueueEntity($name);

        $queue = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
            ->find($id);

        $messages = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
            ->findBy([
                'queue' => $queue,
            ]);
        foreach ($messages as $message) {
            $this->em->remove($message);
        }

        $this->em->remove($queue);
        $this->em->flush();
        $this->em->clear();

        return true;
    }

    /*
     * Get an array of all available queues
     *
     * Not all adapters support getQueues(), use isSupported('getQueues')
     * to determine if the adapter supports this feature.
     *
     * @return array
     */
    public function getQueues()
    {
        $list = [];

        $queues = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
            ->findAll();
        foreach ($queues as $queue) {
            $list[] = $queue->name;
        }

        return $list;
    }

    /**
     * Return the approximate number of messages in the queue.
     *
     * @param ZendQueue\Queue $queue
     *
     * @return int
     *
     * @throws ZendQueue\Exception
     */
    public function count(Queue $queue = null)
    {
        $qb = $this->em->createQueryBuilder();
        $qb
            ->select('count(m)')
            ->from('Heri\Bundle\JobQueueBundle\Entity\Message', 'm')
            ->leftJoin('m.queue', 'Queue')
        ;

        if ($queue instanceof Queue) {
            $qb
                ->where($qb->expr()->eq('Queue.name', ':name'))
                ->setParameter('name', $queue->getName())
            ;
        }

        $query = $qb->getQuery();

        return $query->getSingleScalarResult();
    }

    /**
     * Send a message to the queue.
     *
     * @param string          $message Message to send to the active queue
     * @param ZendQueue\Queue $queue
     *
     * @return ZendQueue\Message
     *
     * @throws ZendQueue\Exception
     */
    public function send($message, Queue $queue = null)
    {
        $body = '';

        if ($queue === null) {
            $queue = $this->_queue;
        }

        if (is_scalar($message)) {
            $body = (string) $message;
        }

        if (is_string($message)) {
            $body = trim($message);
        }

        if (!$this->isExists($queue->getName())) {
            throw new AdapterRuntimeException("Queue does not exist: {$queue->getName()}");
        }

        $entity = $this->createMessage($queue, $body);

        $options = [
            'queue' => $queue,
            'data' => $entity->toArray(),
        ];

        $classname = $queue->getMessageClass();

        return new $classname($options);
    }

    /**
     * Get messages in the queue.
     *
     * @param int             $maxMessages Maximum number of messages to return
     * @param int             $timeout     Visibility timeout for these messages
     * @param ZendQueue\Queue $queue
     *
     * @return ZendQueue\MessageIterator
     *
     * @throws ZendQueue\Exception Database error
     */
    public function receive($maxMessages = null, $timeout = null, Queue $queue = null)
    {
        $result = [];

        // Cache microtime
        $microtime = microtime(true);

        if (is_null($queue)) {
            $queue = $this->_queue;
        }

        if ($maxMessages > 0) {
            $messages = $this->getMessages(
                $maxMessages,
                $timeout,
                $queue,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $microtime
            );

            // Update working messages
            foreach ($messages as $message) {
                $key = md5(uniqid(rand(), true));
                $message->setHandle($key);
                $message->setTimeout($microtime);

                $result[] = $message->toArray();
            }
            $this->em->flush();
        }

        $options = [
            'queue' => $queue,
            'data' => $result,
            'messageClass' => $queue->getMessageClass(),
        ];

        $classname = $queue->getMessageSetClass();

        return new $classname($options);
    }

    /**
     * Delete a message from the queue.
     *
     * Returns true if the message is deleted, false if the deletion is
     * unsuccessful.
     *
     * @param ZendQueue\Message $message
     *
     * @return bool
     *
     * @throws ZendQueue\Exception - database error
     */
    public function deleteMessage(Message $message)
    {
        $repo = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
            ->findOneBy([
                'handle' => $message->handle,
            ]);

        $this->em->remove($repo);
        $this->em->flush();

        return $this->em->clear();
    }

    /**
     * Return a list of queue capabilities functions.
     *
     * $array['function name'] = true or false
     * true is supported, false is not supported.
     *
     * @param string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return array
     */
    public function getCapabilities()
    {
        return [
            'create' => true,
            'delete' => true,
            'send' => true,
            'receive' => true,
            'deleteMessage' => true,
            'getQueues' => true,
            'count' => true,
            'isExists' => true,
        ];
    }

    /**
     * Retry failed messages.
     *
     * @param int $id
     */
    public function retry($id = null)
    {
        $sql = <<<EOL
            UPDATE Heri\Bundle\JobQueueBundle\Entity\Message m
            SET m.numRetries = 0
EOL;

        $query = $this->em->createQuery($sql);
        if (!is_null($id)) {
            $sql .= ' WHERE m.id = ?1';

            $query->setParameter(1, $id);
        }

        $query->execute();
    }

    /**
     * Delete a failed message.
     *
     * @param int $id
     */
    public function forget($id)
    {
        $sql = <<<EOL
        DELETE FROM Heri\Bundle\JobQueueBundle\Entity\Message m WHERE m.id = ?1
EOL;

        return $this->em->createQuery($sql)->setParameter(1, $id)->execute();
    }

    /**
     * {@inheritdoc}
     */
    public function setPriority($priority)
    {
        $this->priority = $priority;
    }

    /**
     * {@inheritdoc}
     */
    public function showMessages($queueName)
    {
        $results = [];
        if ($this->isExists($queueName)) {
            $qb = $this->em->createQueryBuilder();
            $qb
                ->select('m.id, m.body, m.created, m.ended, m.failed')
                ->from('Heri\Bundle\JobQueueBundle\Entity\Message', 'm')
                ->leftJoin('m.queue', 'Queue')
                ->where($qb->expr()->eq('Queue.name', ':name'))
                ->setParameter('name', $queueName)
            ;

            $query = $qb->getQuery();
            $results = $query->getResult(\Doctrine\ORM\Query::HYDRATE_ARRAY);
        }

        return $results;
    }

    /**
     * {@inheritdoc}
     */
    public function flush()
    {
        $sql = 'DELETE Heri\Bundle\JobQueueBundle\Entity\MessageLog';

        return $this->em->createQuery($sql);
    }

    /**
     * {@inheritdoc}
     */
    public function logException($message, $e)
    {
        $sql = <<<EOL
            UPDATE Heri\Bundle\JobQueueBundle\Entity\Message m
            SET
                m.ended = 0,
                m.failed = 1,
                m.numRetries = m.numRetries + ?1,
                m.priority = 0
            WHERE m.id = ?2
EOL;

        $this->em->createQuery($sql)
            ->setParameter(1, $message->failed ? 1 : 0)
            ->setParameter(2, $message->id)
            ->execute()
        ;

        $messageObject = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
            ->find($message->id);

        $log = new \Heri\Bundle\JobQueueBundle\Entity\MessageLog();
        $log->setMessageId($messageObject);
        $log->setDateLog(new \DateTime('now'));
        $log->setLog($e->getMessage());
        $this->em->persist($log);
        $this->em->flush();
    }

    /**
     * Create a new message.
     *
     * @param ZendQueue\Queue $queue
     * @param string          $body
     */
    protected function createMessage(Queue $queue, $body)
    {
        // check if message exist
        $message = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
            ->findOneBy([
                'md5' => md5($body),
            ]);

        if (!$message) {
            $message = new \Heri\Bundle\JobQueueBundle\Entity\Message();
            $message->setQueue($this->getQueueEntity($queue->getName()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $message->setBody($body);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $message->setMd5(md5($body));
            $message->setPriority($this->priority);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $message->setFailed(false);
            $message->setEnded(false);

            $this->em->persist($message);
            $this->em->flush();
            $this->em->clear();
        }

        return $message;
    }

    /**
     * Get messages of the queue.
     *
     * @param int             $maxMessages
     * @param int             $timeout
     * @param ZendQueue\Queue $queue
     * @param int             $microtime
     */
    protected function getMessages($maxMessages, $timeout, $queue = null, $microtime = null)
    {
        if ($maxMessages === null) {
            $maxMessages = 1;
        }

        if ($timeout === null) {
            $timeout = self::RECEIVE_TIMEOUT_DEFAULT;
        }

        $andWhere = '';
        if ($queue instanceof Queue) {
            $andWhere = 'AND (m.queue = :queue) AND (q.maxRetries IS NULL OR m.numRetries < q.maxRetries)';
        }

        // Search for all messages inside the timeout
        $sql = 'SELECT m '.
            'FROM Heri\Bundle\JobQueueBundle\Entity\Message m '.
            'LEFT JOIN m.queue q '.
            'WHERE (m.handle IS NULL OR m.handle = \'\' OR m.timeout + :timeout < :microtime) '.$andWhere.' '.
            'ORDER BY m.priority DESC';

        $query = $this->em->createQuery($sql);

        $query->setParameter('timeout', (int) $timeout);
        $query->setParameter('microtime', (int) $microtime);

        if ($queue instanceof Queue) {
            $query->setParameter('queue', $this->getQueueEntity($queue->getName()));
        }
        $query->setMaxResults($maxMessages);

        return $query->getResult();
    }

    /**
     * Get the queue entity.
     *
     * @param string $name
     *
     * @return Queue Entity
     *
     * @throws ZendQueue\Exception
     */
    protected function getQueueEntity($name)
    {
        $repo = $this->em
            ->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
            ->findOneBy([
                'name' => $name,
            ]);

        if (!$repo) {
            throw new AdapterRuntimeException(sprintf('Queue does not exist: %s', $name));
        }

        return $repo;
    }
}


1			<?php
2
3			/**
4			* This file is part of HeriJobQueueBundle.
5			*
6			* This source file is subject to the MIT license that is bundled
7			* with this source code in the file LICENSE.
8			*/
9
10			namespace Heri\Bundle\JobQueueBundle\Adapter;
11
12			use ZendQueue\Adapter\AbstractAdapter;
13			use ZendQueue\Message;
14			use ZendQueue\Queue;
15			use Heri\Bundle\JobQueueBundle\Exception\AdapterRuntimeException;
16
17			/**
18			* Doctrine adapter.
19			*
20			* @see ZendQueue\Adapter\AbstractAdapter
21			*/
22			class DoctrineAdapter extends AbstractAdapter implements AdapterInterface
23			{
24			/**
25			* @var Doctrine\ORM\EntityManager.
26			*/
27			public $em;
28
29			/**
30			* @var int.
31			*/
32			public $priority = 0;
33
34			/**
35			* Does a queue already exist?
36			*
37			* Throws an exception if the adapter cannot determine if a queue exists.
38			* use isSupported('isExists') to determine if an adapter can test for
39			* queue existance.
40			*
41			* @param string $name
42			*
43			* @return bool
44			*
45			* @throws ZendQueue\Exception
46			*/
47			public function isExists($name)
48			{
49			$repo = $this->em
50			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
51			->findOneBy([
52			'name' => $name,
53			]);
54
55			return ($repo) ? true : false;
56			}
57
58			/**
59			* Create a new queue.
60			*
61			* Visibility timeout is how long a message is left in the queue "invisible"
62			* to other readers. If the message is acknowleged (deleted) before the
63			* timeout, then the message is deleted. However, if the timeout expires
64			* then the message will be made available to other queue readers.
65			*
66			* @param string $name Queue name
67			* @param int $timeout Default visibility timeout
68			*
69			* @return bool
70			*
71			* @throws ZendQueue\Exception - database error
72			*/
73			public function create($name, $timeout = null)
74			{
75			if ($this->isExists($name)) {
76			return false;
77			}
78
79			$queue = new \Heri\Bundle\JobQueueBundle\Entity\Queue();
80			$queue->setName($name);
81			$newtimeout = (is_null($timeout)) ? self::CREATE_TIMEOUT_DEFAULT : (int) $timeout;
82			$queue->setTimeout($newtimeout);
			0 ignored issues – show Documentation introduced 2016-02-19 18:03 UTC by Report Bug Copy Issue Report `$newtimeout` is of type `integer`, but the function expects a `object<Heri\Bundle\JobQu...Bundle\Entity\smallint>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
83
84			$this->em->persist($queue);
85			$this->em->flush();
86
87			return true;
88			}
89
90			/**
91			* Delete a queue and all of it's messages.
92			*
93			* Returns false if the queue is not found, true if the queue exists
94			*
95			* @param string $name Queue name
96			*
97			* @return bool
98			*
99			* @throws ZendQueue\Exception
100			*/
101			public function delete($name)
102			{
103			// Get primary key
104			$id = $this->getQueueEntity($name);
105
106			$queue = $this->em
107			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
108			->find($id);
109
110			$messages = $this->em
111			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
112			->findBy([
113			'queue' => $queue,
114			]);
115			foreach ($messages as $message) {
116			$this->em->remove($message);
117			}
118
119			$this->em->remove($queue);
120			$this->em->flush();
121			$this->em->clear();
122
123			return true;
124			}
125
126			/*
127			* Get an array of all available queues
128			*
129			* Not all adapters support getQueues(), use isSupported('getQueues')
130			* to determine if the adapter supports this feature.
131			*
132			* @return array
133			*/
134			public function getQueues()
135			{
136			$list = [];
137
138			$queues = $this->em
139			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
140			->findAll();
141			foreach ($queues as $queue) {
142			$list[] = $queue->name;
143			}
144
145			return $list;
146			}
147
148			/**
149			* Return the approximate number of messages in the queue.
150			*
151			* @param ZendQueue\Queue $queue
152			*
153			* @return int
154			*
155			* @throws ZendQueue\Exception
156			*/
157			public function count(Queue $queue = null)
158			{
159			$qb = $this->em->createQueryBuilder();
160			$qb
161			->select('count(m)')
162			->from('Heri\Bundle\JobQueueBundle\Entity\Message', 'm')
163			->leftJoin('m.queue', 'Queue')
164			;
165
166			if ($queue instanceof Queue) {
167			$qb
168			->where($qb->expr()->eq('Queue.name', ':name'))
169			->setParameter('name', $queue->getName())
170			;
171			}
172
173			$query = $qb->getQuery();
174
175			return $query->getSingleScalarResult();
176			}
177
178			/**
179			* Send a message to the queue.
180			*
181			* @param string $message Message to send to the active queue
182			* @param ZendQueue\Queue $queue
183			*
184			* @return ZendQueue\Message
185			*
186			* @throws ZendQueue\Exception
187			*/
188			public function send($message, Queue $queue = null)
189			{
190			$body = '';
191
192			if ($queue === null) {
193			$queue = $this->_queue;
194			}
195
196			if (is_scalar($message)) {
197			$body = (string) $message;
198			}
199
200			if (is_string($message)) {
201			$body = trim($message);
202			}
203
204			if (!$this->isExists($queue->getName())) {
205			throw new AdapterRuntimeException("Queue does not exist: {$queue->getName()}");
206			}
207
208			$entity = $this->createMessage($queue, $body);
209
210			$options = [
211			'queue' => $queue,
212			'data' => $entity->toArray(),
213			];
214
215			$classname = $queue->getMessageClass();
216
217			return new $classname($options);
218			}
219
220			/**
221			* Get messages in the queue.
222			*
223			* @param int $maxMessages Maximum number of messages to return
224			* @param int $timeout Visibility timeout for these messages
225			* @param ZendQueue\Queue $queue
226			*
227			* @return ZendQueue\MessageIterator
228			*
229			* @throws ZendQueue\Exception Database error
230			*/
231			public function receive($maxMessages = null, $timeout = null, Queue $queue = null)
232			{
233			$result = [];
234
235			// Cache microtime
236			$microtime = microtime(true);
237
238			if (is_null($queue)) {
239			$queue = $this->_queue;
240			}
241
242			if ($maxMessages > 0) {
243			$messages = $this->getMessages(
244			$maxMessages,
245			$timeout,
246			$queue,
			0 ignored issues – show Documentation introduced 2016-02-19 18:03 UTC by Report Bug Copy Issue Report `$queue` is of type `object<ZendQueue\Queue>`, but the function expects a `object<Heri\Bundle\JobQu...r\ZendQueue\Queue>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
247			$microtime
248			);
249
250			// Update working messages
251			foreach ($messages as $message) {
252			$key = md5(uniqid(rand(), true));
253			$message->setHandle($key);
254			$message->setTimeout($microtime);
255
256			$result[] = $message->toArray();
257			}
258			$this->em->flush();
259			}
260
261			$options = [
262			'queue' => $queue,
263			'data' => $result,
264			'messageClass' => $queue->getMessageClass(),
265			];
266
267			$classname = $queue->getMessageSetClass();
268
269			return new $classname($options);
270			}
271
272			/**
273			* Delete a message from the queue.
274			*
275			* Returns true if the message is deleted, false if the deletion is
276			* unsuccessful.
277			*
278			* @param ZendQueue\Message $message
279			*
280			* @return bool
281			*
282			* @throws ZendQueue\Exception - database error
283			*/
284			public function deleteMessage(Message $message)
285			{
286			$repo = $this->em
287			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
288			->findOneBy([
289			'handle' => $message->handle,
290			]);
291
292			$this->em->remove($repo);
293			$this->em->flush();
294
295			return $this->em->clear();
296			}
297
298			/**
299			* Return a list of queue capabilities functions.
300			*
301			* $array['function name'] = true or false
302			* true is supported, false is not supported.
303			*
304			* @param string $name
			0 ignored issues – show Bug introduced 2016-02-19 18:03 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
305			*
306			* @return array
307			*/
308			public function getCapabilities()
309			{
310			return [
311			'create' => true,
312			'delete' => true,
313			'send' => true,
314			'receive' => true,
315			'deleteMessage' => true,
316			'getQueues' => true,
317			'count' => true,
318			'isExists' => true,
319			];
320			}
321
322			/**
323			* Retry failed messages.
324			*
325			* @param int $id
326			*/
327			public function retry($id = null)
328			{
329			$sql = <<<EOL
330			UPDATE Heri\Bundle\JobQueueBundle\Entity\Message m
331			SET m.numRetries = 0
332			EOL;
333
334			$query = $this->em->createQuery($sql);
335			if (!is_null($id)) {
336			$sql .= ' WHERE m.id = ?1';
337
338			$query->setParameter(1, $id);
339			}
340
341			$query->execute();
342			}
343
344			/**
345			* Delete a failed message.
346			*
347			* @param int $id
348			*/
349			public function forget($id)
350			{
351			$sql = <<<EOL
352			DELETE FROM Heri\Bundle\JobQueueBundle\Entity\Message m WHERE m.id = ?1
353			EOL;
354
355			return $this->em->createQuery($sql)->setParameter(1, $id)->execute();
356			}
357
358			/**
359			* {@inheritdoc}
360			*/
361			public function setPriority($priority)
362			{
363			$this->priority = $priority;
364			}
365
366			/**
367			* {@inheritdoc}
368			*/
369			public function showMessages($queueName)
370			{
371			$results = [];
372			if ($this->isExists($queueName)) {
373			$qb = $this->em->createQueryBuilder();
374			$qb
375			->select('m.id, m.body, m.created, m.ended, m.failed')
376			->from('Heri\Bundle\JobQueueBundle\Entity\Message', 'm')
377			->leftJoin('m.queue', 'Queue')
378			->where($qb->expr()->eq('Queue.name', ':name'))
379			->setParameter('name', $queueName)
380			;
381
382			$query = $qb->getQuery();
383			$results = $query->getResult(\Doctrine\ORM\Query::HYDRATE_ARRAY);
384			}
385
386			return $results;
387			}
388
389			/**
390			* {@inheritdoc}
391			*/
392			public function flush()
393			{
394			$sql = 'DELETE Heri\Bundle\JobQueueBundle\Entity\MessageLog';
395
396			return $this->em->createQuery($sql);
397			}
398
399			/**
400			* {@inheritdoc}
401			*/
402			public function logException($message, $e)
403			{
404			$sql = <<<EOL
405			UPDATE Heri\Bundle\JobQueueBundle\Entity\Message m
406			SET
407			m.ended = 0,
408			m.failed = 1,
409			m.numRetries = m.numRetries + ?1,
410			m.priority = 0
411			WHERE m.id = ?2
412			EOL;
413
414			$this->em->createQuery($sql)
415			->setParameter(1, $message->failed ? 1 : 0)
416			->setParameter(2, $message->id)
417			->execute()
418			;
419
420			$messageObject = $this->em
421			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
422			->find($message->id);
423
424			$log = new \Heri\Bundle\JobQueueBundle\Entity\MessageLog();
425			$log->setMessageId($messageObject);
426			$log->setDateLog(new \DateTime('now'));
427			$log->setLog($e->getMessage());
428			$this->em->persist($log);
429			$this->em->flush();
430			}
431
432			/**
433			* Create a new message.
434			*
435			* @param ZendQueue\Queue $queue
436			* @param string $body
437			*/
438			protected function createMessage(Queue $queue, $body)
439			{
440			// check if message exist
441			$message = $this->em
442			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Message')
443			->findOneBy([
444			'md5' => md5($body),
445			]);
446
447			if (!$message) {
448			$message = new \Heri\Bundle\JobQueueBundle\Entity\Message();
449			$message->setQueue($this->getQueueEntity($queue->getName()));
			0 ignored issues – show Documentation introduced 2016-02-19 18:03 UTC by Report Bug Copy Issue Report `$this->getQueueEntity($queue->getName())` is of type `object<ZendQueue\Queue>`, but the function expects a `null\|object<Heri\Bundle\...eueBundle\Entity\Queue>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
450			$message->setBody($body);
			0 ignored issues – show Documentation introduced 2016-02-19 18:03 UTC by Report Bug Copy Issue Report `$body` is of type `string`, but the function expects a `object<Heri\Bundle\JobQueueBundle\Entity\text>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
451			$message->setMd5(md5($body));
452			$message->setPriority($this->priority);
			0 ignored issues – show Documentation introduced 2016-02-19 18:03 UTC by Report Bug Copy Issue Report `$this->priority` is of type `integer`, but the function expects a `object<Heri\Bundle\JobQu...Bundle\Entity\smallint>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
453			$message->setFailed(false);
454			$message->setEnded(false);
455
456			$this->em->persist($message);
457			$this->em->flush();
458			$this->em->clear();
459			}
460
461			return $message;
462			}
463
464			/**
465			* Get messages of the queue.
466			*
467			* @param int $maxMessages
468			* @param int $timeout
469			* @param ZendQueue\Queue $queue
470			* @param int $microtime
471			*/
472			protected function getMessages($maxMessages, $timeout, $queue = null, $microtime = null)
473			{
474			if ($maxMessages === null) {
475			$maxMessages = 1;
476			}
477
478			if ($timeout === null) {
479			$timeout = self::RECEIVE_TIMEOUT_DEFAULT;
480			}
481
482			$andWhere = '';
483			if ($queue instanceof Queue) {
484			$andWhere = 'AND (m.queue = :queue) AND (q.maxRetries IS NULL OR m.numRetries < q.maxRetries)';
485			}
486
487			// Search for all messages inside the timeout
488			$sql = 'SELECT m '.
489			'FROM Heri\Bundle\JobQueueBundle\Entity\Message m '.
490			'LEFT JOIN m.queue q '.
491			'WHERE (m.handle IS NULL OR m.handle = \'\' OR m.timeout + :timeout < :microtime) '.$andWhere.' '.
492			'ORDER BY m.priority DESC';
493
494			$query = $this->em->createQuery($sql);
495
496			$query->setParameter('timeout', (int) $timeout);
497			$query->setParameter('microtime', (int) $microtime);
498
499			if ($queue instanceof Queue) {
500			$query->setParameter('queue', $this->getQueueEntity($queue->getName()));
501			}
502			$query->setMaxResults($maxMessages);
503
504			return $query->getResult();
505			}
506
507			/**
508			* Get the queue entity.
509			*
510			* @param string $name
511			*
512			* @return Queue Entity
513			*
514			* @throws ZendQueue\Exception
515			*/
516			protected function getQueueEntity($name)
517			{
518			$repo = $this->em
519			->getRepository('Heri\Bundle\JobQueueBundle\Entity\Queue')
520			->findOneBy([
521			'name' => $name,
522			]);
523
524			if (!$repo) {
525			throw new AdapterRuntimeException(sprintf('Queue does not exist: %s', $name));
526			}
527
528			return $repo;
529			}
530			}
531

heristop / HeriJobQueueBundle

Branch — master (b61033)

DoctrineAdapter B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like