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

Class: Services_Blogging_ExtendedDriver

Source Location: /Services_Blogging-0.2.4/Services/Blogging/ExtendedDriver.php

Class Overview

Services_Blogging_Driver
   |
   --Services_Blogging_ExtendedDriver

A class extended from Services_Blogging that provides additional abstract functions not present in the original class. These methods have been primarily implemented by the metaWeblog API driver.


Author(s):

Methods


Child classes:

Services_Blogging_Driver_MetaWeblog
metaWeblog API implementation.
Services_Blogging_Driver_LiveJournal
LiveJournal API implementation.

Inherited Variables

Inherited Methods

Class: Services_Blogging_Driver

Services_Blogging_Driver::createNewPost()
Creates a new post object and returns that.
Services_Blogging_Driver::deletePost()
Delete a given post
Services_Blogging_Driver::getSupportedPostProperties()
Returns an array of strings thay define the properties that a post to this blog may have.
Services_Blogging_Driver::getSupportedPostTypes()
Returns an array of supported post types. Pass one of them to createNewPost() to instantiate such a post object.
Services_Blogging_Driver::isPostPropertySupported()
Checks if the given property name/id is supported for this driver.
Services_Blogging_Driver::savePost()
Save a new post into the blog.

Class Details

[line 30]
A class extended from Services_Blogging that provides additional abstract functions not present in the original class. These methods have been primarily implemented by the metaWeblog API driver.


[ Top ]


Method Detail

getPost   [line 54]

Services_Blogging_Post getPost( string $id)

The getPost method is intended to retrive a given post as an object of the Services_Blogging_Post class; given the unique post id which is passed as a parameter to the function.
  • Return: The elements of the post returned as an object of the Services_Blogging_Post class.
  • Abstract:
  • Throws: Services_Blogging_Exception If the post does not exist
  • Access: public

Overridden in child classes as:

Services_Blogging_Driver_MetaWeblog::getPost()
The getPost method is intended to retrive a given post as an object of the Services_Blogging_Post class; given the unique post id which is passed as a parameter to the function.
Services_Blogging_Driver_LiveJournal::getPost()
The getPost method is intended to retrieve a given post as an object of the Services_Blogging_Post class; given the unique post id which is passed as a parameter to the function.

Parameters:

string   $id     The PostID of the post to be retrieved. (As returned by newPost() defined in Services_Blogging_driver).

[ Top ]

getRecentPosts   [line 67]

Array getRecentPosts( [int $number = 15])

Returns an array of recent posts as Services_Blogging_Post objects
  • Return: An array of objects of the Services_Blogging_Post class that correspond to the number of posts requested.
  • Abstract:
  • Access: public

Overridden in child classes as:

Services_Blogging_Driver_MetaWeblog::getRecentPosts()
Returns an array of recent posts as Services_Blogging_Post objects
Services_Blogging_Driver_LiveJournal::getRecentPosts()
Returns an array of recent posts as Services_Blogging_Post objects

Parameters:

int   $number     The number of posts to be retrieved. Defaults to 15

[ Top ]

getRecentPostTitles   [line 81]

Array getRecentPostTitles( [int $number = 15])

The getRecentPostTitles method is intended to retrieve the given number of posts titles from a blog.

The posts themselves can be retrieved with getPost() or getRecentPosts().

  • Return: An array of int => strings representing the post ids (key) and their title (value).
  • Abstract:
  • Access: public

Overridden in child classes as:

Services_Blogging_Driver_MetaWeblog::getRecentPostTitles()
The getRecentPostTitles method is intended to retrieve the given number of posts titles from a blog.
Services_Blogging_Driver_LiveJournal::getRecentPostTitles()
The getRecentPostTitles method is intended to retrieve the given number of post titles from a blog.

Parameters:

int   $number     The number of posts to be retrieved.

[ Top ]


Documentation generated on Sat, 10 Dec 2011 15:30:28 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.