[zen-27] renamed AddressInterface to Address\AddressInterface

- Makes it internally consistent inside the component
zendframework · May 4, 2012 · 5a453b7 · 5a453b7
1 parent e3a7385
commit 5a453b7
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 37 deletions.
diff --git a/src/Address.php b/src/Address.php
@@ -26,7 +26,7 @@
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
-class Address implements AddressInterface
+class Address implements Address\AddressInterface
 {
     protected $email;
     protected $name;
@@ -37,7 +37,7 @@ class Address implements AddressInterface
      * @param  string $email
      * @param  null|string $name
      * @throws Exception\InvalidArgumentException
-     * @return \Zend\Mail\Address
+     * @return Address
      */
     public function __construct($email, $name = null)
     {

diff --git a/src/AddressInterface.php → src/Address/AddressInterface.php b/src/AddressInterface.php → src/Address/AddressInterface.php
@@ -14,15 +14,17 @@
  *
  * @category   Zend
  * @package    Zend_Mail
+ * @subpackage Address
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
-namespace Zend\Mail;
+namespace Zend\Mail\Address;
 
 /**
  * @category   Zend
  * @package    Zend_Mail
+ * @subpackage Address
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */

diff --git a/src/AddressList.php b/src/AddressList.php
@@ -41,7 +41,7 @@ class AddressList implements Countable, Iterator
     /**
      * Add an address to the list
      *
-     * @param  string|AddressInterface $emailOrAddress
+     * @param  string|Address\AddressInterface $emailOrAddress
      * @param  null|string $name
      * @throws Exception\InvalidArgumentException
      * @return AddressList
@@ -51,7 +51,7 @@ public function add($emailOrAddress, $name = null)
         if (is_string($emailOrAddress)) {
             $emailOrAddress = $this->createAddress($emailOrAddress, $name);
         }
-        if (!$emailOrAddress instanceof AddressInterface) {
+        if (!$emailOrAddress instanceof Address\AddressInterface) {
             throw new Exception\InvalidArgumentException(sprintf(
                 '%s expects an email address or %s\Address object as its first argument; received "%s"',
                 __METHOD__,
@@ -74,7 +74,7 @@ public function add($emailOrAddress, $name = null)
      *
      * If an email key is provided, it will be used as the email, and the value
      * as the name. Otherwise, the value is passed as the sole argument to add(),
-     * and, as such, can be either email strings or AddressInterface objects.
+     * and, as such, can be either email strings or Address\AddressInterface objects.
      *
      * @param  array $addresses
      * @throws Exception\RuntimeException
@@ -127,7 +127,7 @@ public function has($email)
      * Get an address by email
      * 
      * @param  string $email 
-     * @return boolean|AddressInterface
+     * @return boolean|Address\AddressInterface
      */
     public function get($email)
     {

diff --git a/src/Header/Sender.php b/src/Header/Sender.php
@@ -33,7 +33,7 @@
 class Sender implements HeaderInterface
 {
     /**
-     * @var \Zend\Mail\AddressInterface
+     * @var \Zend\Mail\Address\AddressInterface
      */
     protected $address;
 
@@ -94,7 +94,7 @@ public function getFieldName()
      */
     public function getFieldValue()
     {
-        if (!$this->address instanceof Mail\AddressInterface) {
+        if (!$this->address instanceof Mail\Address\AddressInterface) {
             return '';
         }
 
@@ -145,7 +145,7 @@ public function toString()
     /**
      * Set the address used in this header
      *
-     * @param  string|\Zend\Mail\AddressInterface $emailOrAddress
+     * @param  string|\Zend\Mail\Address\AddressInterface $emailOrAddress
      * @param  null|string $name
      * @throws Exception\InvalidArgumentException
      * @return Sender
@@ -155,7 +155,7 @@ public function setAddress($emailOrAddress, $name = null)
         if (is_string($emailOrAddress)) {
             $emailOrAddress = new Mail\Address($emailOrAddress, $name);
         }
-        if (!$emailOrAddress instanceof Mail\AddressInterface) {
+        if (!$emailOrAddress instanceof Mail\Address\AddressInterface) {
             throw new Exception\InvalidArgumentException(sprintf(
                 '%s expects a string or AddressInterface object; received "%s"',
                 __METHOD__,
@@ -169,7 +169,7 @@ public function setAddress($emailOrAddress, $name = null)
     /**
      * Retrieve the internal address from this header
      *
-     * @return \Zend\Mail\AddressInterface|null
+     * @return \Zend\Mail\Address\AddressInterface|null
      */
     public function getAddress()
     {

diff --git a/src/Message.php b/src/Message.php
@@ -123,7 +123,7 @@ public function headers()
     /**
      * Set (overwrite) From addresses
      * 
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressList 
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressList 
      * @param  string|null $name 
      * @return Message
      */
@@ -160,7 +160,7 @@ public function from()
     /**
      * Overwrite the address list in the To recipients
      * 
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressList 
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressList 
      * @param  null|string $name 
      * @return Message
      */
@@ -175,7 +175,7 @@ public function setTo($emailOrAddressList, $name = null)
      *
      * Appends to the list.
      * 
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressOrList 
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressOrList 
      * @param  null|string $name 
      * @return Message
      */
@@ -199,7 +199,7 @@ public function to()
     /**
      * Set (overwrite) CC addresses
      * 
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressList 
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressList 
      * @param  string|null $name 
      * @return Message
      */
@@ -236,7 +236,7 @@ public function cc()
     /**
      * Set (overwrite) BCC addresses
      * 
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressList 
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressList 
      * @param  string|null $name 
      * @return Message
      */
@@ -273,7 +273,7 @@ public function bcc()
     /**
      * Overwrite the address list in the Reply-To recipients
      * 
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressList 
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressList 
      * @param  null|string $name 
      * @return Message
      */
@@ -288,7 +288,7 @@ public function setReplyTo($emailOrAddressList, $name = null)
      *
      * Appends to the list.
      * 
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressOrList 
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressOrList 
      * @param  null|string $name 
      * @return Message
      */
@@ -326,7 +326,7 @@ public function setSender($emailOrAddress, $name = null)
     /**
      * Retrieve the sender address, if any
      * 
-     * @return null|AddressInterface
+     * @return null|Address\AddressInterface
      */
     public function getSender()
     {
@@ -511,7 +511,7 @@ protected function getAddressListFromHeader($headerName, $headerClass)
      * Proxied to this from addFrom, addTo, addCc, addBcc, and addReplyTo.
      *
      * @param  AddressList $addressList
-     * @param  string|AddressInterface|array|AddressList|Traversable $emailOrAddressOrList
+     * @param  string|Address\AddressInterface|array|AddressList|Traversable $emailOrAddressOrList
      * @param  null|string $name
      * @param  string $callingMethod
      * @throws Exception\InvalidArgumentException
@@ -528,7 +528,7 @@ protected function updateAddressList(AddressList $addressList, $emailOrAddressOr
             $addressList->addMany($emailOrAddressOrList);
             return;
         }
-        if (!is_string($emailOrAddressOrList) && !$emailOrAddressOrList instanceof AddressInterface) {
+        if (!is_string($emailOrAddressOrList) && !$emailOrAddressOrList instanceof Address\AddressInterface) {
             throw new Exception\InvalidArgumentException(sprintf(
                 '%s expects a string, AddressInterface, array, AddressList, or Traversable as its first argument; received "%s"',
                 $callingMethod,

diff --git a/src/Transport/Sendmail.php b/src/Transport/Sendmail.php
@@ -21,7 +21,7 @@
 
 namespace Zend\Mail\Transport;
 
-use Zend\Mail\AddressInterface;
+use Zend\Mail\Address\AddressInterface;
 
 use Traversable,
     Zend\Mail,

diff --git a/src/Transport/Smtp.php b/src/Transport/Smtp.php
@@ -46,12 +46,12 @@ class Smtp implements TransportInterface, Pluggable
     protected $options;
 
     /**
-     * @var \Zend\Mail\Protocol\Smtp
+     * @var Protocol\Smtp
      */
     protected $connection;
 
     /**
-     * @var \Zend\Mail\Protocol\SmtpBroker
+     * @var Protocol\SmtpBroker
      */
     protected $broker;
 
@@ -93,7 +93,7 @@ public function getOptions()
     /**
      * Set broker for obtaining SMTP protocol connection
      *
-     * @param \Zend\Mail\Protocol\SmtpBroker $broker
+     * @param  Protocol\SmtpBroker $broker
      * @throws Exception\InvalidArgumentException
      * @return Smtp
      */
@@ -113,7 +113,7 @@ public function setBroker($broker)
     /**
      * Get broker for loading SMTP protocol connection
      *
-     * @return \Zend\Mail\Protocol\SmtpBroker
+     * @return Protocol\SmtpBroker
      */
     public function getBroker()
     {
@@ -128,7 +128,7 @@ public function getBroker()
      * 
      * @param  string $name 
      * @param  array|null $options 
-     * @return \Zend\Mail\Protocol\Smtp
+     * @return Protocol\Smtp
      */
     public function plugin($name, array $options = null)
     {
@@ -154,7 +154,7 @@ public function __destruct()
     /**
      * Sets the connection protocol instance
      *
-     * @param \Zend\Mail\Protocol\AbstractProtocol $connection
+     * @param Protocol\AbstractProtocol $connection
      */
     public function setConnection(Protocol\AbstractProtocol $connection)
     {
@@ -165,7 +165,7 @@ public function setConnection(Protocol\AbstractProtocol $connection)
     /**
      * Gets the connection protocol instance
      *
-     * @return \Zend\Mail\Protocol\Smtp
+     * @return Protocol\Smtp
      */
     public function getConnection()
     {
@@ -178,7 +178,7 @@ public function getConnection()
      * The connection via the protocol adapter is made just-in-time to allow a
      * developer to add a custom adapter if required before mail is sent.
      *
-     * @param \Zend\Mail\Message $message
+     * @param Mail\Message $message
      */
     public function send(Mail\Message $message)
     {
@@ -214,14 +214,14 @@ public function send(Mail\Message $message)
     /**
      * Retrieve email address for envelope FROM
      *
-     * @param  \Zend\Mail\Message $message
+     * @param  Mail\Message $message
      * @throws Exception\RuntimeException
      * @return string
      */
     protected function prepareFromAddress(Mail\Message $message)
     {
         $sender = $message->getSender();
-        if ($sender instanceof Mail\AddressInterface) {
+        if ($sender instanceof Mail\Address\AddressInterface) {
             return $sender->getEmail();
         }
 
@@ -241,7 +241,7 @@ protected function prepareFromAddress(Mail\Message $message)
     /**
      * Prepare array of email address recipients
      * 
-     * @param  \Zend\Mail\Message $message
+     * @param  Mail\Message $message
      * @return array
      */
     protected function prepareRecipients(Mail\Message $message)
@@ -263,7 +263,7 @@ protected function prepareRecipients(Mail\Message $message)
     /**
      * Prepare header string from message
      * 
-     * @param  \Zend\Mail\Message $message
+     * @param  Mail\Message $message
      * @return string
      */
     protected function prepareHeaders(Mail\Message $message)
@@ -281,7 +281,7 @@ protected function prepareHeaders(Mail\Message $message)
     /**
      * Prepare body string from message
      * 
-     * @param  \Zend\Mail\Message $message
+     * @param  Mail\Message $message
      * @return string
      */
     protected function prepareBody(Mail\Message $message)
@@ -292,7 +292,7 @@ protected function prepareBody(Mail\Message $message)
     /**
      * Lazy load the connection, and pass it helo
      * 
-     * @return \Zend\Mail\Protocol\Smtp
+     * @return Mail\Protocol\Smtp
      */
     protected function lazyLoadConnection()
     {