Zend/Gdata/Contacts.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37
  38
  39 /**
  40  * @see Zend_Gdata
  41  */
  42 require_once 'Zend/Gdata.php';
  43
  44 /**
  45  * @see Zend_Gdata_Books_VolumeFeed
  46  */
  47 require_once 'Zend/Gdata/Contacts/ListFeed.php';
  48
  49 /**
  50  * @see Zend_Gdata_Docs_DocumentListEntry
  51  */
  52 require_once 'Zend/Gdata/Contacts/ListEntry.php';
  53
  54
  55 /**
  56  * Service class for interacting with the Google Contacts data API
  57  */
  58 class Zend_Gdata_Contacts extends Zend_Gdata
  59 {
  60
  61     const CONTACT_FEED_URI = 'https://www.google.com/m8/feeds/contacts/default/full';
  62     const AUTH_SERVICE_NAME = 'cp';
  63     const DEFAULT_MAJOR_PROTOCOL_VERSION = 3;
  64
  65     protected $maxResults = 10;
  66     protected $startIndex = 1;
  67     /**
  68      * Namespaces used for Zend_Gdata_Calendar
  69      *
  70      * @var array
  71      */
  72     public static $namespaces = array(
  73         array('gContact', 'http://schemas.google.com/contact/2008', 1, 0),
  74     );
  75
  76     /**
  77      * Create Gdata_Calendar object
  78      *
  79      * @param Zend_Http_Client $client (optional) The HTTP client to use when
  80      *          when communicating with the Google servers.
  81      * @param string $applicationId The identity of the app in the form of Company-AppName-Version
  82      */
  83     public function __construct($client = null, $applicationId = 'MyCompany-MyApp-1.0')
  84     {
  85         $this->registerPackage('Zend_Gdata_Contacts');
  86         $this->registerPackage('Zend_Gdata_Contacts_Extension');
  87         parent::__construct($client, $applicationId);
  88         $this->_httpClient->setParameterPost('service', self::AUTH_SERVICE_NAME);
  89         $this->setMajorProtocolVersion(self::DEFAULT_MAJOR_PROTOCOL_VERSION);
  90     }
  91
  92     /**
  93      * Retrieve feed object
  94      *
  95      * @return Zend_Gdata_Calendar_ListFeed
  96      */
  97     public function getContactListFeed()
  98     {
  99         $query = new Zend_Gdata_Query(self::CONTACT_FEED_URI);
 100         $query->maxResults = $this->maxResults;
 101         $query->startIndex = $this->startIndex;
 102         return parent::getFeed($query,'Zend_Gdata_Contacts_ListFeed');
 103     }
 104
 105     /**
 106      * Retrieve a single feed object by id
 107      *
 108      * @param string $entryID
 109      * @return string|Zend_Gdata_App_Feed
 110      */
 111     public function getContactEntry($entryID)
 112     {
 113         return parent::getEntry($entryID,'Zend_Gdata_Contacts_ListEntry');
 114     }
 115
 116     /**
 117      * Set the max results that the feed should return.
 118      *
 119      * @param  $maxResults
 120      * @return void
 121      */
 122     public function setMaxResults($maxResults)
 123     {
 124         $this->maxResults = $maxResults;
 125     }
 126
 127     /**
 128      * Set the start index.
 129      *
 130      * @param  $value
 131      * @return void
 132      */
 133     public function setStartIndex($value)
 134     {
 135         $this->startIndex = $value;
 136     }
 137
 138 }
 139