API Documentation

Zend/Gdata/Gbase/ItemEntry.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: ItemEntry.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Gbase_ItemEntry

Package: Zend\Gdata\Gbase

Concrete class for working with Item entries.

Parent(s)
\Zend_Gdata_Gbase_Entry < \Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
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/  

Properties

Propertyprotectedstring  $_entryClassName= ''Zend_Gdata_Gbase_ItemEntry''

The classname for individual item entry elements.

Default value'Zend_Gdata_Gbase_ItemEntry'Details
Type
string

Methods

methodpublicaddGbaseAttribute( string $name,  $text, string $type = null ) : \Zend_Gdata_Gbase_ItemEntry

Adds a custom attribute to the entry in the following format: <g:[$name] type='[$type]'>[$value]</g:[$name]>

Parameters
Name Type Description
$name string

The name of the attribute

$text
$type string

(optional) The type of the attribute. e.g.: 'text', 'number', 'floatUnit'

Returns
Type Description
\Zend_Gdata_Gbase_ItemEntry Provides a fluent interface
methodpublicdelete(  $dryRun = false ) : void

Deletes this entry to the server using the referenced Zend_Http_Client to do a HTTP DELETE to the edit link stored in this entry's link collection.

Parameters
Name Type Description
$dryRun
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicremoveGbaseAttribute( \Zend_Gdata_Gbase_Extension_BaseAttribute $baseAttribute ) : \Zend_Gdata_Gbase_ItemEntry

Removes a Base attribute from the current list of Base attributes

Parameters
Name Type Description
$baseAttribute \Zend_Gdata_Gbase_Extension_BaseAttribute

The attribute to be removed

Returns
Type Description
\Zend_Gdata_Gbase_ItemEntry Provides a fluent interface
methodpublicsave( boolean $dryRun = false, string|null $uri = null, string|null $className = null, array $extraHeaders = array() ) : \Zend_Gdata_App_Entry

Uploads changes in this entry to the server using Zend_Gdata_App

Parameters
Name Type Description
$dryRun boolean

Whether the transaction is dry run or not.

$uri string|null

The URI to send requests to, or null if $data contains the URI.

$className string|null

The name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeaders array

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
Type Description
\Zend_Gdata_App_Entry The updated entry
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicsetItemType( \Zend_Gdata_Gbase_Extension_ItemType $value ) : \Zend_Gdata_Gbase_ItemEntry

Set the value of the itme_type

Parameters
Name Type Description
$value \Zend_Gdata_Gbase_Extension_ItemType

The desired value for the item_type

Returns
Type Description
\Zend_Gdata_Gbase_ItemEntry Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.