API Documentation

Zend/Gdata/App/Entry.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
App  
Version
$Id: Entry.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_App_Entry

Package: Zend\Gdata\App

Concrete class for working with Atom entries.

Parent(s)
\Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Children
\Zend_Gdata_App_MediaEntry
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Gdata_App_Extension_Content  $_content= 'null'

atom:content element

Default valuenullDetails
Type
\Zend_Gdata_App_Extension_Content
Propertyprotected\Zend_Gdata_App_Extension_Control  $_control= 'null'

app:control element

Default valuenullDetails
Type
\Zend_Gdata_App_Extension_Control
Propertyprotected\Zend_Gdata_App_Extension_Edited  $_edited= 'null'

app:edited element

Default valuenullDetails
Type
\Zend_Gdata_App_Extension_Edited
Propertyprotectedstring  $_entryClassName= ''Zend_Gdata_App_Entry''

Class name for each entry in this feed*

Default value'Zend_Gdata_App_Entry'Details
Type
string
Propertyprotected\Zend_Gdata_App_Extension_Published  $_published= 'null'

atom:published element

Default valuenullDetails
Type
\Zend_Gdata_App_Extension_Published
Propertyprotectedstring  $_rootElement= ''entry''

Root XML element for Atom entries.

Default value'entry'Details
Type
string
Propertyprotected\Zend_Gdata_App_Extension_Source  $_source= 'null'

atom:source element

Default valuenullDetails
Type
\Zend_Gdata_App_Extension_Source
Propertyprotected\Zend_Gdata_App_Extension_Summary  $_summary= 'null'

atom:summary element

Default valuenullDetails
Type
\Zend_Gdata_App_Extension_Summary

Methods

methodpublicdelete( ) : 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.

Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicgetContent( ) : \Zend_Gdata_App_Extension_Content

Gets the value of the atom:content element

Returns
Type Description
\Zend_Gdata_App_Extension_Content
methodpublicgetControl( ) : \Zend_Gdata_App_Extension_Control

Gets the value of the app:control element

Returns
Type Description
\Zend_Gdata_App_Extension_Control
methodpublicgetDOM(  $doc = null,  $majorVersion = 1,  $minorVersion = null ) : void

Parameters
Name Type Description
$doc
$majorVersion
$minorVersion
methodpublicgetPublished( ) : \Zend_Gdata_App_Extension_Published

Sets the value of the atom:published element This represents the publishing date for an entry

Returns
Type Description
\Zend_Gdata_App_Extension_Published
methodpublicgetSource( ) : \Zend_Gdata_App_Extension_Source

Gets the value of the atom:source element

Returns
Type Description
\Zend_Gdata_App_Extension_Source
methodpublicgetSummary( ) : \Zend_Gdata_App_Extension_Summary

Gets the value of the atom:summary element This represents a textual summary of this entry's content

Returns
Type Description
\Zend_Gdata_App_Extension_Summary
methodpublicreload( string|null $uri = null, string|null $className = null, array $extraHeaders = array() ) : mixed

Reload the current entry. Returns a new copy of the entry as returned by the server, or null if no changes exist. This does not modify the current entry instance.

Parameters
Name Type Description
$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
mixed A new instance of the current entry with updated data, or null if the server reports that no changes have been made.
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicsave( 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
$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
methodpublicsetContent( \Zend_Gdata_App_Extension_Content $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:content element

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Content
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetControl( \Zend_Gdata_App_Extension_Control $value ) : \Zend_Gdata_App_Entry

Sets the value of the app:control element

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Control
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetPublished( \Zend_Gdata_App_Extension_Published $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:published element This represents the publishing date for an entry

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Published
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetSource( \Zend_Gdata_App_Extension_Source $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:source element

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Source
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetSummary( \Zend_Gdata_App_Extension_Summary $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:summary element This represents a textual summary of this entry's content

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Summary
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodprotectedtakeChildFromDOM(  $child ) : void

Parameters
Name Type Description
$child
Documentation was generated by DocBlox 0.15.1.