Zend Framework: Zend_Service_SlideShare Component Proposal

Proposed Component Name	Zend_Service_SlideShare
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Service_SlideShare
Proposers	John Coggeshall Darby Felton, Zend liaison
Revision	1.0 - 1 November 11 2007: Initial Proposal (wiki revision: 9)

This component will implement the complete SlideShare web service API for working with and adding silde shows to the service
This component will provide an easy to use API which encapsulates the XML communication with the non-standards-based services
This component will use Zend Framework HTTP and Caching facilities as part of its function

4. Dependencies on Other Framework Components

Zend_Exception
Zend_Http_Client
Zend_Cache

5. Theory of Operation

The component will provide a service object which allows you to retrieve slide show metadata from the SlideShare service through
the means exposed by the SlideShare API. This includes querying the existing slide shows by username, tag, group and slide show ID.
The component will also provide the ability to upload new slide shows into the slideshare database through the same API.

6. Milestones / Tasks

Milestone 1: [DONE] Development of Prototype Component
Milestone 2: [DONE] Development of Zend Framework Proposal
Milestone 3: [DONE] Interaction with Community
Milestone 4: Review of proposal
Milestone 5: Formalization of Component to ZF coding standards

7. Class Index

Zend_Service_SlideShare
Zend_Service_SlideShare_SlideShow
ZEnd_Service_SlideShare_Exception

8. Use Cases

UC-01

// Basic usage to retrieve a slideshow
$ss = new Zend_Service_SlideShare($api_key, $shared_secret);
$retval = $ss->getSlideShowsByUsername('coogle');

foreach($retval as $slideShow) {

print $slideShow->getTitle()."<br/>\n";
}

UC-02

// Uploading a new slideshow

$ss = new Zend_Service_SlideShare($api_key, $shared_secret, $username, $password);

$slideShow = new Zend_Service_SlideShare_SlideShow();
$slideShow->setTitle('My Slide Show');
$slideShow->setFilename('/path/to/my.ppt');


$ss->uploadSlideShow($slideShow, $make_srcfile_public_dl);

UC-03

// Find a single slide show

$ss = new Zend_Service_SlideShare($api_key, $shared_secret);
$retval = $ss->getSlideShow($ss_id);

9. Class Skeletons

class Zend_Service_SlideShare_Extension extends Zend_Exception {}

class Zend_Service_SlideShare {

   /* Getter and Setter methods for properties */
   public function __construct($api_key, $shared_secret, $username = null, $password = null);

   /**
    * @returns boolean
    */
   public function uploadSlideShow(Zend_Service_SlideShare_SlideShow $show, $make_src_public = true);

   /**
    * @returns Zend_Service_SlideShare_SlideShow
    */
   public function getSlideShow($ss_id);

   /**
    * @returns Array of Zend_Service_SlideShare_SlideShow instances
    */
   public function getSlideShowsByUsername($username, $offset = null, $limit = null);

   /**
    * @returns Array of Zend_Service_SlideShare_SlideShow instances
    */
   public function getSlideShowsByTag($tag, $offset = null, $limit = null);

   /**
    * @returns Array of Zend_Service_SlideShare_SlideShow instances
    */
   public function getSlideShowsByGroup($group, $offset = null, $limit = null);

}

class Zend_Service_SlideShare_SlideShow {

     /* Getter and setter methods for metadata */
}

Page Operations

Browse Space

Zend_Service_SlideShare

Labels

Zend Framework: Zend_Service_SlideShare Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria