Classes List

Swift_Mailer_ArrayRecipientIterator

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
<?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. */


/** * Wraps a standard PHP array in an iterator. * * @author Chris Corbyn */
class Swift_Mailer_ArrayRecipientIterator implements Swift_Mailer_RecipientIterator
{
    /** * The list of recipients. * * @var array */
    private $recipients = [];

    /** * Create a new ArrayRecipientIterator from $recipients. */
    public function __construct(array $recipients)
    {
        $this->recipients = $recipients;
    }

    /** * Returns true only if there are more recipients to send to. * * @return bool */
    public function hasNext()
    {
        return !empty($this->recipients);
    }

    /** * Returns an array where the keys are the addresses of recipients and the * values are the names. e.g. ('foo@bar' => 'Foo') or ('foo@bar' => NULL). * * @return array */
    public function nextRecipient()
    {
        return array_splice($this->recipients01);
    }
}