Skip to content
This repository was archived by the owner on Oct 2, 2019. It is now read-only.

Commit 1de1a7f

Browse files
froschdesignfroschdesign
committed
Fixes DocBlocks in Zend_Mobile
1 parent 1c42e24 commit 1de1a7f

File tree

10 files changed

+41
-28
lines changed

10 files changed

+41
-28
lines changed

‎library/Zend/Mobile/Push/Apns.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -209,10 +209,10 @@ protected function _write($payload) {
209209
/**
210210
* Connect to the Push Server
211211
*
212-
* @param string $env
213-
* @return Zend_Mobile_Push_Abstract
212+
* @param int|string $env
214213
* @throws Zend_Mobile_Push_Exception
215214
* @throws Zend_Mobile_Push_Exception_ServerUnavailable
215+
* @return Zend_Mobile_Push_Abstract
216216
*/
217217
public function connect($env = self::SERVER_PRODUCTION_URI)
218218
{
@@ -271,13 +271,13 @@ public function feedback()
271271
/**
272272
* Send Message
273273
*
274-
* @param Zend_Mobile_Push_Message_Apns $message
275-
* @return boolean
274+
* @param Zend_Mobile_Push_Message_Abstract $message
276275
* @throws Zend_Mobile_Push_Exception
277-
* @throws Zend_Mobile_Push_Exception_ServerUnavailable
276+
* @throws Zend_Mobile_Push_Exception_InvalidPayload
278277
* @throws Zend_Mobile_Push_Exception_InvalidToken
279278
* @throws Zend_Mobile_Push_Exception_InvalidTopic
280-
* @throws Zend_Mobile_Push_Exception_InvalidPayload
279+
* @throws Zend_Mobile_Push_Exception_ServerUnavailable
280+
* @return bool
281281
*/
282282
public function send(Zend_Mobile_Push_Message_Abstract $message)
283283
{

‎library/Zend/Mobile/Push/Gcm.php

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class Zend_Mobile_Push_Gcm extends Zend_Mobile_Push_Abstract
5353
/**
5454
* Http Client
5555
*
56-
* @var Client
56+
* @var Zend_Http_Client
5757
*/
5858
protected $_httpClient;
5959

@@ -120,9 +120,13 @@ public function setHttpClient(Zend_Http_Client $client)
120120
/**
121121
* Send Message
122122
*
123-
* @param Zend_Mobile_Push_Message_Gcm $message
124-
* @return Zend_Mobile_Push_Response_Gcm
123+
* @param Zend_Mobile_Push_Message_Abstract $message
124+
* @throws Zend_Http_Client_Exception
125125
* @throws Zend_Mobile_Push_Exception
126+
* @throws Zend_Mobile_Push_Exception_InvalidAuthToken
127+
* @throws Zend_Mobile_Push_Exception_InvalidPayload
128+
* @throws Zend_Mobile_Push_Exception_ServerUnavailable
129+
* @return Zend_Mobile_Push_Response_Gcm
126130
*/
127131
public function send(Zend_Mobile_Push_Message_Abstract $message)
128132
{

‎library/Zend/Mobile/Push/Interface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public function connect();
4242
/**
4343
* Send a Push Message
4444
*
45-
* @param Zend_Mobile_Push_Message_Interface $message
45+
* @param Zend_Mobile_Push_Message_Abstract $message
4646
* @return boolean
4747
*/
4848
public function send(Zend_Mobile_Push_Message_Abstract $message);

‎library/Zend/Mobile/Push/Message/Abstract.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ abstract class Zend_Mobile_Push_Message_Abstract implements Zend_Mobile_Push_Mes
4848
/**
4949
* Id
5050
*
51-
* @var scalar
51+
* @var int|string|float|bool Scalar
5252
*/
5353
protected $_id;
5454

@@ -66,6 +66,7 @@ public function getToken()
6666
* Set Token
6767
*
6868
* @param string $token
69+
* @throws Zend_Mobile_Push_Message_Exception
6970
* @return Zend_Mobile_Push_Message_Abstract
7071
*/
7172
public function setToken($token)
@@ -80,7 +81,7 @@ public function setToken($token)
8081
/**
8182
* Get Message ID
8283
*
83-
* @return scalar
84+
* @return int|string|float|bool Scalar
8485
*/
8586
public function getId()
8687
{
@@ -90,7 +91,7 @@ public function getId()
9091
/**
9192
* Set Message ID
9293
*
93-
* @param scalar $id
94+
* @param int|string|float|bool $id Scalar
9495
* @return Zend_Mobile_Push_Message_Abstract
9596
* @throws Exception
9697
*/

‎library/Zend/Mobile/Push/Message/Apns.php

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,12 @@ public function getAlert()
8383
/**
8484
* Set Alert
8585
*
86-
* @param string $text
87-
* @param string $actionLocKey
88-
* @param string $locKey
89-
* @param array $locArgs
90-
* @param string $launchImage
86+
* @param string $text
87+
* @param string|null $actionLocKey
88+
* @param string|null $locKey
89+
* @param array|null $locArgs
90+
* @param string|null $launchImage
91+
* @throws Zend_Mobile_Push_Message_Exception
9192
* @return Zend_Mobile_Push_Message_Apns
9293
*/
9394
public function setAlert($text, $actionLocKey=null, $locKey=null, $locArgs=null, $launchImage=null)
@@ -243,9 +244,9 @@ public function clearCustomData()
243244
/**
244245
* Set Custom Data
245246
*
246-
* @param array $data
247-
* @return Zend_Mobile_Push_Message_Apns
247+
* @param array $array
248248
* @throws Zend_Mobile_Push_Message_Exception
249+
* @return Zend_Mobile_Push_Message_Apns
249250
*/
250251
public function setCustomData($array)
251252
{

‎library/Zend/Mobile/Push/Message/Gcm.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,8 @@ public function getDelayWhileIdle()
201201
/**
202202
* Set time to live.
203203
*
204-
* @param int $secs
204+
* @param int $secs
205+
* @throws Zend_Mobile_Push_Message_Exception
205206
* @return Zend_Mobile_Push_Message_Gcm
206207
*/
207208
public function setTtl($secs)

‎library/Zend/Mobile/Push/Message/Interface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ public function setToken($token);
5050
/**
5151
* Get Id
5252
*
53-
* @return scalar
53+
* @return int|string|float|bool Scalar
5454
*/
5555
public function getId();
5656

5757
/**
5858
* Set Id
5959
*
60-
* @param scalar $id
60+
* @param int|string|float|bool $id Scalar
6161
* @return Zend_Mobile_Push_Message_Abstract
6262
*/
6363
public function setId($id);

‎library/Zend/Mobile/Push/Mpns.php

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class Zend_Mobile_Push_Mpns extends Zend_Mobile_Push_Abstract
4444
/**
4545
* Http Client
4646
*
47-
* @var Client
47+
* @var Zend_Http_Client
4848
*/
4949
protected $_httpClient;
5050

@@ -78,9 +78,15 @@ public function setHttpClient(Zend_Http_Client $client)
7878
/**
7979
* Send Message
8080
*
81-
* @param Zend_Mobile_Push_Message_Mpns $message
82-
* @return boolean
81+
* @param Zend_Mobile_Push_Message_Abstract $message
82+
* @throws Zend_Http_Client_Exception
8383
* @throws Zend_Mobile_Push_Exception
84+
* @throws Zend_Mobile_Push_Exception_DeviceQuotaExceeded
85+
* @throws Zend_Mobile_Push_Exception_InvalidPayload
86+
* @throws Zend_Mobile_Push_Exception_InvalidToken
87+
* @throws Zend_Mobile_Push_Exception_QuotaExceeded
88+
* @throws Zend_Mobile_Push_Exception_ServerUnavailable
89+
* @return boolean
8490
*/
8591
public function send(Zend_Mobile_Push_Message_Abstract $message)
8692
{

‎library/Zend/Mobile/Push/Response/Gcm.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ public function getResponse()
138138
/**
139139
* Set Response
140140
*
141-
* @param array $response
141+
* @param array $response
142+
* @throws Zend_Mobile_Push_Exception
142143
* @return Zend_Mobile_Push_Response_Gcm
143144
*/
144145
public function setResponse(array $response)

‎library/Zend/Mobile/Push/Test/ApnsProxy.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ class Zend_Mobile_Push_Test_ApnsProxy extends Zend_Mobile_Push_Apns
5151
* Set the Response
5252
*
5353
* @param string $str
54-
* @return Zend_Mobile_Push_ApnsProxy
5554
*/
5655
public function setReadResponse($str) {
5756
$this->_readResponse = $str;

0 commit comments

Comments
 (0)