Procházet zdrojové kódy

Updated docs for ZFR and ZFW image support

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22104 44c647ce-9c0f-0410-b52a-842ac1e357ba
padraic před 15 roky
rodič
revize
7d839ca9c6

+ 11 - 0
documentation/manual/en/module_specs/Zend_Feed_Reader.xml

@@ -702,6 +702,17 @@ $labels = $categories->getValues();
                             of "scheme", set to <constant>NULL</constant>.
                         </entry>
                     </row>
+
+                    <row>
+                        <entry><methodname>getImage()</methodname></entry>
+
+                        <entry>
+                            Returns an array containing data relating to any feed image or logo,
+                            or NULL if no image found. The resulting array may contain the following
+                            keys: uri, link, title, description, height, and width. Atom logos only
+                            contain a URI so the remaining metadata is drawn from RSS feeds only.
+                        </entry>
+                    </row>
                 </tbody>
             </tgroup>
         </table>

+ 14 - 1
documentation/manual/en/module_specs/Zend_Feed_Writer.xml

@@ -418,6 +418,18 @@ $out = $feed->export('atom');
                     </row>
 
                     <row>
+                        <entry><methodname>setImage()</methodname></entry>
+                        <entry>
+                            Accepts an array of image metadata for an RSS image or Atom logo. Atom 1.0
+                            only requires a URI. RSS 2.0 requires a URI, HTML link, and an image title.
+                            RSS 2.0 optionally may send a width, height and image description. The array
+                            parameter may contain these using the keys: uri, link, title, description,
+                            height and width. The RSS 2.0 HTML link should point to the feed source's
+                            HTML page.
+                        </entry>
+                    </row>
+
+                    <row>
                         <entry><methodname>createEntry()</methodname></entry>
                         <entry>Returns a new instance of <classname>Zend_Feed_Writer_Entry
                         </classname>. This is the Entry level data container. New entries
@@ -470,7 +482,8 @@ $out = $feed->export('atom');
         <note>
             <para>
                 In addition to these setters, there are also matching getters to retrieve data from
-                the Entry data container.
+                the Entry data container. For example, <methodname>setImage()</methodname> is matched
+                with a <methodname>getImage()</methodname> method.
             </para>
         </note>