API Documentation

Service/SlideShare.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
SlideShare
version
$Id: SlideShare.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Service_SlideShare

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Service_SlideShare
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Service
subpackage
SlideShare
throws
Constants
SERVICE_ERROR_BAD_APIKEY
SERVICE_ERROR_BAD_AUTH
SERVICE_ERROR_MISSING_TITLE
SERVICE_ERROR_MISSING_FILE
SERVICE_ERROR_EMPTY_TITLE
SERVICE_ERROR_NOT_SOURCEOBJ
SERVICE_ERROR_INVALID_EXT
SERVICE_ERROR_FILE_TOO_BIG
SERVICE_ERROR_SHOW_NOT_FOUND
SERVICE_ERROR_USER_NOT_FOUND
SERVICE_ERROR_GROUP_NOT_FOUND
SERVICE_ERROR_MISSING_TAG
SERVICE_ERROR_DAILY_LIMIT
SERVICE_ERROR_ACCOUNT_BLOCKED
SERVICE_UPLOAD_URI
SERVICE_GET_SHOW_URI
SERVICE_GET_SHOW_BY_USER_URI
SERVICE_GET_SHOW_BY_TAG_URI
SERVICE_GET_SHOW_BY_GROUP_URI
POWERPOINT_MIME_TYPE
Properties
$_apiKey
$_sharedSecret
$_username
$_password
$_httpclient
$_cacheobject
Methods
setHttpClient
getHttpClient
setCacheObject
getCacheObject
getUserName
setUserName
getPassword
setPassword
getApiKey
setApiKey
getSharedSecret
setSharedSecret
__construct
uploadSlideShow
getSlideShow
getSlideShowsByUsername
getSlideShowsByTag
getSlideShowsByGroup
_getSlideShowsByType
_slideShowNodeToObject

Description

The Zend_Service_SlideShare component is used to interface with the slideshare.net web server to retrieve slide shows hosted on the web site for display or other processing.

Constants

SERVICE_ERROR_BAD_APIKEY
jump to class

 SERVICE_ERROR_BAD_APIKEY = '1'

Web service result code mapping

Details

value
1

SERVICE_ERROR_BAD_AUTH
jump to class

 SERVICE_ERROR_BAD_AUTH = '2'

Details

value
2

SERVICE_ERROR_MISSING_TITLE
jump to class

 SERVICE_ERROR_MISSING_TITLE = '3'

Details

value
3

SERVICE_ERROR_MISSING_FILE
jump to class

 SERVICE_ERROR_MISSING_FILE = '4'

Details

value
4

SERVICE_ERROR_EMPTY_TITLE
jump to class

 SERVICE_ERROR_EMPTY_TITLE = '5'

Details

value
5

SERVICE_ERROR_NOT_SOURCEOBJ
jump to class

 SERVICE_ERROR_NOT_SOURCEOBJ = '6'

Details

value
6

SERVICE_ERROR_INVALID_EXT
jump to class

 SERVICE_ERROR_INVALID_EXT = '7'

Details

value
7

SERVICE_ERROR_FILE_TOO_BIG
jump to class

 SERVICE_ERROR_FILE_TOO_BIG = '8'

Details

value
8

SERVICE_ERROR_SHOW_NOT_FOUND
jump to class

 SERVICE_ERROR_SHOW_NOT_FOUND = '9'

Details

value
9

SERVICE_ERROR_USER_NOT_FOUND
jump to class

 SERVICE_ERROR_USER_NOT_FOUND = '10'

Details

value
10

SERVICE_ERROR_GROUP_NOT_FOUND
jump to class

 SERVICE_ERROR_GROUP_NOT_FOUND = '11'

Details

value
11

SERVICE_ERROR_MISSING_TAG
jump to class

 SERVICE_ERROR_MISSING_TAG = '12'

Details

value
12

SERVICE_ERROR_DAILY_LIMIT
jump to class

 SERVICE_ERROR_DAILY_LIMIT = '99'

Details

value
99

SERVICE_ERROR_ACCOUNT_BLOCKED
jump to class

 SERVICE_ERROR_ACCOUNT_BLOCKED = '100'

Details

value
100

SERVICE_UPLOAD_URI
jump to class

 SERVICE_UPLOAD_URI = 'http://www.slideshare.net/api/1/upload_slideshow'

Slide share Web service communication URIs

Details

value
http://www.slideshare.net/api/1/upload_slideshow

