ソースを参照

Fixes DocBlocks in Zend_Mobile

Frank Brückner 11 年 前
コミット
1de1a7f361

+ 6 - 6
library/Zend/Mobile/Push/Apns.php

@@ -209,10 +209,10 @@ class Zend_Mobile_Push_Apns extends Zend_Mobile_Push_Abstract
     /**
      * Connect to the Push Server
      *
-     * @param string $env
-     * @return Zend_Mobile_Push_Abstract
+     * @param  int|string $env
      * @throws Zend_Mobile_Push_Exception
      * @throws Zend_Mobile_Push_Exception_ServerUnavailable
+     * @return Zend_Mobile_Push_Abstract
      */
     public function connect($env = self::SERVER_PRODUCTION_URI)
     {
@@ -271,13 +271,13 @@ class Zend_Mobile_Push_Apns extends Zend_Mobile_Push_Abstract
     /**
      * Send Message
      *
-     * @param Zend_Mobile_Push_Message_Apns $message
-     * @return boolean
+     * @param  Zend_Mobile_Push_Message_Abstract $message
      * @throws Zend_Mobile_Push_Exception
-     * @throws Zend_Mobile_Push_Exception_ServerUnavailable
+     * @throws Zend_Mobile_Push_Exception_InvalidPayload
      * @throws Zend_Mobile_Push_Exception_InvalidToken
      * @throws Zend_Mobile_Push_Exception_InvalidTopic
-     * @throws Zend_Mobile_Push_Exception_InvalidPayload
+     * @throws Zend_Mobile_Push_Exception_ServerUnavailable
+     * @return bool
      */
     public function send(Zend_Mobile_Push_Message_Abstract $message)
     {

+ 7 - 3
library/Zend/Mobile/Push/Gcm.php

@@ -53,7 +53,7 @@ class Zend_Mobile_Push_Gcm extends Zend_Mobile_Push_Abstract
     /**
      * Http Client
      *
-     * @var Client
+     * @var Zend_Http_Client
      */
     protected $_httpClient;
 
@@ -120,9 +120,13 @@ class Zend_Mobile_Push_Gcm extends Zend_Mobile_Push_Abstract
     /**
      * Send Message
      *
-     * @param Zend_Mobile_Push_Message_Gcm $message
-     * @return Zend_Mobile_Push_Response_Gcm
+     * @param  Zend_Mobile_Push_Message_Abstract $message
+     * @throws Zend_Http_Client_Exception
      * @throws Zend_Mobile_Push_Exception
+     * @throws Zend_Mobile_Push_Exception_InvalidAuthToken
+     * @throws Zend_Mobile_Push_Exception_InvalidPayload
+     * @throws Zend_Mobile_Push_Exception_ServerUnavailable
+     * @return Zend_Mobile_Push_Response_Gcm
      */
     public function send(Zend_Mobile_Push_Message_Abstract $message)
     {

+ 1 - 1
library/Zend/Mobile/Push/Interface.php

@@ -42,7 +42,7 @@ interface Zend_Mobile_Push_Interface
     /**
      * Send a Push Message
      *
-     * @param Zend_Mobile_Push_Message_Interface $message
+     * @param  Zend_Mobile_Push_Message_Abstract $message
      * @return boolean
      */
     public function send(Zend_Mobile_Push_Message_Abstract $message);

+ 4 - 3
library/Zend/Mobile/Push/Message/Abstract.php

@@ -48,7 +48,7 @@ abstract class Zend_Mobile_Push_Message_Abstract implements Zend_Mobile_Push_Mes
     /**
      * Id
      *
-     * @var scalar
+     * @var int|string|float|bool Scalar
      */
     protected $_id;
 
@@ -66,6 +66,7 @@ abstract class Zend_Mobile_Push_Message_Abstract implements Zend_Mobile_Push_Mes
      * Set Token
      *
      * @param  string $token
+     * @throws Zend_Mobile_Push_Message_Exception
      * @return Zend_Mobile_Push_Message_Abstract
      */
     public function setToken($token)
@@ -80,7 +81,7 @@ abstract class Zend_Mobile_Push_Message_Abstract implements Zend_Mobile_Push_Mes
     /**
      * Get Message ID
      * 
-     * @return scalar
+     * @return int|string|float|bool Scalar
      */
     public function getId()
     {
@@ -90,7 +91,7 @@ abstract class Zend_Mobile_Push_Message_Abstract implements Zend_Mobile_Push_Mes
     /**
      * Set Message ID
      *
-     * @param scalar $id
+     * @param  int|string|float|bool $id Scalar
      * @return Zend_Mobile_Push_Message_Abstract
      * @throws Exception
      */

+ 8 - 7
library/Zend/Mobile/Push/Message/Apns.php

@@ -83,11 +83,12 @@ class Zend_Mobile_Push_Message_Apns extends Zend_Mobile_Push_Message_Abstract
     /**
      * Set Alert
      *
-     * @param string $text
-     * @param string $actionLocKey
-     * @param string $locKey
-     * @param array $locArgs
-     * @param string $launchImage
+     * @param  string      $text
+     * @param  string|null $actionLocKey
+     * @param  string|null $locKey
+     * @param  array|null  $locArgs
+     * @param  string|null $launchImage
+     * @throws Zend_Mobile_Push_Message_Exception
      * @return Zend_Mobile_Push_Message_Apns
      */
     public function setAlert($text, $actionLocKey=null, $locKey=null, $locArgs=null, $launchImage=null)
@@ -243,9 +244,9 @@ class Zend_Mobile_Push_Message_Apns extends Zend_Mobile_Push_Message_Abstract
     /**
      * Set Custom Data
      *
-     * @param array $data
-     * @return Zend_Mobile_Push_Message_Apns
+     * @param  array $array
      * @throws Zend_Mobile_Push_Message_Exception
+     * @return Zend_Mobile_Push_Message_Apns
      */
     public function setCustomData($array)
     {

+ 2 - 1
library/Zend/Mobile/Push/Message/Gcm.php

@@ -201,7 +201,8 @@ class Zend_Mobile_Push_Message_Gcm extends Zend_Mobile_Push_Message_Abstract
     /**
      * Set time to live.
      *
-     * @param int $secs
+     * @param  int $secs
+     * @throws Zend_Mobile_Push_Message_Exception
      * @return Zend_Mobile_Push_Message_Gcm
      */
     public function setTtl($secs)

+ 2 - 2
library/Zend/Mobile/Push/Message/Interface.php

@@ -50,14 +50,14 @@ interface Zend_Mobile_Push_Message_Interface
     /**
      * Get Id
      *
-     * @return scalar
+     * @return int|string|float|bool Scalar
      */
     public function getId();
 
     /**
      * Set Id
      *
-     * @param scalar $id
+     * @param int|string|float|bool $id Scalar
      * @return Zend_Mobile_Push_Message_Abstract
      */
     public function setId($id);

+ 9 - 3
library/Zend/Mobile/Push/Mpns.php

@@ -44,7 +44,7 @@ class Zend_Mobile_Push_Mpns extends Zend_Mobile_Push_Abstract
     /**
      * Http Client
      *
-     * @var Client
+     * @var Zend_Http_Client
      */
     protected $_httpClient;
 
@@ -78,9 +78,15 @@ class Zend_Mobile_Push_Mpns extends Zend_Mobile_Push_Abstract
     /**
      * Send Message
      *
-     * @param Zend_Mobile_Push_Message_Mpns $message
-     * @return boolean
+     * @param  Zend_Mobile_Push_Message_Abstract $message
+     * @throws Zend_Http_Client_Exception
      * @throws Zend_Mobile_Push_Exception
+     * @throws Zend_Mobile_Push_Exception_DeviceQuotaExceeded
+     * @throws Zend_Mobile_Push_Exception_InvalidPayload
+     * @throws Zend_Mobile_Push_Exception_InvalidToken
+     * @throws Zend_Mobile_Push_Exception_QuotaExceeded
+     * @throws Zend_Mobile_Push_Exception_ServerUnavailable
+     * @return boolean
      */
     public function send(Zend_Mobile_Push_Message_Abstract $message)
     {

+ 2 - 1
library/Zend/Mobile/Push/Response/Gcm.php

@@ -138,7 +138,8 @@ class Zend_Mobile_Push_Response_Gcm
     /**
      * Set Response
      *
-     * @param array $response
+     * @param  array $response
+     * @throws Zend_Mobile_Push_Exception
      * @return Zend_Mobile_Push_Response_Gcm
      */
     public function setResponse(array $response)

+ 0 - 1
library/Zend/Mobile/Push/Test/ApnsProxy.php

@@ -51,7 +51,6 @@ class Zend_Mobile_Push_Test_ApnsProxy extends Zend_Mobile_Push_Apns
      * Set the Response
      *
      * @param string $str
-     * @return Zend_Mobile_Push_ApnsProxy
      */
     public function setReadResponse($str) {
         $this->_readResponse = $str;