Gdata/App/Entry.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: App
version: $Id: Entry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_App_Entry

Description

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.

Zend_Gdata_App_Entry
jump to top

Extends from: Zend_Gdata_App_FeedEntryParent
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: App
Properties: $_rootElement; $_entryClassName; $_content; $_published; $_source; $_summary; $_control; $_edited
Methods: getDOM; takeChildFromDOM; save; delete; reload; getContent; setContent; getPublished; setPublished; getSource; setSource; getSummary; setSummary; getControl; setControl

Description

Concrete class for working with Atom entries.

Properties

$_content
jump to class

Zend_Gdata_App_Extension_Content $_content = 'null'

atom:content element

Details

$_content: Zend_Gdata_App_Extension_Content
visibility: protected
default: null
final: false
static: false

$_control
jump to class

Zend_Gdata_App_Extension_Control $_control = 'null'

app:control element

Details

$_control: Zend_Gdata_App_Extension_Control
visibility: protected
default: null
final: false
static: false

$_edited
jump to class

Zend_Gdata_App_Extension_Edited $_edited = 'null'

app:edited element

Details

$_edited: Zend_Gdata_App_Extension_Edited
visibility: protected
default: null
final: false
static: false

$_entryClassName
jump to class

string $_entryClassName = 'Zend_Gdata_App_Entry'

Class name for each entry in this feed*

Details

$_entryClassName: string
visibility: protected
default: Zend_Gdata_App_Entry
final: false
static: false

$_published
jump to class

Zend_Gdata_App_Extension_Published $_published = 'null'

atom:published element

Details

$_published: Zend_Gdata_App_Extension_Published
visibility: protected
default: null
final: false
static: false

$_rootElement
jump to class

string $_rootElement = 'entry'

Root XML element for Atom entries.

Details

$_rootElement: string
visibility: protected
default: entry
final: false
static: false

$_source
jump to class

Zend_Gdata_App_Extension_Source $_source = 'null'

atom:source element

Details

$_source: Zend_Gdata_App_Extension_Source
visibility: protected
default: null
final: false
static: false

$_summary
jump to class

Zend_Gdata_App_Extension_Summary $_summary = 'null'

atom:summary element

Details

$_summary: Zend_Gdata_App_Extension_Summary
visibility: protected
default: null
final: false
static: false

Methods

delete
jump to class

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

Details

visibility: public
final: false
static: false
throws

getContent
jump to class

getContent(
          
          )
        
        :
        Zend_Gdata_App_Extension_Content

Gets the value of the atom:content element

Output

Zend_Gdata_App_Extension_Content

Details

visibility: public
final: false
static: false

getControl
jump to class

getControl(
          
          )
        
        :
        Zend_Gdata_App_Extension_Control

Gets the value of the app:control element

Output

Zend_Gdata_App_Extension_Control

Details

visibility: public
final: false
static: false

getDOM
jump to class

getDOM(
           $doc
              =
              null,  $majorVersion
              =
              1,  $minorVersion
              =
              null
          )
        
        :

Arguments

$doc
$majorVersion
$minorVersion

Details

visibility: public
final: false
static: false

getPublished
jump to class

getPublished(
          
          )
        
        :
        Zend_Gdata_App_Extension_Published

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

Output

Zend_Gdata_App_Extension_Published

Details

visibility: public
final: false
static: false

getSource
jump to class

getSource(
          
          )
        
        :
        Zend_Gdata_App_Extension_Source

Gets the value of the atom:source element

Output

Zend_Gdata_App_Extension_Source

Details

visibility: public
final: false
static: false

getSummary
jump to class

getSummary(
          
          )
        
        :
        Zend_Gdata_App_Extension_Summary

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

Output

Zend_Gdata_App_Extension_Summary

Details

visibility: public
final: false
static: false

reload
jump to class

reload(
          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.

Arguments

$uri: stringnull
The URI to send requests to, or null if $data contains the URI.
$className: stringnull
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.

Output

mixed: A new instance of the current entry with updated data, or null if the server reports that no changes have been made.

Details

visibility: public
final: false
static: false
throws

save
jump to class

save(
          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

Arguments

$uri: stringnull
The URI to send requests to, or null if $data contains the URI.
$className: stringnull
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.

Output

Zend_Gdata_App_Entry: The updated entry.

Details

visibility: public
final: false
static: false
throws

setContent
jump to class

setContent(
          Zend_Gdata_App_Extension_Content $value
          )
        
        :
        Zend_Gdata_App_Entry

Sets the value of the atom:content element

Arguments

$value: Zend_Gdata_App_Extension_Content

Output

Zend_Gdata_App_Entry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setControl
jump to class

setControl(
          Zend_Gdata_App_Extension_Control $value
          )
        
        :
        Zend_Gdata_App_Entry

Sets the value of the app:control element

Arguments

$value: Zend_Gdata_App_Extension_Control

Output

Zend_Gdata_App_Entry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setPublished
jump to class

setPublished(
          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

Arguments

$value: Zend_Gdata_App_Extension_Published

Output

Zend_Gdata_App_Entry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setSource
jump to class

setSource(
          Zend_Gdata_App_Extension_Source $value
          )
        
        :
        Zend_Gdata_App_Entry

Sets the value of the atom:source element

Arguments

$value: Zend_Gdata_App_Extension_Source

Output

Zend_Gdata_App_Entry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setSummary
jump to class

setSummary(
          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

Arguments

$value: Zend_Gdata_App_Extension_Summary

Output

Zend_Gdata_App_Entry: Provides a fluent interface

Details

visibility: public
final: false
static: false

takeChildFromDOM
jump to class

takeChildFromDOM(
           $child
          )
        
        :

Arguments

$child

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/App/Entry.php

Description

Zend_Gdata_App_Entryjump to top

Description

Properties

$_contentjump to class

Details

$_controljump to class

Details

$_editedjump to class

Details

$_entryClassNamejump to class

Details

$_publishedjump to class

Details

$_rootElementjump to class

Details

$_sourcejump to class

Details

$_summaryjump to class

Details

Methods

deletejump to class

Details

getContentjump to class

Output

Details

getControljump to class

Output

Details

getDOMjump to class

Arguments

Details

getPublishedjump to class

Output

Details

getSourcejump to class

Output

Details

getSummaryjump to class

Output

Details

reloadjump to class

Arguments

Output

Details

savejump to class

Arguments

Output

Details

setContentjump to class

Arguments

Output

Details

setControljump to class

Arguments

Output

Details

setPublishedjump to class

Arguments

Output

Details

setSourcejump to class

Arguments

Output

Details

setSummaryjump to class

Arguments

Output

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_App_Entry
jump to top

$_content
jump to class

$_control
jump to class

$_edited
jump to class

$_entryClassName
jump to class

$_published
jump to class

$_rootElement
jump to class

$_source
jump to class

$_summary
jump to class

delete
jump to class

getContent
jump to class

getControl
jump to class

getDOM
jump to class

getPublished
jump to class

getSource
jump to class

getSummary
jump to class

reload
jump to class

save
jump to class

setContent
jump to class

setControl
jump to class

setPublished
jump to class

setSource
jump to class

setSummary
jump to class

takeChildFromDOM
jump to class