API Documentation

Zend/Gdata/Gbase.php

Show: inherited
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 license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gbase  
Version
$Id: Gbase.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Gbase

Package: Zend\Gdata\Gbase

Service class for interacting with the Google Base data API

Parent(s)
\Zend_Gdata < \Zend_Gdata_App
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Link
http://code.google.com/apis/base  

Constants

Constant  GBASE_ITEM_FEED_URI = 'https://www.google.com/base/feeds/items'

Path to the customer items feeds on the Google Base server.

Constant  GBASE_SNIPPET_FEED_URI = 'https://www.google.com/base/feeds/snippets'

Path to the snippets feeds on the Google Base server.

Constant  AUTH_SERVICE_NAME = 'gbase'

Authentication service name for Google Base

Properties

Propertyprotectedstring  $_defaultPostUri= 'self::GBASE_ITEM_FEED_URI'

The default URI for POST methods

Default valueself::GBASE_ITEM_FEED_URIDetails
Type
string
Propertypublicarray  $namespaces= 'array( array('g''
static

Namespaces used for Zend_Gdata_Gbase

Default valuearray( array('g'Details
Type
array

Methods

methodpublic__construct( \Zend_Http_Client $client = null, string $applicationId = 'MyCompany-MyApp-1.0' ) : void

Create Zend_Gdata_Gbase object

Parameters
Name Type Description
$client \Zend_Http_Client

(optional) The HTTP client to use when when communicating with the Google Apps servers.

$applicationId string

The identity of the app in the form of Company-AppName-Version

methodpublicdeleteGbaseItem( \Zend_Gdata_Gbase_ItemEntry $entry, boolean $dryRun = false ) : \Zend_Gdata_Gbase_ItemFeed

Delete an entry

Parameters
Name Type Description
$entry \Zend_Gdata_Gbase_ItemEntry

The Base entry to remove

$dryRun boolean

Flag for the 'dry-run' parameter

Returns
Type Description
\Zend_Gdata_Gbase_ItemFeed
methodpublicgetGbaseItemEntry( mixed $location = null ) : \Zend_Gdata_Gbase_ItemEntry

Retreive entry object

Parameters
Name Type Description
$location mixed

The location for the feed, as a URL or Query

Returns
Type Description
\Zend_Gdata_Gbase_ItemEntry
methodpublicgetGbaseItemFeed( mixed $location = null ) : \Zend_Gdata_Gbase_ItemFeed

Retreive feed object

Parameters
Name Type Description
$location mixed

The location for the feed, as a URL or Query

Returns
Type Description
\Zend_Gdata_Gbase_ItemFeed
methodpublicgetGbaseSnippetFeed( mixed $location = null ) : \Zend_Gdata_Gbase_SnippetFeed

Retrieve feed object

Parameters
Name Type Description
$location mixed

The location for the feed, as a URL or Query

Returns
Type Description
\Zend_Gdata_Gbase_SnippetFeed
methodpublicinsertGbaseItem( \Zend_Gdata_Gbase_ItemEntry $entry, boolean $dryRun = false ) : \Zend_Gdata_Gbase_ItemFeed

Insert an entry

Parameters
Name Type Description
$entry \Zend_Gdata_Gbase_ItemEntry

The Base entry to upload

$dryRun boolean

Flag for the 'dry-run' parameter

Returns
Type Description
\Zend_Gdata_Gbase_ItemFeed
methodpublicupdateGbaseItem( \Zend_Gdata_Gbase_ItemEntry $entry, boolean $dryRun = false ) : \Zend_Gdata_Gbase_ItemEntry

Update an entry

Parameters
Name Type Description
$entry \Zend_Gdata_Gbase_ItemEntry

The Base entry to be updated

$dryRun boolean

Flag for the 'dry-run' parameter

Returns
Type Description
\Zend_Gdata_Gbase_ItemEntry
Documentation was generated by DocBlox 0.15.1.