Zend Framework API Documentation
Back to top  

APNS Push

category Zend
package Zend_Mobile
subpackage Zend_Mobile_Push
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
version $Id$
inherited_from \Zend_Mobile_Push_Abstract

 Methods

Close Connection

close() : void
inherited_from \Zend_Mobile_Push_Abstract::close()

Close the Connection to the Push Server

close() : void
Inherited
inherited_from \Zend_Mobile_Push_Interface::close()

Connect to the Push Server

connect(integer|string $env = self::SERVER_PRODUCTION_URI) : \Zend_Mobile_Push_Abstract
inherited_from \Zend_Mobile_Push_Abstract::connect()

Parameters

$env

integerstring

Exceptions

\Zend_Mobile_Push_Exception
\Zend_Mobile_Push_Exception_ServerUnavailable

Returns

\Zend_Mobile_Push_Abstract

Connect to the Push Server

connect() : \Zend_Mobile_Push_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Interface::connect()

Returns

\Zend_Mobile_Push_Abstract

Feedback

feedback() : array

Exceptions

\Zend_Mobile_Push_Exception
\Zend_Mobile_Push_Exception_ServerUnavailable

Returns

arrayarray w/ key = token and value = time

Get Certficiate

getCertificate() : string

Returns

string

Get Certificate Passphrase

getCertificatePassphrase() : string

Returns

string

Is Connected

isConnected() : boolean
Inherited

Returns

boolean

Send Message

send(\Zend_Mobile_Push_Message_Abstract $message) : boolean
inherited_from \Zend_Mobile_Push_Abstract::send()

Parameters

$message

\Zend_Mobile_Push_Message_Abstract

Exceptions

\Zend_Mobile_Push_Exception
\Zend_Mobile_Push_Exception_InvalidPayload
\Zend_Mobile_Push_Exception_InvalidToken
\Zend_Mobile_Push_Exception_InvalidTopic
\Zend_Mobile_Push_Exception_ServerUnavailable

Returns

boolean

Send a Push Message

send(\Zend_Mobile_Push_Message_Abstract $message) : boolean
Inherited
inherited_from \Zend_Mobile_Push_Interface::send()

Parameters

$message

\Zend_Mobile_Push_Message_Abstract

Exceptions

\DomainException

Returns

boolean

Set Certificate

setCertificate(string $cert) : \Zend_Mobile_Push_Apns

Parameters

$cert

string

Exceptions

\Zend_Mobile_Push_Exception

Returns

\Zend_Mobile_Push_Apns

Set Certificate Passphrase

setCertificatePassphrase(string $passphrase) : \Zend_Mobile_Push_Apns

Parameters

$passphrase

string

Exceptions

\Zend_Mobile_Push_Exception

Returns

\Zend_Mobile_Push_Apns

Set Options

setOptions(array $options) : \Zend_Mobile_Push_Abstract
Inherited
inherited_from \Zend_Mobile_Push_Interface::setOptions()

Parameters

$options

array

Exceptions

\Zend_Mobile_Push_Exception

Returns

\Zend_Mobile_Push_Abstract

Connect to Socket

_connect(string $uri) : boolean

Parameters

$uri

string

Exceptions

\Zend_Mobile_Push_Exception_ServerUnavailable

Returns

boolean

Read from the Socket Server

_read(integer $length) : string

Parameters

$length

integer

Returns

string

Write to the Socket Server

_write(string $payload) : integer

Parameters

$payload

string

Returns

integer

 Properties

 

Certificate

$_certificate : string

Default

 

Certificate Passphrase

$_certificatePassphrase : string

Default

 

Current Environment

$_currentEnv : integer

Default

 

Is Connected

$_isConnected : boolean

Default

false
 

Apple Server URI's

$_serverUriList : array

Default

array('ssl://gateway.sandbox.push.apple.com:2195', 'ssl://gateway.push.apple.com:2195', 'ssl://feedback.sandbox.push.apple.com:2196', 'ssl://feedback.push.apple.com:2196')
 

Socket

$_socket : resource

Default

 Constants

 

SERVER_FEEDBACK_PRODUCTION_URI

SERVER_FEEDBACK_PRODUCTION_URI = 3 
 

SERVER_FEEDBACK_SANDBOX_URI

SERVER_FEEDBACK_SANDBOX_URI = 2 
 

SERVER_PRODUCTION_URI

SERVER_PRODUCTION_URI = 1 
 

SERVER_SANDBOX_URI

SERVER_SANDBOX_URI = 0 
const int apple server uri constants