SERVICE_GET_SHOW_URI
jump to class

 SERVICE_GET_SHOW_URI = 'http://www.slideshare.net/api/1/get_slideshow'

Details

value
http://www.slideshare.net/api/1/get_slideshow

SERVICE_GET_SHOW_BY_USER_URI
jump to class

 SERVICE_GET_SHOW_BY_USER_URI = 'http://www.slideshare.net/api/1/get_slideshow_by_user'

Details

value
http://www.slideshare.net/api/1/get_slideshow_by_user

SERVICE_GET_SHOW_BY_TAG_URI
jump to class

 SERVICE_GET_SHOW_BY_TAG_URI = 'http://www.slideshare.net/api/1/get_slideshow_by_tag'

Details

value
http://www.slideshare.net/api/1/get_slideshow_by_tag

SERVICE_GET_SHOW_BY_GROUP_URI
jump to class

 SERVICE_GET_SHOW_BY_GROUP_URI = 'http://www.slideshare.net/api/1/get_slideshows_from_group'

Details

value
http://www.slideshare.net/api/1/get_slideshows_from_group

POWERPOINT_MIME_TYPE
jump to class

 POWERPOINT_MIME_TYPE = 'application/vnd.ms-powerpoint'

The MIME type of Slideshow files

Details

value
application/vnd.ms-powerpoint

Properties

$_apiKey
jump to class

string $_apiKey = ''

The API key to use in requests

Details

$_apiKey
string
The API key
visibility
protected
default
final
false
static
false

$_cacheobject
jump to class

Zend_Cache_Core $_cacheobject = ''

The Cache object to use to perform caching

Details

$_cacheobject
Zend_Cache_Core
visibility
protected
default
final
false
static
false

$_httpclient
jump to class

Zend_Http_Client $_httpclient = ''

The HTTP Client object to use to perform requests

Details

$_httpclient
Zend_Http_Client
visibility
protected
default
final
false
static
false

$_password
jump to class

string $_password = ''

The password to use in requests

Details

$_password
string
the password
visibility
protected
default
final
false
static
false

$_sharedSecret
jump to class

string $_sharedSecret = ''

The shared secret to use in requests

Details

$_sharedSecret
string
the Shared secret
visibility
protected
default
final
false
static
false

$_username
jump to class

string $_username = ''

The username to use in requests

Details

$_username
string
the username
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

__construct( string $apikey, string $sharedSecret, string $username = null, string $password = null ) :

The Constructor

Arguments
$apikey
string
The API key
$sharedSecret
string
The shared secret
$username
string
The username
$password
string
The password
Details
visibility
public
final
false
static
false

_getSlideShowsByType
jump to class

_getSlideShowsByType( string $key, string $value, int $offset = null, int $limit = null ) : array

Retrieves Zend_Service_SlideShare_SlideShow object arrays based on the type of list desired

Arguments
$key
string
The type of slide show object to retrieve
$value
string
The specific search query for the slide show type to look up
$offset
int
The offset of the list to start retrieving from
$limit
int
The maximum number of slide shows to retrieve
Output
array
An array of Zend_Service_SlideShare_SlideShow objects
Details
visibility
protected
final
false
static
false

_slideShowNodeToObject
jump to class

_slideShowNodeToObject( SimpleXMLElement $node ) : Zend_Service_SlideShare_SlideShow

Converts a SimpleXMLElement object representing a response from the service into a Zend_Service_SlideShare_SlideShow object

Arguments
$node
SimpleXMLElement
The input XML from the slideshare.net service
Output
Zend_Service_SlideShare_SlideShow
The resulting object
Details
visibility
protected
final
false
static
false

getApiKey
jump to class

getApiKey( ) : string

Gets the API key to be used in making API calls

Output
string
the API Key
Details
visibility
public
final
false
static
false

getCacheObject
jump to class

getCacheObject( ) : Zend_Cache_Core

Gets the Zend_Cache object which will be used to cache API queries. If no cache object was previously set the the default will be used (Filesystem caching in /tmp with a life time of 43200 seconds)

Output
Zend_Cache_Core
The object used in caching
Details
visibility
public
final
false
static
false

getHttpClient
jump to class

getHttpClient( ) : Zend_Http_Client

Returns the instance of the Zend_Http_Client which will be used. Creates an instance of Zend_Http_Client if no previous client was set.

Output
Zend_Http_Client
The HTTP client which will be used
Details
visibility
public
final
false
static
false

