Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Gdata_App_Entry Class Reference

Public Member Functions

 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
 save ($uri=null, $className=null, $extraHeaders=array())
 Uploads changes in this entry to the server using Zend_Gdata_App.
 
 delete ()
 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.
 
 reload ($uri=null, $className=null, $extraHeaders=array())
 Reload the current entry.
 
 getContent ()
 Gets the value of the atom:content element.
 
 setContent ($value)
 Sets the value of the atom:content element.
 
 getPublished ()
 Sets the value of the atom:published element This represents the publishing date for an entry.
 
 setPublished ($value)
 Sets the value of the atom:published element This represents the publishing date for an entry.
 
 getSource ()
 Gets the value of the atom:source element.
 
 setSource ($value)
 Sets the value of the atom:source element.
 
 getSummary ()
 Gets the value of the atom:summary element This represents a textual summary of this entry's content.
 
 setSummary ($value)
 Sets the value of the atom:summary element This represents a textual summary of this entry's content.
 
 getControl ()
 Gets the value of the app:control element.
 
 setControl ($value)
 Sets the value of the app:control element.
 
- Public Member Functions inherited from Zend_Gdata_App_FeedEntryParent
 __construct ($element=null)
 Constructs a Feed or Entry.
 
 setHttpClient (Zend_Http_Client $httpClient)
 Set the HTTP client instance.
 
 getHttpClient ()
 Gets the HTTP client object.
 
 setService ($instance)
 Set the active service instance for this object.
 
 getService ()
 Get the active service instance for this object.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
 getAuthor ()
 
 setAuthor ($value)
 Sets the list of the authors of this feed/entry.
 
 getCategory ()
 Returns the array of categories that classify this feed/entry.
 
 setCategory ($value)
 Sets the array of categories that classify this feed/entry.
 
 getContributor ()
 Returns the array of contributors to this feed/entry.
 
 setContributor ($value)
 Sets the array of contributors to this feed/entry.
 
 getId ()
 
 setId ($value)
 
 getLink ($rel=null)
 Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element.
 
 getEditLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource.
 
 getNextLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the next chunk of results when paging through a feed.
 
 getPreviousLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the previous chunk of results when paging through a feed.
 
 getLicenseLink ()
 
 getSelfLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the entry or feed represented by this object This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.
 
 getAlternateLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL for an alternate view of the data represented by this feed or entry.
 
 setLink ($value)
 
 getRights ()
 
 setRights ($value)
 
 getTitle ()
 Returns the title of this feed or entry.
 
 getTitleValue ()
 Returns a string representation of the title of this feed or entry.
 
 setTitle ($value)
 Returns the title of this feed or entry.
 
 getUpdated ()
 
 setUpdated ($value)
 
 setEtag ($value)
 Set the Etag for the current entry to $value.
 
 getEtag ()
 Return the Etag for the current entry, or null if not set.
 
 setMajorProtocolVersion ($value)
 Set the major protocol version that should be used.
 
 getMajorProtocolVersion ()
 Get the major protocol version that is in use.
 
 setMinorProtocolVersion ($value)
 Set the minor protocol version that should be used.
 
 getMinorProtocolVersion ()
 Get the minor protocol version that is in use.
 
 lookupNamespace ($prefix, $majorVersion=null, $minorVersion=null)
 Get the full version of a namespace prefix.
 
- Public Member Functions inherited from Zend_Gdata_App_Base
 __construct ()
 
 getText ($trim=true)
 Returns the child text node of this element This represents any raw text contained within the XML element.
 
 setText ($value)
 Sets the child text node of this element This represents any raw text contained within the XML element.
 
 getExtensionElements ()
 Returns an array of all elements not matched to data model classes during the parsing of the XML.
 
 setExtensionElements ($value)
 Sets an array of all elements not matched to data model classes during the parsing of the XML.
 
 getExtensionAttributes ()
 Returns an array of all extension attributes not transformed into data model properties during parsing of the XML.
 
 setExtensionAttributes ($value)
 Sets an array of all extension attributes not transformed into data model properties during parsing of the XML.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 transferFromDOM ($node)
 Transfers each child and attribute into member variables.
 
 transferFromXML ($xml)
 Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element).
 
 saveXML ()
 Converts this element and all children into XML text using getDOM()
 
 getXML ()
 Alias for saveXML() returns XML content for this element and all children.
 
 encode ()
 Alias for saveXML()
 
 lookupNamespace ($prefix, $majorVersion=1, $minorVersion=null)
 Get the full version of a namespace prefix.
 
 registerNamespace ($prefix, $namespaceUri, $majorVersion=1, $minorVersion=0)
 Add a namespace and prefix to the registered list.
 
 registerAllNamespaces ($namespaceArray)
 Add an array of namespaces to the registered list.
 
 __get ($name)
 Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.
 
 __set ($name, $val)
 Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.
 
 __isset ($name)
 Magic __isset method.
 
 __unset ($name)
 Magic __unset method.
 
 __toString ()
 Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0.
 

