Services_Blogging
[ class tree: Services_Blogging ] [ index: Services_Blogging ] [ all elements ]

Source for file ExtendedDriver.php

Documentation is available at ExtendedDriver.php

  1. <?php
  2. require_once 'Services/Blogging/Driver.php';
  3.  
  4. /**
  5. *   A class extended from Services_Blogging that provides additional abstract
  6. *   functions not present in the original class. These methods have been
  7. *   primarily implemented by the metaWeblog API driver.
  8. *
  9. *   @category    Services
  10. *   @package     Services_Blogging
  11. *   @author      Anant Narayanan <anant@php.net>
  12. *   @author      Christian Weiske <cweiske@php.net>
  13. *   @license     http://www.gnu.org/copyleft/lesser.html  LGPL License 2.1
  14. */
  15. {
  16.  
  17.     /**
  18.     *   Error code: Username or password doesn't exist/are wrong
  19.     */
  20.     const ERROR_POSTDOESNTEXIST = 103;
  21.  
  22.  
  23.  
  24.     /**
  25.     *   The getPost method is intended to retrive a given post as an object of
  26.     *   the Services_Blogging_Post class; given the unique post id which is passed
  27.     *   as a parameter to the function.
  28.     *
  29.     *   @param   string  $id         The PostID of the post to be retrieved. (As
  30.     *                                 returned by newPost() defined in
  31.     *                                 Services_Blogging_driver).
  32.     *   @return  Services_Blogging_Post   The elements of the post returned as an
  33.     *                                      object of the Services_Blogging_Post class.
  34.     *
  35.     *   @throws Services_Blogging_Exception  If the post does not exist
  36.     */
  37.     abstract public function getPost($id);
  38.  
  39.  
  40.  
  41.     /**
  42.     *   Returns an array of recent posts as Services_Blogging_Post objects
  43.     *
  44.     *   @param   int     $number     The number of posts to be retrieved.
  45.     *                                    Defaults to 15
  46.     *
  47.     *   @return  Array   An array of objects of the Services_Blogging_Post class that
  48.     *                   correspond to the number of posts requested.
  49.     */
  50.     abstract public function getRecentPosts($number = 15);
  51.  
  52.  
  53.  
  54.     /**
  55.     *   The getRecentPostTitles method is intended to retrieve the given number of
  56.     *   posts titles from a blog.
  57.     *   The posts themselves can be retrieved with getPost() or getRecentPosts().
  58.     *
  59.     *   @param   int     $number     The number of posts to be retrieved.
  60.     *
  61.     *   @return  Array   An array of int => strings representing the
  62.     *                    post ids (key) and their title (value).
  63.     */
  64.     abstract public function getRecentPostTitles($number = 15);
  65.  
  66.  
  67. }//abstract class Services_Blogging_ExtendedDriver extends Services_Blogging_Driver
  68. ?>

Documentation generated on Mon, 11 Mar 2019 14:57:58 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.