Service/SlideShare/SlideShow.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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_SlideShow

Package: Zend_Service\SlideShare
The Zend_Service_SlideShare_SlideShow class represents a slide show on the slideshare.net servers.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  STATUS_QUEUED = 0
Status constant mapping for web service
>VConstant  STATUS_PROCESSING = 1
>VConstant  STATUS_READY = 2
>VConstant  STATUS_FAILED = 3

Properties

>VPropertyprotectedstring $_description
The Description of the slide show
Details
Type
string
>VPropertyprotectedstring $_embedCode
The HTML code to embed the slide show in a web page
Details
Type
string
>VPropertyprotectedstring $_location
The location of the slide show
Details
Type
string
>VPropertyprotectedint $_numViews
The number of views this slide show has received
Details
Type
int
>VPropertyprotectedstring $_permalink
The Permanent link for the slide show
Details
Type
string
>VPropertyprotectedstring $_slideShowFilename
A slide show filename on the local filesystem (when uploading)
Details
Type
string
>VPropertyprotectedint $_slideShowId
The ID of the slide show on the server
Details
Type
int
>VPropertyprotectedint $_status
The status of the silde show on the server
Details
Type
int
>VPropertyprotectedstring $_statusDescription
The Description of the slide show status code
Details
Type
string
>VPropertyprotectedarray $_tags = array()
An array of tags associated with the slide show
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_thumbnailUrl
The URI for the thumbnail representation of the slide show
Details
Type
string
>VPropertyprotectedstring $_title
The title of the slide show
Details
Type
string
>VPropertyprotectedstring $_transcript
The transcript associated with the slide show
Details
Type
string

Methods

methodpublicaddTag(string $tag) : \Zend_Service_SlideShare_SlideShow

Adds a tag to the slide show

Parameters
NameTypeDescription
$tagstring

The tag to add

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicgetDescription() : string

Gets the description of the slide show

Returns
TypeDescription
stringThe slide show description
methodpublicgetEmbedCode() : string

Retrieves the HTML embed code for the slide show

Returns
TypeDescription
stringthe HTML embed code
methodpublicgetFilename() : string

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

Returns
TypeDescription
stringThe full path & filename to the slide show
methodpublicgetId() : int

Gets the ID for the slide show

Returns
TypeDescription
intThe slide show ID
methodpublicgetLocation() : string

Retrieves the location of the slide show

Returns
TypeDescription
stringthe Location
methodpublicgetNumViews() : int

Gets the number of views the slide show has received

Returns
TypeDescription
intThe number of views
methodpublicgetPermaLink() : string

Gets the permanent link of the slide show

Returns
TypeDescription
stringthe permanent URL for the slide show
methodpublicgetStatus() : int

Gets the numeric status of the slide show on the server

Returns
TypeDescription
intA Zend_Service_SlideShare_SlideShow Status constant
methodpublicgetStatusDescription() : string

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

Returns
TypeDescription
stringthe textual description of the service
methodpublicgetTags() : array

Gets all of the tags associated with the slide show

Returns
TypeDescription
arrayAn array of tags for the slide show
methodpublicgetThumbnailUrl() : string

Retrieves the Thumbnail URi for the slide show

Returns
TypeDescription
stringThe URI for the thumbnail image
methodpublicgetTitle() : string

Retrieves the Slide show title

Returns
TypeDescription
stringthe Slide show title
methodpublicgetTranscript() : string

Gets the transcript for this slide show

Returns
TypeDescription
stringthe Transcript
methodpublicsetDescription(string $desc) : \Zend_Service_SlideShare_SlideShow

Sets the description for the Slide show

Parameters
NameTypeDescription
$descstring

The description of the slide show

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetEmbedCode(string $code) : \Zend_Service_SlideShare_SlideShow

Sets the HTML embed code for the slide show

Parameters
NameTypeDescription
$codestring

The HTML embed code

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetFilename(string $file) : \Zend_Service_SlideShare_SlideShow

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

Parameters
NameTypeDescription
$filestring

The full path & filename to the slide show

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetId(int $id) : \Zend_Service_SlideShare_SlideShow

Sets the ID for the slide show

Parameters
NameTypeDescription
$idint

The slide show ID

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetLocation(string $loc) : \Zend_Service_SlideShare_SlideShow

Sets the location of the slide show

Parameters
NameTypeDescription
$locstring

The location to use

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetNumViews(int $views) : \Zend_Service_SlideShare_SlideShow

Sets the number of views the slide show has received

Parameters
NameTypeDescription
$viewsint

The number of views

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetPermaLink(string $url) : \Zend_Service_SlideShare_SlideShow

Sets the permanent link of the slide show

Parameters
NameTypeDescription
$urlstring

The permanent URL for the slide show

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetStatus(int $status) : \Zend_Service_SlideShare_SlideShow

Sets the numeric status of the slide show on the server

Parameters
NameTypeDescription
$statusint

The numeric status on the server

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetStatusDescription(string $desc) : \Zend_Service_SlideShare_SlideShow

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

Parameters
NameTypeDescription
$descstring

The textual description of the status of the slide show

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetTags(array $tags) : \Zend_Service_SlideShare_SlideShow

Sets the tags for the slide show

Parameters
NameTypeDescription
$tagsarray

An array of tags to set

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetThumbnailUrl(string $url) : \Zend_Service_SlideShare_SlideShow

Sets the Thumbnail URI for the slide show

Parameters
NameTypeDescription
$urlstring

The URI for the thumbnail image

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetTitle(string $title) : \Zend_Service_SlideShare_SlideShow

Sets the title for the Slide show

Parameters
NameTypeDescription
$titlestring

The slide show title

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
methodpublicsetTranscript(string $t) : \Zend_Service_SlideShare_SlideShow

Sets the transcript for this slide show

Parameters
NameTypeDescription
$tstring

The transcript

Returns
TypeDescription
\Zend_Service_SlideShare_SlideShow
Documentation was generated by phpDocumentor 2.2.0 .