API Documentation

Zend/Service/SlideShare/SlideShow.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
SlideShare  
Version
$Id: SlideShow.php 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  STATUS_QUEUED = 0

Status constant mapping for web service

Constant  STATUS_PROCESSING = 1
Constant  STATUS_READY = 2
Constant  STATUS_FAILED = 3

Properties

Propertyprotectedstring  $_description= ''

The Description of the slide show

The slide show description
Details
Type
string
Propertyprotectedstring  $_embedCode= ''

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

the HTML to embed the slide show
Details
Type
string
Propertyprotectedstring  $_location= ''

The location of the slide show

the Location
Details
Type
string
Propertyprotectedint  $_numViews= ''

The number of views this slide show has received

the number of views
Details
Type
int
Propertyprotectedstring  $_permalink= ''

The Permanent link for the slide show

the Permalink for the slide show
Details
Type
string
Propertyprotectedstring  $_slideShowFilename= ''

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

the local filesystem path & file of the slide show to upload
Details
Type
string
Propertyprotectedint  $_slideShowId= ''

The ID of the slide show on the server

the Slide show ID number on the server
Details
Type
int
Propertyprotectedint  $_status= ''

The status of the silde show on the server

The Slide show status code
Details
Type
int
Propertyprotectedstring  $_statusDescription= ''

The Description of the slide show status code

The status description
Details
Type
string
Propertyprotectedarray  $_tags= 'array()'

An array of tags associated with the slide show

An array of tags associated with the slide show
Default valuearray()Details
Type
array
Propertyprotectedstring  $_thumbnailUrl= ''

The URI for the thumbnail representation of the slide show

The URI of a thumbnail image
Details
Type
string
Propertyprotectedstring  $_title= ''

The title of the slide show

The slide show title
Details
Type
string
Propertyprotectedstring  $_transcript= ''

The transcript associated with the slide show

the Transscript
Details
Type
string

Methods

methodpublicaddTag( string $tag ) : \Zend_Service_SlideShare_SlideShow

Adds a tag to the slide show

Parameters
Name Type Description
$tag string

The tag to add

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicgetDescription( ) : string

Gets the description of the slide show

Returns
Type Description
string The slide show description
methodpublicgetEmbedCode( ) : string

Retrieves the HTML embed code for the slide show

Returns
Type Description
string the HTML embed code
methodpublicgetFilename( ) : string

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

Returns
Type Description
string The full path & filename to the slide show
methodpublicgetId( ) : int

Gets the ID for the slide show

Returns
Type Description
int The slide show ID
methodpublicgetLocation( ) : string

Retrieves the location of the slide show

Returns
Type Description
string the Location
methodpublicgetNumViews( ) : int

Gets the number of views the slide show has received

Returns
Type Description
int The number of views
methodpublicgetPermaLink( ) : string

Gets the permanent link of the slide show

Returns
Type Description
string the permanent URL for the slide show
methodpublicgetStatus( ) : int

Gets the numeric status of the slide show on the server

Returns
Type Description
int A Zend_Service_SlideShare_SlideShow Status constant
methodpublicgetStatusDescription( ) : string

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

Returns
Type Description
string the textual description of the service
methodpublicgetTags( ) : array

Gets all of the tags associated with the slide show

Returns
Type Description
array An array of tags for the slide show
methodpublicgetThumbnailUrl( ) : string

Retrieves the Thumbnail URi for the slide show

Returns
Type Description
string The URI for the thumbnail image
methodpublicgetTitle( ) : string

Retrieves the Slide show title

Returns
Type Description
string the Slide show title
methodpublicgetTranscript( ) : string

Gets the transcript for this slide show

Returns
Type Description
string the Transcript
methodpublicsetDescription( \strign $desc ) : \Zend_Service_SlideShare_SlideShow

Sets the description for the Slide show

Parameters
Name Type Description
$desc \strign

The description of the slide show

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetEmbedCode( string $code ) : \Zend_Service_SlideShare_SlideShow

Sets the HTML embed code for the slide show

Parameters
Name Type Description
$code string

The HTML embed code

Returns
Type Description
\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
Name Type Description
$file string

The full path /p>

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetId( int $id ) : \Zend_Service_SlideShare_SlideShow

Sets the ID for the slide show

Parameters
Name Type Description
$id int

The slide show ID

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetLocation( string $loc ) : \Zend_Service_SlideShare_SlideShow

Sets the location of the slide show

Parameters
Name Type Description
$loc string

The location to use

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetNumViews( int $views ) : \Zend_Service_SlideShare_SlideShow

Sets the number of views the slide show has received

Parameters
Name Type Description
$views int

The number of views

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetPermaLink( string $url ) : \Zend_Service_SlideShare_SlideShow

Sets the permanent link of the slide show

Parameters
Name Type Description
$url string

The permanent URL for the slide show

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetStatus( int $status ) : \Zend_Service_SlideShare_SlideShow

Sets the numeric status of the slide show on the server

Parameters
Name Type Description
$status int

The numeric status on the server

Returns
Type Description
\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
Name Type Description
$desc string

The textual description of the status of the slide show

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetTags( array $tags ) : \Zend_Service_SlideShare_SlideShow

Sets the tags for the slide show

Parameters
Name Type Description
$tags array

An array of tags to set

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetThumbnailUrl( string $url ) : \Zend_Service_SlideShare_SlideShow

Sets the Thumbnail URI for the slide show

Parameters
Name Type Description
$url string

The URI for the thumbnail image

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetTitle( string $title ) : \Zend_Service_SlideShare_SlideShow

Sets the title for the Slide show

Parameters
Name Type Description
$title string

The slide show title

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
methodpublicsetTranscript( string $t ) : \Zend_Service_SlideShare_SlideShow

Sets the transcript for this slide show

Parameters
Name Type Description
$t string

The transcript

Returns
Type Description
\Zend_Service_SlideShare_SlideShow
Documentation was generated by DocBlox 0.15.1.