API Documentation

Service/SlideShare/SlideShow.php

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: SlideShow.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Service_SlideShare_SlideShow

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_SlideShow

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
Constants
STATUS_QUEUED
STATUS_PROCESSING
STATUS_READY
STATUS_FAILED
Properties
$_embedCode
$_thumbnailUrl
$_title
$_description
$_status
$_statusDescription
$_permalink
$_numViews
$_slideShowId
$_slideShowFilename
$_tags
$_location
$_transcript
Methods
getLocation
setLocation
getTranscript
setTranscript
addTag
setTags
getTags
setFilename
getFilename
setId
getId
setEmbedCode
getEmbedCode
setThumbnailUrl
getThumbnailUrl
setTitle
getTitle
setDescription
getDescription
setStatus
getStatus
setStatusDescription
getStatusDescription
setPermaLink
getPermaLink
setNumViews
getNumViews

Description

The Zend_Service_SlideShare_SlideShow class represents a slide show on the slideshare.net servers.

Constants

STATUS_QUEUED

 STATUS_QUEUED = '0'

Status constant mapping for web service

Details

value
0

STATUS_PROCESSING

 STATUS_PROCESSING = '1'

Details

value
1

STATUS_READY

 STATUS_READY = '2'

Details

value
2

STATUS_FAILED

 STATUS_FAILED = '3'

Details

value
3

Properties

$_description

string $_description = ''

The Description of the slide show

Details

$_description
string
The slide show description
visibility
protected
default
final
false
static
false

$_embedCode

string $_embedCode = ''

The HTML code to embed the slide show in a web page

Details

$_embedCode
string
the HTML to embed the slide show
visibility
protected
default
final
false
static
false

$_location

string $_location = ''

The location of the slide show

Details

$_location
string
the Location
visibility
protected
default
final
false
static
false

$_numViews

int $_numViews = ''

The number of views this slide show has received

Details

$_numViews
int
the number of views
visibility
protected
default
final
false
static
false

$_permalink

string $_permalink = ''

The Permanent link for the slide show

Details

$_permalink
string
the Permalink for the slide show
visibility
protected
default
final
false
static
false

$_slideShowFilename

string $_slideShowFilename = ''

A slide show filename on the local filesystem (when uploading)

Details

$_slideShowFilename
string
the local filesystem path & file of the slide show to upload
visibility
protected
default
final
false
static
false

$_slideShowId

int $_slideShowId = ''

The ID of the slide show on the server

Details

$_slideShowId
int
the Slide show ID number on the server
visibility
protected
default
final
false
static
false

$_status

int $_status = ''

The status of the silde show on the server

Details

$_status
int
The Slide show status code
visibility
protected
default
final
false
static
false

$_statusDescription

string $_statusDescription = ''

The Description of the slide show status code

Details

$_statusDescription
string
The status description
visibility
protected
default
final
false
static
false

$_tags

array $_tags = 'array'

An array of tags associated with the slide show

Details

$_tags
array
An array of tags associated with the slide show
visibility
protected
default
array
final
false
static
false

$_thumbnailUrl

string $_thumbnailUrl = ''

The URI for the thumbnail representation of the slide show

Details

$_thumbnailUrl
string
The URI of a thumbnail image
visibility
protected
default
final
false
static
false

$_title

string $_title = ''

The title of the slide show

Details

$_title
string
The slide show title
visibility
protected
default
final
false
static
false

$_transcript

string $_transcript = ''

The transcript associated with the slide show

Details

$_transcript
string
the Transscript
visibility
protected
default
final
false
static
false

Methods

addTag

addTag( string $tag ) : Zend_Service_SlideShare_SlideShow

Adds a tag to the slide show

Arguments
$tag
string
The tag to add
Details
visibility
public
final
false
static
false

getDescription

getDescription( ) : string

Gets the description of the slide show

Output
string
The slide show description
Details
visibility
public
final
false
static
false

getEmbedCode

getEmbedCode( ) : string

Retrieves the HTML embed code for the slide show

Output
string
the HTML embed code
Details
visibility
public
final
false
static
false

getFilename

getFilename( ) : string

Retrieves the filename on the local filesystem of the slide show which will be uploaded

Output
string
The full path & filename to the slide show
Details
visibility
public
final
false
static
false

getId

getId( ) : int

Gets the ID for the slide show

