documentation/manual/en/module_specs/Zend_Feed-ModifyingFeed.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.feed.modifying-feed">
   4     <title>Modifying Feed and Entry structures</title>
   5
   6     <para>
   7         <classname>Zend_Feed</classname>'s natural syntax extends to constructing and modifying
   8         feeds and entries as well as reading them. You can easily turn your new or modified objects
   9         back into well-formed <acronym>XML</acronym> for saving to a file or sending to a server.
  10     </para>
  11
  12     <example id="zend.feed.modifying-feed.example.modifying">
  13         <title>Modifying an Existing Feed Entry</title>
  14
  15         <programlisting language="php"><![CDATA[
  16 $feed = new Zend_Feed_Atom('http://atom.example.com/feed/1');
  17 $entry = $feed->current();
  18
  19 $entry->title = 'This is a new title';
  20 $entry->author->email = 'my_email@example.com';
  21
  22 echo $entry->saveXML();
  23 ]]></programlisting>
  24
  25         <para>
  26             This will output a full (includes <code>&lt;?xml ... &gt;</code> prologue)
  27             <acronym>XML</acronym> representation of the new entry, including any necessary
  28             <acronym>XML</acronym> namespaces.
  29         </para>
  30
  31         <para>
  32             Note that the above will work even if the existing entry does not already have an author
  33             tag. You can use as many levels of <code>-&gt;</code> access as you like before getting
  34             to an assignment; all of the intervening levels will be created for you automatically if
  35             necessary.
  36         </para>
  37     </example>
  38
  39     <para>
  40         If you want to use a namespace other than <code>atom:</code>, <code>rss:</code>, or
  41         <code>osrss:</code> in your entry, you need to register the namespace with
  42         <classname>Zend_Feed</classname> using
  43         <methodname>Zend_Feed::registerNamespace()</methodname>. When you are modifying an existing
  44         element, it will always maintain its original namespace. When adding a new element, it will
  45         go into the default namespace if you do not explicitly specify another namespace.
  46     </para>
  47
  48     <example id="zend.feed.modifying-feed.example.creating">
  49         <title>Creating an Atom Entry with Elements of Custom Namespaces</title>
  50
  51         <programlisting language="php"><![CDATA[
  52 $entry = new Zend_Feed_Entry_Atom();
  53 // id is always assigned by the server in Atom
  54 $entry->title = 'my custom entry';
  55 $entry->author->name = 'Example Author';
  56 $entry->author->email = 'me@example.com';
  57
  58 // Now do the custom part.
  59 Zend_Feed::registerNamespace('myns', 'http://www.example.com/myns/1.0');
  60
  61 $entry->{'myns:myelement_one'} = 'my first custom value';
  62 $entry->{'myns:container_elt'}->part1 = 'first nested custom part';
  63 $entry->{'myns:container_elt'}->part2 = 'second nested custom part';
  64
  65 echo $entry->saveXML();
  66 ]]></programlisting>
  67     </example>
  68 </sect1>
  69 <!--
  70 vim:se ts=4 sw=4 et:
  71 -->