getPassword
jump to class

getPassword( ) : string

Gets the password to use in API calls

Output
string
the password to use in API calls
Details
visibility
public
final
false
static
false

getSharedSecret
jump to class

getSharedSecret( ) : string

Gets the shared secret used in making API calls

Output
string
the Shared secret
Details
visibility
public
final
false
static
false

getSlideShow
jump to class

getSlideShow( int $ss_id ) : Zend_Service_SlideShare_SlideShow

Retrieves a slide show's information based on slide show ID

Arguments
$ss_id
int
The slide show ID
Output
Zend_Service_SlideShare_SlideShow
the Slideshow object
Details
visibility
public
final
false
static
false

getSlideShowsByGroup
jump to class

getSlideShowsByGroup( string $group, int $offset = null, int $limit = null ) : array

Retrieves an array of slide shows based on group name

Arguments
$group
string
The group name to retrieve slide shows for
$offset
int
The offset of the list to start retrieving from
$limit
int
The maximum number of slide shows to retrieve
Output
array
An array of Zend_Service_SlideShare_SlideShow objects
Details
visibility
public
final
false
static
false

getSlideShowsByTag
jump to class

getSlideShowsByTag( string $tag, int $offset = null, int $limit = null ) : array

Retrieves an array of slide shows based on tag

Arguments
$tag
string
The tag to retrieve slide shows with
$offset
int
The offset of the list to start retrieving from
$limit
int
The maximum number of slide shows to retrieve
Output
array
An array of Zend_Service_SlideShare_SlideShow objects
Details
visibility
public
final
false
static
false

getSlideShowsByUsername
jump to class

getSlideShowsByUsername( string $username, int $offset = null, int $limit = null ) : array

Retrieves an array of slide shows for a given username

Arguments
$username
string
The username to retrieve slide shows from
$offset
int
The offset of the list to start retrieving from
$limit
int
The maximum number of slide shows to retrieve
Output
array
An array of Zend_Service_SlideShare_SlideShow objects
Details
visibility
public
final
false
static
false

getUserName
jump to class

getUserName( ) : string

Returns the user name used for API calls

Output
string
The username
Details
visibility
public
final
false
static
false

setApiKey
jump to class

setApiKey( string $key ) : Zend_Service_SlideShare

Sets the API key to be used in making API calls

Arguments
$key
string
The API key to use
Output
Zend_Service_SlideShare
Details
visibility
public
final
false
static
false

setCacheObject
jump to class

setCacheObject( Zend_Cache_Core $cacheobject ) : Zend_Service_SlideShare

Sets the Zend_Cache object to use to cache the results of API queries

Arguments
$cacheobject
Zend_Cache_Core
The Zend_Cache object used
Output
Zend_Service_SlideShare
Details
visibility
public
final
false
static
false

setHttpClient
jump to class

setHttpClient( Zend_Http_Client $client ) : Zend_Service_SlideShare

Sets the Zend_Http_Client object to use in requests. If not provided a default will be used.

Arguments
$client
Zend_Http_Client
The HTTP client instance to use
Output
Zend_Service_SlideShare
Details
visibility
public
final
false
static
false

setPassword
jump to class

setPassword( string $pw ) : Zend_Service_SlideShare

Sets the password to use in API calls

Arguments
$pw
string
The password to use
Output
Zend_Service_SlideShare
Details
visibility
public
final
false
static
false

setSharedSecret
jump to class

setSharedSecret( string $secret ) : Zend_Service_SlideShare

Sets the shared secret used in making API calls

Arguments
$secret
string
the shared secret
Output
Zend_Service_SlideShare
Details
visibility
public
final
false
static
false

setUserName
jump to class

setUserName( string $un ) : Zend_Service_SlideShare

Sets the user name to use for API calls

Arguments
$un
string
The username to use
Output
Zend_Service_SlideShare
Details
visibility
public
final
false
static
false

uploadSlideShow
jump to class

uploadSlideShow( Zend_Service_SlideShare_SlideShow $ss, boolean $make_src_public = true ) : Zend_Service_SlideShare_SlideShow

Uploads the specified Slide show the the server

Arguments
$ss
Zend_Service_SlideShare_SlideShow
The slide show object representing the slide show to upload
$make_src_public
boolean
Determines if the the slide show's source file is public or not upon upload
Output
Zend_Service_SlideShare_SlideShow
The passed Slide show object, with the new assigned ID provided
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.