[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/ -> SlideShare.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 619 lines (20 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_SlideShare:: (20 methods):
  setHttpClient()
  getHttpClient()
  setCacheObject()
  getCacheObject()
  getUserName()
  setUserName()
  getPassword()
  setPassword()
  getApiKey()
  setApiKey()
  getSharedSecret()
  setSharedSecret()
  __construct()
  uploadSlideShow()
  getSlideShow()
  getSlideShowsByUsername()
  getSlideShowsByTag()
  getSlideShowsByGroup()
  _getSlideShowsByType()
  _slideShowNodeToObject()


Class: Zend_Service_SlideShare  - X-Ref

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.

setHttpClient(Zend_Http_Client $client)   X-Ref
Sets the Zend_Http_Client object to use in requests. If not provided a default will
be used.

param: Zend_Http_Client $client The HTTP client instance to use
return: Zend_Service_SlideShare

getHttpClient()   X-Ref
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.

return: Zend_Http_Client The HTTP client which will be used

setCacheObject(Zend_Cache_Core $cacheobject)   X-Ref
Sets the Zend_Cache object to use to cache the results of API queries

param: Zend_Cache_Core $cacheobject The Zend_Cache object used
return: Zend_Service_SlideShare

getCacheObject()   X-Ref
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)

return: Zend_Cache_Core The object used in caching

getUserName()   X-Ref
Returns the user name used for API calls

return: string The username

setUserName($un)   X-Ref
Sets the user name to use for API calls

param: string $un The username to use
return: Zend_Service_SlideShare

getPassword()   X-Ref
Gets the password to use in API calls

return: string the password to use in API calls

setPassword($pw)   X-Ref
Sets the password to use in API calls

param: string $pw The password to use
return: Zend_Service_SlideShare

getApiKey()   X-Ref
Gets the API key to be used in making API calls

return: string the API Key

setApiKey($key)   X-Ref
Sets the API key to be used in making API calls

param: string $key The API key to use
return: Zend_Service_SlideShare

getSharedSecret()   X-Ref
Gets the shared secret used in making API calls

return: string the Shared secret

setSharedSecret($secret)   X-Ref
Sets the shared secret used in making API calls

param: string $secret the shared secret
return: Zend_Service_SlideShare

__construct($apikey, $sharedSecret, $username = null, $password = null)   X-Ref
The Constructor

param: string $apikey The API key
param: string $sharedSecret The shared secret
param: string $username The username
param: string $password The password

uploadSlideShow(Zend_Service_SlideShare_SlideShow $ss, $make_src_public = true)   X-Ref
Uploads the specified Slide show the the server

param: Zend_Service_SlideShare_SlideShow $ss The slide show object representing the slide show to upload
param: boolean $make_src_public Determines if the the slide show's source file is public or not upon upload
return: Zend_Service_SlideShare_SlideShow The passed Slide show object, with the new assigned ID provided

getSlideShow($ss_id)   X-Ref
Retrieves a slide show's information based on slide show ID

param: int $ss_id The slide show ID
return: Zend_Service_SlideShare_SlideShow the Slideshow object

getSlideShowsByUsername($username, $offset = null, $limit = null)   X-Ref
Retrieves an array of slide shows for a given username

param: string $username The username to retrieve slide shows from
param: int $offset The offset of the list to start retrieving from
param: int $limit The maximum number of slide shows to retrieve
return: array An array of Zend_Service_SlideShare_SlideShow objects

getSlideShowsByTag($tag, $offset = null, $limit = null)   X-Ref
Retrieves an array of slide shows based on tag

param: string $tag The tag to retrieve slide shows with
param: int $offset The offset of the list to start retrieving from
param: int $limit The maximum number of slide shows to retrieve
return: array An array of Zend_Service_SlideShare_SlideShow objects

getSlideShowsByGroup($group, $offset = null, $limit = null)   X-Ref
Retrieves an array of slide shows based on group name

param: string $group The group name to retrieve slide shows for
param: int $offset The offset of the list to start retrieving from
param: int $limit The maximum number of slide shows to retrieve
return: array An array of Zend_Service_SlideShare_SlideShow objects

_getSlideShowsByType($key, $value, $offset = null, $limit = null)   X-Ref
Retrieves Zend_Service_SlideShare_SlideShow object arrays based on the type of
list desired

param: string $key The type of slide show object to retrieve
param: string $value The specific search query for the slide show type to look up
param: int $offset The offset of the list to start retrieving from
param: int $limit The maximum number of slide shows to retrieve
return: array An array of Zend_Service_SlideShare_SlideShow objects

_slideShowNodeToObject(SimpleXMLElement $node)   X-Ref
Converts a SimpleXMLElement object representing a response from the service
into a Zend_Service_SlideShare_SlideShow object

param: SimpleXMLElement $node The input XML from the slideshare.net service
return: Zend_Service_SlideShare_SlideShow The resulting object



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1