Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: yarcode/yii2-queue-mailer
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 1.0.2
Choose a base ref
...
head repository: yarcode/yii2-queue-mailer
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
  • 2 commits
  • 5 files changed
  • 1 contributor

Commits on Jun 13, 2018

  1. Copy the full SHA
    ef0f060 View commit details
  2. Copy the full SHA
    ecf9640 View commit details
Showing with 59 additions and 23 deletions.
  1. +6 −0 README.md
  2. +7 −15 src/Jobs/SendMessageJob.php
  3. +1 −2 src/Jobs/SendMultipleMessagesJob.php
  4. +18 −2 src/Mailer.php
  5. +27 −4 tests/MailerTest.php
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -50,6 +50,12 @@ $message = \Yii::$app->mailer->compose()
\Yii::$app->mailer->send($message);
```

You can also get a background job ID of the last `send()` or `sendMultiple()` call.
```
$jobId = \Yii::$app->mailer->getLastJobId();
```

## Licence ##

MIT
22 changes: 7 additions & 15 deletions src/Jobs/SendMessageJob.php
Original file line number Diff line number Diff line change
@@ -16,31 +16,23 @@ class SendMessageJob extends BaseObject implements JobInterface
{
/** @var MessageInterface */
public $message;
/** @var Mailer */
/** @var string */
public $mailer;

/**
* @inheritdoc
* @see JobInterface::execute(
*
* @throws InvalidConfigException
* @throws \InvalidArgumentException
*/
public function init()
public function execute($queue)
{
parent::init();
if (!$this->message instanceof MessageInterface) {
throw new \InvalidArgumentException('Message must be an instance of ' . MessageInterface::class);
}

/** @var Mailer $mailer */
$this->mailer = Instance::ensure($this->mailer, Mailer::class);
}

/**
* @inheritdoc
* @see JobInterface::execute()
*/
public function execute($queue)
{

return $this->mailer->syncMailer->send($this->message);
$mailer = Instance::ensure($this->mailer, Mailer::class);
return $mailer->getSyncMailer()->send($this->message);
}
}
3 changes: 1 addition & 2 deletions src/Jobs/SendMultipleMessagesJob.php
Original file line number Diff line number Diff line change
@@ -30,9 +30,8 @@ public function execute($queue)
if (!is_array($this->messages)) {
throw new \InvalidArgumentException('Message must be an instance of ' . MessageInterface::class);
}

/** @var Mailer $mailer */
$mailer = Instance::ensure($this->mailer, Mailer::class);
return $mailer->syncMailer->sendMultiple($this->messages);
return $mailer->getSyncMailer()->sendMultiple($this->messages);
}
}
20 changes: 18 additions & 2 deletions src/Mailer.php
Original file line number Diff line number Diff line change
@@ -20,6 +20,8 @@ class Mailer extends Component implements MailerInterface
protected $queue = 'queue';
/** @var MailerInterface */
protected $syncMailer;
/** @var int|null */
protected $lastJobId;

/**
* @return object|Queue
@@ -81,7 +83,8 @@ public function send($message)
$job = \Yii::createObject(SendMessageJob::class);
$job->mailer = $this->id;
$job->message = $message;
return $this->getQueue()->push($job);
$this->lastJobId = $this->getQueue()->push($job);
return $this->lastJobId !== null;
}

/**
@@ -95,6 +98,19 @@ public function sendMultiple(array $messages)
$job = \Yii::createObject(SendMultipleMessagesJob::class);
$job->mailer = $this->id;
$job->messages = $messages;
return $this->getQueue()->push($job);
$this->lastJobId = $this->getQueue()->push($job);
if ($this->lastJobId !== null) {
return count($messages);
} else {
return 0;
}
}

/**
* @return int|null
*/
public function getLastJobId()
{
return $this->lastJobId;
}
}
31 changes: 27 additions & 4 deletions tests/MailerTest.php
Original file line number Diff line number Diff line change
@@ -5,15 +5,17 @@
class MailerTest extends \PHPUnit\Framework\TestCase
{
/** @var \YarCode\Yii2\QueueMailer\Mailer */
public $a;

public $mailer;
/** @var \yii\mail\MessageInterface */
public $message;
/**
* @throws \yii\base\InvalidConfigException
*/
public function setUp()
{
parent::setUp();
$this->a = \Yii::createObject([

$this->mailer = \Yii::createObject([
'class' => \YarCode\Yii2\QueueMailer\Mailer::class,
'queue' => [
'class' => \yii\queue\sync\Queue::class,
@@ -24,10 +26,31 @@ public function setUp()
'useFileTransport' => true,
],
]);

$this->message = $this->mailer->compose();
$this->message->setTo('test@example.org');
$this->message->setFrom('no-reply@example.org');
$this->message->setHtmlBody('test message');
}

public function testInterface()
{
$this->assertInstanceOf(\yii\mail\MailerInterface::class, $this->a);
$this->assertInstanceOf(\yii\mail\MailerInterface::class, $this->mailer);
}

public function testSend()
{
$this->assertTrue($this->mailer->send($this->message));
}

public function testSendMultiple()
{
$this->assertEquals(2, $this->mailer->send([$this->message, $this->message]));
}

public function testGetLastJobId()
{
$this->mailer->send($this->message);
$this->assertEquals(1, $this->mailer->getLastJobId());
}
}