Protected Member Functions

 takeChildFromDOM ($child)
 
- Protected Member Functions inherited from Zend_Gdata_App_FeedEntryParent
 takeChildFromDOM ($child)
 
- Protected Member Functions inherited from Zend_Gdata_App_Base
 takeChildFromDOM ($child)
 Given a child DOMNode, tries to determine how to map the data into object instance members.
 
 takeAttributeFromDOM ($attribute)
 Given a DOMNode representing an attribute, tries to map the data into instance members.
 

Protected Attributes

 $_rootElement = 'entry'
 
 $_entryClassName = 'Zend_Gdata_App_Entry'
 
 $_content = null
 
 $_published = null
 
 $_source = null
 
 $_summary = null
 
 $_control = null
 
 $_edited = null
 
- Protected Attributes inherited from Zend_Gdata_App_FeedEntryParent
 $_service = null
 Service instance used to make network requests.
 
 $_etag = NULL
 
 $_author = array()
 
 $_category = array()
 
 $_contributor = array()
 
 $_id = null
 
 $_link = array()
 
 $_rights = null
 
 $_title = null
 
 $_updated = null
 
 $_majorProtocolVersion = 1
 Indicates the major protocol version that should be used.
 
 $_minorProtocolVersion = null
 Indicates the minor protocol version that should be used.
 
- Protected Attributes inherited from Zend_Gdata_App_Base
 $_rootElement = null
 
 $_rootNamespace = 'atom'
 
 $_rootNamespaceURI = null
 
 $_extensionElements = array()
 
 $_extensionAttributes = array()
 
 $_text = null
 
 $_namespaces
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Gdata_App_Base
static flushNamespaceLookupCache ()
 Flush namespace lookup cache.
 
- Static Protected Attributes inherited from Zend_Gdata_App_Base
static $_namespaceLookupCache = array()
 

Member Function Documentation

delete ( )

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.

Returns
void
Exceptions
Zend_Gdata_App_Exception
getContent ( )

Gets the value of the atom:content element.

Returns
Zend_Gdata_App_Extension_Content
getControl ( )

Gets the value of the app:control element.

Returns
Zend_Gdata_App_Extension_Control
getDOM (   $doc = null,
  $majorVersion = 1,
  $minorVersion = null 
)
getPublished ( )

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

Returns
Zend_Gdata_App_Extension_Published
getSource ( )

Gets the value of the atom:source element.

Returns
Zend_Gdata_App_Extension_Source
getSummary ( )

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

Returns
Zend_Gdata_App_Extension_Summary
reload (   $uri = null,
  $className = null,
  $extraHeaders = array() 
)

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
string|nullThe URI to send requests to, or null if $data contains the URI.
string|nullThe name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.
array$extraHeadersExtra headers to add to the request, as an array of string-based key/value pairs.
Returns
mixed A new instance of the current entry with updated data, or null if the server reports that no changes have been made.
Exceptions
Zend_Gdata_App_Exception
save (   $uri = null,
  $className = null,
  $extraHeaders = array() 
)

Uploads changes in this entry to the server using Zend_Gdata_App.

Parameters
string | null$uriThe URI to send requests to, or null if $data contains the URI.
string | null$classNameThe name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.
array$extraHeadersExtra headers to add to the request, as an array of string-based key/value pairs.
Returns
Zend_Gdata_App_Entry The updated entry.
Exceptions
Zend_Gdata_App_Exception
setContent (   $value)

Sets the value of the atom:content element.

Parameters
Zend_Gdata_App_Extension_Content$value
Returns
Zend_Gdata_App_Entry Provides a fluent interface
setControl (   $value)

Sets the value of the app:control element.

Parameters
Zend_Gdata_App_Extension_Control$value
Returns
Zend_Gdata_App_Entry Provides a fluent interface
setPublished (   $value)

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

Parameters
Zend_Gdata_App_Extension_Published$value
Returns
Zend_Gdata_App_Entry Provides a fluent interface
setSource (   $value)

Sets the value of the atom:source element.

Parameters
Zend_Gdata_App_Extension_Source$value
Returns
Zend_Gdata_App_Entry Provides a fluent interface
setSummary (   $value)

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

Parameters
Zend_Gdata_App_Extension_Summary$value
Returns
Zend_Gdata_App_Entry Provides a fluent interface
takeChildFromDOM (   $child)
protected

Member Data Documentation

$_content = null
protected
$_control = null
protected
$_edited = null
protected
$_entryClassName = 'Zend_Gdata_App_Entry'
protected
$_published = null
protected
$_rootElement = 'entry'
protected
$_source = null
protected
$_summary = null
protected