AwsHelper\SqsHelper

Complexity

Total Complexity

15

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	6
Bugs	3	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	connect()	0	4	1
A	setQueueUrl()	0	4	1
A	stop()	0	4	1
B	listen()	0	29	5
A	remove()	0	8	1
A	push()	0	8	1
A	getQueueAttributes()	0	11	2
A	getQueueAttribute()	0	5	2

<?php namespace AwsHelper;

use Aws\Sqs\SqsClient;
use Aws\S3\Exception\S3Exception;

class SqsHelper
{

    protected $sqs;
    protected $adapter;
    protected $queue_url;
    protected $region;

    public function __construct(AwsHelper $adapter, $queue_url, $region)
    {
        $this->setQueueUrl($queue_url);
        $this->adapter = $adapter;
        $this->region = $region;
        $this->connect();
    }

    public function connect()
    {
        $this->sqs = SqsClient::factory($this->adapter->getDefaultOptions() + ['region' => $this->region]);
    }

    public function setQueueUrl($queue_url)
    {
        $this->queue_url = $queue_url;
    }

    /* For when you want to stop the listener from running */
    public function stop()
    {
        $this->stop = true;

The property stop does not exist. Did you maybe forget to declare it?

    }

    /* Begin listening for messages from the SQS queue.
    @param $num_msg Dictates how many messages you wish to process at a time
    */
    public function listen($num_msg = 1)
    {
        $expirationTime = $this->adapter->getJSON()->Expiration;
        $this->stop = false;
        while (!$this->stop) {

            if ($this->adapter->hasAccessExpired($expirationTime))
            {
                $this->connect();
                $expirationTime = $this->adapter->getJSON()->Expiration;
            }

            $messages = $this->sqs->receiveMessage([
                'QueueUrl'        => $this->queue_url,

                // Enables HTTP long polling
                'WaitTimeSeconds' => 20,
                'MaxNumberOfMessages' => $num_msg,
            ]);

            if (!$messages->hasKey('Messages')) {
                continue;
            }

            foreach ($messages->get('Messages') as $msg_data) {
                yield new SqsMessage($msg_data);
            }
        }
    }

    /* Throws a message off the queue. I.E. It's been processed successfully
    @params $message Feed it the message object you recieved from the listen method
    */
    public function remove(SqsMessage $message)
    {
        $messages = $this->sqs->deleteMessage([

$messages is not used, you could remove the assignment.

            'QueueUrl'       => $this->queue_url,
            'ReceiptHandle'  => $message->get('ReceiptHandle'),

        ]);
    }

    /* Pushes something to the SQS service
    @params $data The data of your message.
    @params $attributes Any optional meta data attributes you wish to feed through
    */
    public function push($data, $attributes = [])
    {
        return $this->sqs->sendMessage([
            'QueueUrl' => $this->queue_url,
            'MessageBody' => $data,
            'MessageAttributes' => $attributes,
        ]);
    }

    /**
     * Get a list of queue attributes
     * @param  array $attributes An array of queue attribute names
     * @return array             An array of specified queue attributes with keys as attribute names
     */
    public function getQueueAttributes($attributes)
    {
        $queueAttributes = $this->sqs->getQueueAttributes([
            'QueueUrl' => $this->queue_url,
            'AttributeNames' => $attributes,
        ]);
        if (!$queueAttributes->hasKey('Attributes')) {
            return [];
        }
        return $queueAttributes->get('Attributes');
    }

    /**
     * Shorthand function to get a single queue attribute
     * @param  string $attribute A Queue attribute
     * @return mixed             String data of the specified queue attribute or null
     */
    public function getQueueAttribute($attribute)
    {
        $queueAttributes = $this->getQueueAttributes([$attribute]);
        return array_key_exists($attribute, $queueAttributes) ? $queueAttributes[$attribute] : null;
    }
}


class SqsMessage

PSR1 recommends that each class should be in its own file to aid autoloaders.

{
    public function __construct($msg_data)
    {
        $this->data = $msg_data;

The property data does not exist. Did you maybe forget to declare it?

    }

    public function getAll()
    {
        return $this->data;
    }

    public function get($key)
    {
        return $this->data[$key];
    }

    public function has($key)
    {
        return empty($this->data[$key]);
    }
}