|
1 <?php |
|
2 /** |
|
3 * Zend Framework |
|
4 * |
|
5 * LICENSE |
|
6 * |
|
7 * This source file is subject to the new BSD license that is bundled |
|
8 * with this package in the file LICENSE.txt. |
|
9 * It is also available through the world-wide-web at this URL: |
|
10 * http://framework.zend.com/license/new-bsd |
|
11 * If you did not receive a copy of the license and are unable to |
|
12 * obtain it through the world-wide-web, please send an email |
|
13 * to license@zend.com so we can send you a copy immediately. |
|
14 * |
|
15 * @category Zend |
|
16 * @package Zend_Service |
|
17 * @subpackage SlideShare |
|
18 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
|
19 * @license http://framework.zend.com/license/new-bsd New BSD License |
|
20 * @version $Id: SlideShow.php 20096 2010-01-06 02:05:09Z bkarwin $ |
|
21 */ |
|
22 |
|
23 |
|
24 /** |
|
25 * The Zend_Service_SlideShare_SlideShow class represents a slide show on the |
|
26 * slideshare.net servers. |
|
27 * |
|
28 * @category Zend |
|
29 * @package Zend_Service |
|
30 * @subpackage SlideShare |
|
31 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
|
32 * @license http://framework.zend.com/license/new-bsd New BSD License |
|
33 */ |
|
34 class Zend_Service_SlideShare_SlideShow |
|
35 { |
|
36 |
|
37 /** |
|
38 * Status constant mapping for web service |
|
39 * |
|
40 */ |
|
41 const STATUS_QUEUED = 0; |
|
42 const STATUS_PROCESSING = 1; |
|
43 const STATUS_READY = 2; |
|
44 const STATUS_FAILED = 3; |
|
45 |
|
46 /** |
|
47 * The HTML code to embed the slide show in a web page |
|
48 * |
|
49 * @var string the HTML to embed the slide show |
|
50 */ |
|
51 protected $_embedCode; |
|
52 |
|
53 /** |
|
54 * The URI for the thumbnail representation of the slide show |
|
55 * |
|
56 * @var string The URI of a thumbnail image |
|
57 */ |
|
58 protected $_thumbnailUrl; |
|
59 |
|
60 /** |
|
61 * The title of the slide show |
|
62 * |
|
63 * @var string The slide show title |
|
64 */ |
|
65 protected $_title; |
|
66 |
|
67 /** |
|
68 * The Description of the slide show |
|
69 * |
|
70 * @var string The slide show description |
|
71 */ |
|
72 protected $_description; |
|
73 |
|
74 /** |
|
75 * The status of the silde show on the server |
|
76 * |
|
77 * @var int The Slide show status code |
|
78 */ |
|
79 protected $_status; |
|
80 |
|
81 /** |
|
82 * The Description of the slide show status code |
|
83 * |
|
84 * @var string The status description |
|
85 */ |
|
86 protected $_statusDescription; |
|
87 |
|
88 /** |
|
89 * The Permanent link for the slide show |
|
90 * |
|
91 * @var string the Permalink for the slide show |
|
92 */ |
|
93 protected $_permalink; |
|
94 |
|
95 /** |
|
96 * The number of views this slide show has received |
|
97 * |
|
98 * @var int the number of views |
|
99 */ |
|
100 protected $_numViews; |
|
101 |
|
102 /** |
|
103 * The ID of the slide show on the server |
|
104 * |
|
105 * @var int the Slide show ID number on the server |
|
106 */ |
|
107 protected $_slideShowId; |
|
108 |
|
109 /** |
|
110 * A slide show filename on the local filesystem (when uploading) |
|
111 * |
|
112 * @var string the local filesystem path & file of the slide show to upload |
|
113 */ |
|
114 protected $_slideShowFilename; |
|
115 |
|
116 /** |
|
117 * An array of tags associated with the slide show |
|
118 * |
|
119 * @var array An array of tags associated with the slide show |
|
120 */ |
|
121 protected $_tags = array(); |
|
122 |
|
123 /** |
|
124 * The location of the slide show |
|
125 * |
|
126 * @var string the Location |
|
127 */ |
|
128 protected $_location; |
|
129 |
|
130 /** |
|
131 * The transcript associated with the slide show |
|
132 * |
|
133 * @var string the Transscript |
|
134 */ |
|
135 protected $_transcript; |
|
136 |
|
137 |
|
138 /** |
|
139 * Retrieves the location of the slide show |
|
140 * |
|
141 * @return string the Location |
|
142 */ |
|
143 public function getLocation() |
|
144 { |
|
145 return $this->_location; |
|
146 } |
|
147 |
|
148 /** |
|
149 * Sets the location of the slide show |
|
150 * |
|
151 * @param string $loc The location to use |
|
152 * @return Zend_Service_SlideShare_SlideShow |
|
153 */ |
|
154 public function setLocation($loc) |
|
155 { |
|
156 $this->_location = (string)$loc; |
|
157 return $this; |
|
158 } |
|
159 |
|
160 /** |
|
161 * Gets the transcript for this slide show |
|
162 * |
|
163 * @return string the Transcript |
|
164 */ |
|
165 public function getTranscript() |
|
166 { |
|
167 return $this->_transcript; |
|
168 } |
|
169 |
|
170 /** |
|
171 * Sets the transcript for this slide show |
|
172 * |
|
173 * @param string $t The transcript |
|
174 * @return Zend_Service_SlideShare_SlideShow |
|
175 */ |
|
176 public function setTranscript($t) |
|
177 { |
|
178 $this->_transcript = (string)$t; |
|
179 return $this; |
|
180 } |
|
181 |
|
182 /** |
|
183 * Adds a tag to the slide show |
|
184 * |
|
185 * @param string $tag The tag to add |
|
186 * @return Zend_Service_SlideShare_SlideShow |
|
187 */ |
|
188 public function addTag($tag) |
|
189 { |
|
190 $this->_tags[] = (string)$tag; |
|
191 return $this; |
|
192 } |
|
193 |
|
194 /** |
|
195 * Sets the tags for the slide show |
|
196 * |
|
197 * @param array $tags An array of tags to set |
|
198 * @return Zend_Service_SlideShare_SlideShow |
|
199 */ |
|
200 public function setTags(Array $tags) |
|
201 { |
|
202 $this->_tags = $tags; |
|
203 return $this; |
|
204 } |
|
205 |
|
206 /** |
|
207 * Gets all of the tags associated with the slide show |
|
208 * |
|
209 * @return array An array of tags for the slide show |
|
210 */ |
|
211 public function getTags() |
|
212 { |
|
213 return $this->_tags; |
|
214 } |
|
215 |
|
216 /** |
|
217 * Sets the filename on the local filesystem of the slide show |
|
218 * (for uploading a new slide show) |
|
219 * |
|
220 * @param string $file The full path & filename to the slide show |
|
221 * @return Zend_Service_SlideShare_SlideShow |
|
222 */ |
|
223 public function setFilename($file) |
|
224 { |
|
225 $this->_slideShowFilename = (string)$file; |
|
226 return $this; |
|
227 } |
|
228 |
|
229 /** |
|
230 * Retrieves the filename on the local filesystem of the slide show |
|
231 * which will be uploaded |
|
232 * |
|
233 * @return string The full path & filename to the slide show |
|
234 */ |
|
235 public function getFilename() |
|
236 { |
|
237 return $this->_slideShowFilename; |
|
238 } |
|
239 |
|
240 /** |
|
241 * Sets the ID for the slide show |
|
242 * |
|
243 * @param int $id The slide show ID |
|
244 * @return Zend_Service_SlideShare_SlideShow |
|
245 */ |
|
246 public function setId($id) |
|
247 { |
|
248 $this->_slideShowId = (string)$id; |
|
249 return $this; |
|
250 } |
|
251 |
|
252 /** |
|
253 * Gets the ID for the slide show |
|
254 * |
|
255 * @return int The slide show ID |
|
256 */ |
|
257 public function getId() |
|
258 { |
|
259 return $this->_slideShowId; |
|
260 } |
|
261 |
|
262 /** |
|
263 * Sets the HTML embed code for the slide show |
|
264 * |
|
265 * @param string $code The HTML embed code |
|
266 * @return Zend_Service_SlideShare_SlideShow |
|
267 */ |
|
268 public function setEmbedCode($code) |
|
269 { |
|
270 $this->_embedCode = (string)$code; |
|
271 return $this; |
|
272 } |
|
273 |
|
274 /** |
|
275 * Retrieves the HTML embed code for the slide show |
|
276 * |
|
277 * @return string the HTML embed code |
|
278 */ |
|
279 public function getEmbedCode() |
|
280 { |
|
281 return $this->_embedCode; |
|
282 } |
|
283 |
|
284 /** |
|
285 * Sets the Thumbnail URI for the slide show |
|
286 * |
|
287 * @param string $url The URI for the thumbnail image |
|
288 * @return Zend_Service_SlideShare_SlideShow |
|
289 */ |
|
290 public function setThumbnailUrl($url) |
|
291 { |
|
292 $this->_thumbnailUrl = (string) $url; |
|
293 return $this; |
|
294 } |
|
295 |
|
296 /** |
|
297 * Retrieves the Thumbnail URi for the slide show |
|
298 * |
|
299 * @return string The URI for the thumbnail image |
|
300 */ |
|
301 public function getThumbnailUrl() |
|
302 { |
|
303 return $this->_thumbnailUrl; |
|
304 } |
|
305 |
|
306 /** |
|
307 * Sets the title for the Slide show |
|
308 * |
|
309 * @param string $title The slide show title |
|
310 * @return Zend_Service_SlideShare_SlideShow |
|
311 */ |
|
312 public function setTitle($title) |
|
313 { |
|
314 $this->_title = (string)$title; |
|
315 return $this; |
|
316 } |
|
317 |
|
318 /** |
|
319 * Retrieves the Slide show title |
|
320 * |
|
321 * @return string the Slide show title |
|
322 */ |
|
323 public function getTitle() |
|
324 { |
|
325 return $this->_title; |
|
326 } |
|
327 |
|
328 /** |
|
329 * Sets the description for the Slide show |
|
330 * |
|
331 * @param strign $desc The description of the slide show |
|
332 * @return Zend_Service_SlideShare_SlideShow |
|
333 */ |
|
334 public function setDescription($desc) |
|
335 { |
|
336 $this->_description = (string)$desc; |
|
337 return $this; |
|
338 } |
|
339 |
|
340 /** |
|
341 * Gets the description of the slide show |
|
342 * |
|
343 * @return string The slide show description |
|
344 */ |
|
345 public function getDescription() |
|
346 { |
|
347 return $this->_description; |
|
348 } |
|
349 |
|
350 /** |
|
351 * Sets the numeric status of the slide show on the server |
|
352 * |
|
353 * @param int $status The numeric status on the server |
|
354 * @return Zend_Service_SlideShare_SlideShow |
|
355 */ |
|
356 public function setStatus($status) |
|
357 { |
|
358 $this->_status = (int)$status; |
|
359 return $this; |
|
360 } |
|
361 |
|
362 /** |
|
363 * Gets the numeric status of the slide show on the server |
|
364 * |
|
365 * @return int A Zend_Service_SlideShare_SlideShow Status constant |
|
366 */ |
|
367 public function getStatus() |
|
368 { |
|
369 return $this->_status; |
|
370 } |
|
371 |
|
372 /** |
|
373 * Sets the textual description of the status of the slide show on the server |
|
374 * |
|
375 * @param string $desc The textual description of the status of the slide show |
|
376 * @return Zend_Service_SlideShare_SlideShow |
|
377 */ |
|
378 public function setStatusDescription($desc) |
|
379 { |
|
380 $this->_statusDescription = (string)$desc; |
|
381 return $this; |
|
382 } |
|
383 |
|
384 /** |
|
385 * Gets the textual description of the status of the slide show on the server |
|
386 * |
|
387 * @return string the textual description of the service |
|
388 */ |
|
389 public function getStatusDescription() |
|
390 { |
|
391 return $this->_statusDescription; |
|
392 } |
|
393 |
|
394 /** |
|
395 * Sets the permanent link of the slide show |
|
396 * |
|
397 * @param string $url The permanent URL for the slide show |
|
398 * @return Zend_Service_SlideShare_SlideShow |
|
399 */ |
|
400 public function setPermaLink($url) |
|
401 { |
|
402 $this->_permalink = (string)$url; |
|
403 return $this; |
|
404 } |
|
405 |
|
406 /** |
|
407 * Gets the permanent link of the slide show |
|
408 * |
|
409 * @return string the permanent URL for the slide show |
|
410 */ |
|
411 public function getPermaLink() |
|
412 { |
|
413 return $this->_permalink; |
|
414 } |
|
415 |
|
416 /** |
|
417 * Sets the number of views the slide show has received |
|
418 * |
|
419 * @param int $views The number of views |
|
420 * @return Zend_Service_SlideShare_SlideShow |
|
421 */ |
|
422 public function setNumViews($views) |
|
423 { |
|
424 $this->_numViews = (int)$views; |
|
425 return $this; |
|
426 } |
|
427 |
|
428 /** |
|
429 * Gets the number of views the slide show has received |
|
430 * |
|
431 * @return int The number of views |
|
432 */ |
|
433 public function getNumViews() |
|
434 { |
|
435 return $this->_numViews; |
|
436 } |
|
437 } |