Service/SlideShare.php

Show:

inherited

Classes
- \Zend_Service_SlideShare

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: SlideShare
Version: $Id$

\Zend_Service_SlideShare
jump to top

Package: Zend_Service\SlideShare

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                SERVICE_ERROR_BAD_APIKEY
                = 1

Web service result code mapping

 
                SERVICE_ERROR_BAD_AUTH
                = 2

 
                SERVICE_ERROR_MISSING_TITLE
                = 3

 
                SERVICE_ERROR_MISSING_FILE
                = 4

 
                SERVICE_ERROR_EMPTY_TITLE
                = 5

 
                SERVICE_ERROR_NOT_SOURCEOBJ
                = 6

 
                SERVICE_ERROR_INVALID_EXT
                = 7

 
                SERVICE_ERROR_FILE_TOO_BIG
                = 8

 
                SERVICE_ERROR_SHOW_NOT_FOUND
                = 9

 
                SERVICE_ERROR_USER_NOT_FOUND
                = 10

 
                SERVICE_ERROR_GROUP_NOT_FOUND
                = 11

 
                SERVICE_ERROR_MISSING_TAG
                = 12

 
                SERVICE_ERROR_DAILY_LIMIT
                = 99

 
                SERVICE_ERROR_ACCOUNT_BLOCKED
                = 100

 
                SERVICE_UPLOAD_URI
                = 'https://www.slideshare.net/api/2/upload_slideshow'

Slide share Web service communication URIs

 
                SERVICE_GET_SHOW_URI
                = 'https://www.slideshare.net/api/2/get_slideshow'

 
                SERVICE_GET_SHOW_BY_USER_URI
                = 'https://www.slideshare.net/api/2/get_slideshows_by_user'

 
                SERVICE_GET_SHOW_BY_TAG_URI
                = 'https://www.slideshare.net/api/2/get_slideshows_by_tag'

 
                SERVICE_GET_SHOW_BY_GROUP_URI
                = 'https://www.slideshare.net/api/2/get_slideshows_by_group'

 
                POWERPOINT_MIME_TYPE
                = "application/vnd.ms-powerpoint"

The MIME type of Slideshow files

Properties

string $_apiKey

The API key to use in requests

Details

Type: string

\Zend_Cache_Core $_cacheobject

The Cache object to use to perform caching

Details

Type: \Zend_Cache_Core

\Zend_Http_Client $_httpclient

The HTTP Client object to use to perform requests

Details

Type: \Zend_Http_Client

string $_password

The password to use in requests

Details

Type: string

string $_sharedSecret

The shared secret to use in requests

Details

Type: string

string $_username

The username to use in requests

Details

Type: string

Methods

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

The Constructor

Parameters

Name	Type	Description
$apikey	string	The API key
$sharedSecret	string	The shared secret
$username	string	The username
$password	string	The password

_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

Parameters

Name	Type	Description
$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

Returns

Type	Description
array	An array of Zend_Service_SlideShare_SlideShow objects

Throws

Exception	Description
\Zend_Service_SlideShare_Exception

_slideShowNodeToObject(\SimpleXMLElement $node) : \Zend_Service_SlideShare_SlideShow

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

Parameters

Name	Type	Description
$node	\SimpleXMLElement	The input XML from the slideshare.net service

Returns

Type	Description
\Zend_Service_SlideShare_SlideShow	The resulting object

Throws

Exception	Description
\Zend_Service_SlideShare_Exception

getApiKey() : string

Gets the API key to be used in making API calls

Returns

Type	Description
string	the API Key

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)

Returns

Type	Description
\Zend_Cache_Core	The object used in caching

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.

Returns

Type	Description
\Zend_Http_Client	The HTTP client which will be used

getPassword() : string

Gets the password to use in API calls

Returns

Type	Description
string	the password to use in API calls

getSharedSecret() : string

Gets the shared secret used in making API calls

Returns

Type	Description
string	the Shared secret

getSlideShow(int $ss_id) : \Zend_Service_SlideShare_SlideShow

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

Parameters

Name	Type	Description
$ss_id	int	The slide show ID

Returns

Type	Description
\Zend_Service_SlideShare_SlideShow	the Slideshow object

Throws

Exception	Description
\Zend_Service_SlideShare_Exception

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

Retrieves an array of slide shows based on group name

Parameters

Name	Type	Description
$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

Returns

Type	Description
array	An array of Zend_Service_SlideShare_SlideShow objects

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

Retrieves an array of slide shows based on tag

Parameters

Name	Type	Description
$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

Returns

Type	Description
array	An array of Zend_Service_SlideShare_SlideShow objects

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

Retrieves an array of slide shows for a given username

Parameters

Name	Type	Description
$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

Returns

Type	Description
array	An array of Zend_Service_SlideShare_SlideShow objects

getUserName() : string

Returns the user name used for API calls

Returns

Type	Description
string	The username

setApiKey(string $key) : \Zend_Service_SlideShare

Sets the API key to be used in making API calls

Parameters

Name	Type	Description
$key	string	The API key to use

Returns

Type	Description
\Zend_Service_SlideShare

setCacheObject(\Zend_Cache_Core $cacheobject) : \Zend_Service_SlideShare

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

Parameters

Name	Type	Description
$cacheobject	\Zend_Cache_Core	The Zend_Cache object used

Returns

Type	Description
\Zend_Service_SlideShare

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.

Parameters

Name	Type	Description
$client	\Zend_Http_Client	The HTTP client instance to use

Returns

Type	Description
\Zend_Service_SlideShare

setPassword(string $pw) : \Zend_Service_SlideShare

Sets the password to use in API calls

Parameters

Name	Type	Description
$pw	string	The password to use

Returns

Type	Description
\Zend_Service_SlideShare

setSharedSecret(string $secret) : \Zend_Service_SlideShare

Sets the shared secret used in making API calls

Parameters

Name	Type	Description
$secret	string	the shared secret

Returns

Type	Description
\Zend_Service_SlideShare

setUserName(string $un) : \Zend_Service_SlideShare

Sets the user name to use for API calls

Parameters

Name	Type	Description
$un	string	The username to use

Returns

Type	Description
\Zend_Service_SlideShare

uploadSlideShow(\Zend_Service_SlideShare_SlideShow $ss, boolean $makeSrcPublic = true) : \Zend_Service_SlideShare_SlideShow

Uploads the specified Slide show the the server

Parameters

Name	Type	Description
$ss	\Zend_Service_SlideShare_SlideShow	The slide show object representing the slide show to upload
$makeSrcPublic	boolean	Determines if the the slide show's source file is public or not upon upload

Returns

Type	Description
\Zend_Service_SlideShare_SlideShow	The passed Slide show object, with the new assigned ID provided

Throws

Exception	Description
\Zend_Service_SlideShare_Exception

Service/SlideShare.php

\Zend_Service_SlideSharejump to top

Constants

Properties

Methods

\Zend_Service_SlideShare
jump to top