ArrayRecipientIterator.php

Go to the documentation of this file.

<?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.
 */

//@require 'Swift/Mailer/RecipientIterator.php';

/**
 * Wraps a standard PHP array in an interator.
 * @package Swift
 * @subpackage Mailer
 * @author Chris Corbyn
 */
class Swift_Mailer_ArrayRecipientIterator
  implements Swift_Mailer_RecipientIterator
{

  /**
   * The list of recipients.
   * @var array
   * @access private
   */
  private $_recipients = array();

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

  /**
   * Returns true only if there are more recipients to send to.
   * @return boolean
   */
  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->_recipients, 0, 1);
  }

}