Mobile/Push/Apns.php

Show:

inherited

Classes
- \Zend_Mobile_Push_Apns

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mobile
Subpackage: Zend_Mobile_Push
Version: $Id$

\Zend_Mobile_Push_Apns
jump to top

Package: Zend\Mobile\Zend\Mobile\Push

APNS Push

Parent(s): \Zend_Mobile_Push_Abstract
Children: \Zend_Mobile_Push_Test_ApnsProxy
Category: Zend
Copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id$

Constants

 
                SERVER_SANDBOX_URI
                = 0

Const: int apple server uri constants

 
                SERVER_PRODUCTION_URI
                = 1

 
                SERVER_FEEDBACK_SANDBOX_URI
                = 2

 
                SERVER_FEEDBACK_PRODUCTION_URI
                = 3

Properties

string $_certificate =

Certificate

Details

Type: string

string $_certificatePassphrase =

Certificate Passphrase

Details

Type: string

int $_currentEnv =

Current Environment

Details

Type: int

boolean $_isConnected = false

inherited

Is Connected

Inherited from: \Zend_Mobile_Push_Abstract::$$_isConnected

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Mobile_Push_Abstract::$$_isConnected

array $_serverUriList = 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')

Apple Server URI's

Default value

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')

Details

Type: array

resource $_socket =

Socket

Details

Type: resource

Methods

_connect(string $uri) : bool

Connect to Socket

Parameters

Name	Type	Description
$uri	string

Returns

Type	Description
bool

Throws

Exception	Description
\Zend_Mobile_Push_Exception_ServerUnavailable

_read(int $length) : string

Read from the Socket Server

Parameters

Name	Type	Description
$length	int

Returns

Type	Description
string

_write(string $payload) : int

Write to the Socket Server

Parameters

Name	Type	Description
$payload	string

Returns

Type	Description
int

close() : void

Close Connection

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

Connect to the Push Server

Parameters

Name	Type	Description
$env	string

Returns

Type	Description
\Zend_Mobile_Push_Abstract

Throws

Exception	Description
\Zend_Mobile_Push_Exception
\Zend_Mobile_Push_Exception_ServerUnavailable

feedback() : array

Feedback

Returns

Type	Description
array	array w/ key = token and value = time

Throws

Exception	Description
\Zend_Mobile_Push_Exception
\Zend_Mobile_Push_Exception_ServerUnavailable

getCertificate() : string

Get Certficiate

Returns

Type	Description
string

getCertificatePassphrase() : string

Get Certificate Passphrase

Returns

Type	Description
string

isConnected() : boolean

inherited

Is Connected

Inherited from: \Zend_Mobile_Push_Abstract::isConnected()

Returns

Type	Description
boolean

send(\Zend_Mobile_Push_Message_Apns $message) : boolean

Send Message

Parameters

Name	Type	Description
$message	\Zend_Mobile_Push_Message_Apns

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Mobile_Push_Exception
\Zend_Mobile_Push_Exception_ServerUnavailable
\Zend_Mobile_Push_Exception_InvalidToken
\Zend_Mobile_Push_Exception_InvalidTopic
\Zend_Mobile_Push_Exception_InvalidPayload

setCertificate(string $cert) : \Zend_Mobile_Push_Apns

Set Certificate

Parameters

Name	Type	Description
$cert	string

Returns

Type	Description
\Zend_Mobile_Push_Apns

Throws

Exception	Description
\Zend_Mobile_Push_Exception

setCertificatePassphrase(string $passphrase) : \Zend_Mobile_Push_Apns

Set Certificate Passphrase

Parameters

Name	Type	Description
$passphrase	string

Returns

Type	Description
\Zend_Mobile_Push_Apns

Throws

Exception	Description
\Zend_Mobile_Push_Exception

setOptions(array $options) : \Zend_Mobile_Push_Abstract

inherited

Set Options

Inherited from: \Zend_Mobile_Push_Abstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Mobile_Push_Abstract

Throws

Exception	Description
\Zend_Mobile_Push_Exception

Mobile/Push/Apns.php

\Zend_Mobile_Push_Apnsjump to top

Constants

Properties

Methods

\Zend_Mobile_Push_Apns
jump to top