Output
int
The slide show ID
Details
visibility
public
final
false
static
false

getLocation

getLocation( ) : string

Retrieves the location of the slide show

Output
string
the Location
Details
visibility
public
final
false
static
false

getNumViews

getNumViews( ) : int

Gets the number of views the slide show has received

Output
int
The number of views
Details
visibility
public
final
false
static
false

getPermaLink

getPermaLink( ) : string

Gets the permanent link of the slide show

Output
string
the permanent URL for the slide show
Details
visibility
public
final
false
static
false

getStatus

getStatus( ) : int

Gets the numeric status of the slide show on the server

Output
int
A Zend_Service_SlideShare_SlideShow Status constant
Details
visibility
public
final
false
static
false

getStatusDescription

getStatusDescription( ) : string

Gets the textual description of the status of the slide show on the server

Output
string
the textual description of the service
Details
visibility
public
final
false
static
false

getTags

getTags( ) : array

Gets all of the tags associated with the slide show

Output
array
An array of tags for the slide show
Details
visibility
public
final
false
static
false

getThumbnailUrl

getThumbnailUrl( ) : string

Retrieves the Thumbnail URi for the slide show

Output
string
The URI for the thumbnail image
Details
visibility
public
final
false
static
false

getTitle

getTitle( ) : string

Retrieves the Slide show title

Output
string
the Slide show title
Details
visibility
public
final
false
static
false

getTranscript

getTranscript( ) : string

Gets the transcript for this slide show

Output
string
the Transcript
Details
visibility
public
final
false
static
false

setDescription

setDescription( strign $desc ) : Zend_Service_SlideShare_SlideShow

Sets the description for the Slide show

Arguments
$desc
strign
The description of the slide show
Details
visibility
public
final
false
static
false

setEmbedCode

setEmbedCode( string $code ) : Zend_Service_SlideShare_SlideShow

Sets the HTML embed code for the slide show

Arguments
$code
string
The HTML embed code
Details
visibility
public
final
false
static
false

setFilename

setFilename( string $file ) : Zend_Service_SlideShare_SlideShow

Sets the filename on the local filesystem of the slide show (for uploading a new slide show)

Arguments
$file
string
The full path & filename to the slide show
Details
visibility
public
final
false
static
false

setId

setId( int $id ) : Zend_Service_SlideShare_SlideShow

Sets the ID for the slide show

Arguments
$id
int
The slide show ID
Details
visibility
public
final
false
static
false

setLocation

setLocation( string $loc ) : Zend_Service_SlideShare_SlideShow

Sets the location of the slide show

Arguments
$loc
string
The location to use
Details
visibility
public
final
false
static
false

setNumViews

setNumViews( int $views ) : Zend_Service_SlideShare_SlideShow

Sets the number of views the slide show has received

Arguments
$views
int
The number of views
Details
visibility
public
final
false
static
false

setPermaLink

setPermaLink( string $url ) : Zend_Service_SlideShare_SlideShow

Sets the permanent link of the slide show

Arguments
$url
string
The permanent URL for the slide show
Details
visibility
public
final
false
static
false

setStatus

setStatus( int $status ) : Zend_Service_SlideShare_SlideShow

Sets the numeric status of the slide show on the server

Arguments
$status
int
The numeric status on the server
Details
visibility
public
final
false
static
false

setStatusDescription

setStatusDescription( string $desc ) : Zend_Service_SlideShare_SlideShow

Sets the textual description of the status of the slide show on the server

Arguments
$desc
string
The textual description of the status of the slide show
Details
visibility
public
final
false
static
false

setTags

setTags( array $tags ) : Zend_Service_SlideShare_SlideShow

Sets the tags for the slide show

Arguments
$tags
array
An array of tags to set
Details
visibility
public
final
false
static
false

setThumbnailUrl

setThumbnailUrl( string $url ) : Zend_Service_SlideShare_SlideShow

Sets the Thumbnail URI for the slide show

Arguments
$url
string
The URI for the thumbnail image
Details
visibility
public
final
false
static
false

setTitle

setTitle( string $title ) : Zend_Service_SlideShare_SlideShow

Sets the title for the Slide show

Arguments
$title
string
The slide show title
Details
visibility
public
final
false
static
false

setTranscript

setTranscript( string $t ) : Zend_Service_SlideShare_SlideShow

Sets the transcript for this slide show

Arguments
$t
string
The transcript
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.