Startseite Erkunden Hilfe
Registrieren Anmelden
Ayuda_Virtual
/
sloodle_website
2
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki
Branch: master
Branches Tags
sloodle_webs...
/
webroot
/
phpdocs
/
1.0-pre-release
/
sloodle
/
SloodlePluginPresenterPDFImporter.html

SloodlePluginPresenterPDFImporter.html 31 KB
Permalink Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582 
  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos  -->
    6. 

  6. 			<title>Docs For Class SloodlePluginPresenterPDFImporter</title>
    7. 

  7. 			<link rel="stylesheet" href="../media/stylesheet.css" />
    8. 

  8. 						<script src="../media/lib/classTree.js"></script>
    9. 

  9. 												<script language="javascript" type="text/javascript">
    10. 

  10. 				var imgPlus = new Image();
    11. 

  11. 				var imgMinus = new Image();
    12. 

  12. 				imgPlus.src = "../media/images/plus.png";
    13. 

  13. 				imgMinus.src = "../media/images/minus.png";
    14. 

  14. 				
    15. 

  15. 				function showNode(Node){
    16. 

  16. 							switch(navigator.family){
    17. 

  17. 								case 'nn4':
    18. 

  18. 									// Nav 4.x code fork...
    19. 

  19. 							var oTable = document.layers["span" + Node];
    20. 

  20. 							var oImg = document.layers["img" + Node];
    21. 

  21. 									break;
    22. 

  22. 								case 'ie4':
    23. 

  23. 									// IE 4/5 code fork...
    24. 

  24. 							var oTable = document.all["span" + Node];
    25. 

  25. 							var oImg = document.all["img" + Node];
    26. 

  26. 									break;
    27. 

  27. 								case 'gecko':
    28. 

  28. 									// Standards Compliant code fork...
    29. 

  29. 							var oTable = document.getElementById("span" + Node);
    30. 

  30. 							var oImg = document.getElementById("img" + Node);
    31. 

  31. 									break;
    32. 

  32. 							}
    33. 

  33. 					oImg.src = imgMinus.src;
    34. 

  34. 					oTable.style.display = "block";
    35. 

  35. 				}
    36. 

  36. 				
    37. 

  37. 				function hideNode(Node){
    38. 

  38. 							switch(navigator.family){
    39. 

  39. 								case 'nn4':
    40. 

  40. 									// Nav 4.x code fork...
    41. 

  41. 							var oTable = document.layers["span" + Node];
    42. 

  42. 							var oImg = document.layers["img" + Node];
    43. 

  43. 									break;
    44. 

  44. 								case 'ie4':
    45. 

  45. 									// IE 4/5 code fork...
    46. 

  46. 							var oTable = document.all["span" + Node];
    47. 

  47. 							var oImg = document.all["img" + Node];
    48. 

  48. 									break;
    49. 

  49. 								case 'gecko':
    50. 

  50. 									// Standards Compliant code fork...
    51. 

  51. 							var oTable = document.getElementById("span" + Node);
    52. 

  52. 							var oImg = document.getElementById("img" + Node);
    53. 

  53. 									break;
    54. 

  54. 							}
    55. 

  55. 					oImg.src = imgPlus.src;
    56. 

  56. 					oTable.style.display = "none";
    57. 

  57. 				}
    58. 

  58. 				
    59. 

  59. 				function nodeIsVisible(Node){
    60. 

  60. 							switch(navigator.family){
    61. 

  61. 								case 'nn4':
    62. 

  62. 									// Nav 4.x code fork...
    63. 

  63. 							var oTable = document.layers["span" + Node];
    64. 

  64. 									break;
    65. 

  65. 								case 'ie4':
    66. 

  66. 									// IE 4/5 code fork...
    67. 

  67. 							var oTable = document.all["span" + Node];
    68. 

  68. 									break;
    69. 

  69. 								case 'gecko':
    70. 

  70. 									// Standards Compliant code fork...
    71. 

  71. 							var oTable = document.getElementById("span" + Node);
    72. 

  72. 									break;
    73. 

  73. 							}
    74. 

  74. 					return (oTable && oTable.style.display == "block");
    75. 

  75. 				}
    76. 

  76. 				
    77. 

  77. 				function toggleNodeVisibility(Node){
    78. 

  78. 					if (nodeIsVisible(Node)){
    79. 

  79. 						hideNode(Node);
    80. 

  80. 					}else{
    81. 

  81. 						showNode(Node);
    82. 

  82. 					}
    83. 

  83. 				}
    84. 

  84. 			</script>
    85. 

  85. 					</head>
    86. 

  86. 		<body>
    87. 

  87. 			<div class="page-body">			
    88. 

  88. <h2 class="class-name"><img src="../media/images/Class_logo.png"
    89. 

  89. 														alt=" Class"
    90. 

  90. 														title=" Class"
    91. 

  91. 														style="vertical-align: middle"> SloodlePluginPresenterPDFImporter</h2>
    92. 

  92. 

  93. <a name="sec-description"></a>
    94. 

  94. <div class="info-box">
    95. 

  95. 	<div class="info-box-title">Description</div>
    96. 

  96. 	<div class="nav-bar">
    97. 

  97. 					<span class="disabled">Description</span> |
    98. 

  98. 															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    99. 

  99. 						
    100. 

  100. 					</div>
    101. 

  101. 	<div class="info-box-body">
    102. 

  102.         		<!-- ========== Info from phpDoc block ========= -->
    103. 

  103. <p class="short-description">Presenter plugin for importing a PDF file as a series of image slides.</p>
    104. 

  104. 		<p class="notes">
    105. 

  105. 			Located in <a class="field" href="_plugin---presenter---pdfimporter.php.html">/plugin/presenter/pdfimporter.php</a> (line <span class="field"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a31">31</a></span>)
    106. 

  106. 		</p>
    107. 

  107. 		
    108. 

  108. 				
    109. 

  109. 		<pre><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a>
    110. 

  110.    |
    111. 

  111.    --<a href="../sloodle/SloodlePluginBasePresenterImporter.html">SloodlePluginBasePresenterImporter</a>
    112. 

  112.       |
    113. 

  113.       --SloodlePluginPresenterPDFImporter</pre>
    114. 

  114. 	
    115. 

  115. 			</div>
    116. 

  116. </div>
    117. 

  117. 

  118. 

  119. 

  120. 

  121. 	<a name="sec-method-summary"></a>
    122. 

  122. 	<div class="info-box">
    123. 

  123. 		<div class="info-box-title">Method Summary</span></div>
    124. 

  124. 		<div class="nav-bar">
    125. 

  125. 			<a href="#sec-description">Description</a> |
    126. 

  126. 												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    127. 

  127. 		</div>
    128. 

  128. 		<div class="info-box-body">			
    129. 

  129. 			<div class="method-summary">
    130. 

  130. 																																																																																							
    131. 

  131. 				<div class="method-definition">
    132. 

  132. 					<img src="../media/images/Method.png" alt=" "/>
    133. 

  133. 											<span class="method-result">void</span>
    134. 

  134. 										<a href="#get_plugin_description" title="details" class="method-name">get_plugin_description</a>
    135. 

  135. 											([<span class="var-type"></span>&nbsp;<span class="var-name">$lang</span> = <span class="var-default">null</span>])
    136. 

  136. 									</div>
    137. 

  137. 															
    138. 

  138. 				<div class="method-definition">
    139. 

  139. 					<img src="../media/images/Method.png" alt=" "/>
    140. 

  140. 											<span class="method-result">string</span>
    141. 

  141. 										<a href="#get_plugin_name" title="details" class="method-name">get_plugin_name</a>
    142. 

  142. 											([<span class="var-type">string</span>&nbsp;<span class="var-name">$lang</span> = <span class="var-default">null</span>])
    143. 

  143. 									</div>
    144. 

  144. 															
    145. 

  145. 				<div class="method-definition">
    146. 

  146. 					<img src="../media/images/Method.png" alt=" "/>
    147. 

  147. 											<span class="method-result">int</span>
    148. 

  148. 										<a href="#get_version" title="details" class="method-name">get_version</a>
    149. 

  149. 										()
    150. 

  150. 									</div>
    151. 

  151. 															
    152. 

  152. 				<div class="method-definition">
    153. 

  153. 					<img src="../media/images/Method.png" alt=" "/>
    154. 

  154. 											<span class="method-result">bool</span>
    155. 

  155. 										<a href="#import_file" title="details" class="method-name">import_file</a>
    156. 

  156. 											(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    157. 

  157. 									</div>
    158. 

  158. 															
    159. 

  159. 				<div class="method-definition">
    160. 

  160. 					<img src="../media/images/Method.png" alt=" "/>
    161. 

  161. 											<span class="method-result">void</span>
    162. 

  162. 										<a href="#print_slide_position_menu" title="details" class="method-name">print_slide_position_menu</a>
    163. 

  163. 											(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    164. 

  164. 									</div>
    165. 

  165. 															
    166. 

  166. 				<div class="method-definition">
    167. 

  167. 					<img src="../media/images/Method.png" alt=" "/>
    168. 

  168. 											<span class="method-result">bool|string</span>
    169. 

  169. 										<a href="#process_upload" title="details" class="method-name">process_upload</a>
    170. 

  170. 											(<span class="var-type"></span>&nbsp;<span class="var-name">&$path</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
    171. 

  171. 									</div>
    172. 

  172. 															
    173. 

  173. 				<div class="method-definition">
    174. 

  174. 					<img src="../media/images/Method.png" alt=" "/>
    175. 

  175. 											<span class="method-result">void</span>
    176. 

  176. 										<a href="#render" title="details" class="method-name">render</a>
    177. 

  177. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>)
    178. 

  178. 									</div>
    179. 

  179. 															
    180. 

  180. 				<div class="method-definition">
    181. 

  181. 					<img src="../media/images/PrivateMethod.png" alt=" "/>
    182. 

  182. 											<span class="method-result">integer|bool</span>
    183. 

  183. 										<a href="#_import_ImageMagick" title="details" class="method-name">_import_ImageMagick</a>
    184. 

  184. 											(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$srcfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destpath</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$viewurl</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfileext</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destname</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    185. 

  185. 									</div>
    186. 

  186. 															
    187. 

  187. 				<div class="method-definition">
    188. 

  188. 					<img src="../media/images/PrivateMethod.png" alt=" "/>
    189. 

  189. 											<span class="method-result">integer|bool</span>
    190. 

  190. 										<a href="#_import_MagickWand" title="details" class="method-name">_import_MagickWand</a>
    191. 

  191. 											(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$srcfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destpath</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$viewurl</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfileext</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destname</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    192. 

  192. 									</div>
    193. 

  193. 											</div>
    194. 

  194. 		</div>
    195. 

  195. 	</div>		
    196. 

  196. 

  197. 	
    198. 

  198. 	<a name="sec-methods"></a>
    199. 

  199. 	<div class="info-box">
    200. 

  200. 		<div class="info-box-title">Methods</div>
    201. 

  201. 		<div class="nav-bar">
    202. 

  202. 			<a href="#sec-description">Description</a> |
    203. 

  203. 																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    204. 

  204. 						
    205. 

  205. 		</div>
    206. 

  206. 		<div class="info-box-body">
    207. 

  207. 			<A NAME='method_detail'></A>
    208. 

  208. <a name="methodget_plugin_description" id="get_plugin_description"><!-- --></a>
    209. 

  209. <div class="evenrow">
    210. 

  210. 	
    211. 

  211. 	<div class="method-header">
    212. 

  212. 		<img src="../media/images/Method.png" />
    213. 

  213. 		<span class="method-title">get_plugin_description</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a402">402</a></span>)
    214. 

  214. 	</div> 
    215. 

  215. 	
    216. 

  216. 	<!-- ========== Info from phpDoc block ========= -->
    217. 

  217. <p class="short-description">Gets the human-readable description of this plugin.</p>
    218. 

  218. 	
    219. 

  219. 	<div class="method-signature">
    220. 

  220. 		<span class="method-result">void</span>
    221. 

  221. 		<span class="method-name">
    222. 

  222. 			get_plugin_description
    223. 

  223. 		</span>
    224. 

  224. 					([<span class="var-type"></span>&nbsp;<span class="var-name">$lang</span> = <span class="var-default">null</span>])
    225. 

  225. 			</div>
    226. 

  226. 	
    227. 

  227. 			<ul class="parameters">
    228. 

  228. 					<li>
    229. 

  229. 				<span class="var-type"></span>
    230. 

  230. 				<span class="var-name">$lang</span>			</li>
    231. 

  231. 				</ul>
    232. 

  232. 		
    233. 

  233. 			<hr class="separator" />
    234. 

  234. 		<div class="notes">Redefinition of:</div>
    235. 

  235. 		<dl>
    236. 

  236. 			<dt><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_description">SloodlePluginBase::get_plugin_description()</a></dt>
    237. 

  237. 						<dd>Gets the human-readable description of this plugin.</dd>
    238. 

  238. 					</dl>
    239. 

  239. 			
    240. 

  240. 	</div>
    241. 

  241. <a name="methodget_plugin_name" id="get_plugin_name"><!-- --></a>
    242. 

  242. <div class="oddrow">
    243. 

  243. 	
    244. 

  244. 	<div class="method-header">
    245. 

  245. 		<img src="../media/images/Method.png" />
    246. 

  246. 		<span class="method-title">get_plugin_name</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a394">394</a></span>)
    247. 

  247. 	</div> 
    248. 

  248. 	
    249. 

  249. 	<!-- ========== Info from phpDoc block ========= -->
    250. 

  250. <p class="short-description">Gets the human-readable name of this plugin.</p>
    251. 

  251. 	<ul class="tags">
    252. 

  252. 				<li><span class="field">return:</span> The human-readable name of this plugin</li>
    253. 

  253. 				<li><span class="field">access:</span> public</li>
    254. 

  254. 			</ul>
    255. 

  255. 	
    256. 

  256. 	<div class="method-signature">
    257. 

  257. 		<span class="method-result">string</span>
    258. 

  258. 		<span class="method-name">
    259. 

  259. 			get_plugin_name
    260. 

  260. 		</span>
    261. 

  261. 					([<span class="var-type">string</span>&nbsp;<span class="var-name">$lang</span> = <span class="var-default">null</span>])
    262. 

  262. 			</div>
    263. 

  263. 	
    264. 

  264. 			<ul class="parameters">
    265. 

  265. 					<li>
    266. 

  266. 				<span class="var-type">string</span>
    267. 

  267. 				<span class="var-name">$lang</span><span class="var-description">: Optional -- can specify the language we want the plugin name in, as an identifier like &quot;en_utf8&quot;. If unspecified, then the current Moodle language should be used.</span>			</li>
    268. 

  268. 				</ul>
    269. 

  269. 		
    270. 

  270. 			<hr class="separator" />
    271. 

  271. 		<div class="notes">Redefinition of:</div>
    272. 

  272. 		<dl>
    273. 

  273. 			<dt><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_name">SloodlePluginBase::get_plugin_name()</a></dt>
    274. 

  274. 						<dd>Gets the human-readable name of this plugin.</dd>
    275. 

  275. 					</dl>
    276. 

  276. 			
    277. 

  277. 	</div>
    278. 

  278. <a name="methodget_version" id="get_version"><!-- --></a>
    279. 

  279. <div class="evenrow">
    280. 

  280. 	
    281. 

  281. 	<div class="method-header">
    282. 

  282. 		<img src="../media/images/Method.png" />
    283. 

  283. 		<span class="method-title">get_version</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a414">414</a></span>)
    284. 

  284. 	</div> 
    285. 

  285. 	
    286. 

  286. 	<!-- ========== Info from phpDoc block ========= -->
    287. 

  287. <p class="short-description">Gets the internal version number of this plugin.</p>
    288. 

  288. <p class="description"><p>This should be a number like the internal version number for Moodle modules, containing the date and release number.  Format is: YYYYMMDD##.  For example, &quot;2009012302&quot; would be the 3rd release on the 23rd January 2009.</p></p>
    289. 

  289. 	<ul class="tags">
    290. 

  290. 				<li><span class="field">return:</span> The version number of this module.</li>
    291. 

  291. 			</ul>
    292. 

  292. 	
    293. 

  293. 	<div class="method-signature">
    294. 

  294. 		<span class="method-result">int</span>
    295. 

  295. 		<span class="method-name">
    296. 

  296. 			get_version
    297. 

  297. 		</span>
    298. 

  298. 				()
    299. 

  299. 			</div>
    300. 

  300. 	
    301. 

  301. 		
    302. 

  302. 			<hr class="separator" />
    303. 

  303. 		<div class="notes">Redefinition of:</div>
    304. 

  304. 		<dl>
    305. 

  305. 			<dt><a href="../sloodle/SloodlePluginBase.html#methodget_version">SloodlePluginBase::get_version()</a></dt>
    306. 

  306. 						<dd>Gets the internal version number of this plugin.</dd>
    307. 

  307. 					</dl>
    308. 

  308. 			
    309. 

  309. 	</div>
    310. 

  310. <a name="methodimport_file" id="import_file"><!-- --></a>
    311. 

  311. <div class="oddrow">
    312. 

  312. 	
    313. 

  313. 	<div class="method-header">
    314. 

  314. 		<img src="../media/images/Method.png" />
    315. 

  315. 		<span class="method-title">import_file</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a187">187</a></span>)
    316. 

  316. 	</div> 
    317. 

  317. 	
    318. 

  318. 	<!-- ========== Info from phpDoc block ========= -->
    319. 

  319. <p class="short-description">Import a file to this Presenter.</p>
    320. 

  320. 	<ul class="tags">
    321. 

  321. 				<li><span class="field">return:</span> True if successful or false if not.</li>
    322. 

  322. 			</ul>
    323. 

  323. 	
    324. 

  324. 	<div class="method-signature">
    325. 

  325. 		<span class="method-result">bool</span>
    326. 

  326. 		<span class="method-name">
    327. 

  327. 			import_file
    328. 

  328. 		</span>
    329. 

  329. 					(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">''</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    330. 

  330. 			</div>
    331. 

  331. 	
    332. 

  332. 			<ul class="parameters">
    333. 

  333. 					<li>
    334. 

  334. 				<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>
    335. 

  335. 				<span class="var-name">$presenter</span><span class="var-description">: An object representing the Presenter we are importing into.</span>			</li>
    336. 

  336. 					<li>
    337. 

  337. 				<span class="var-type">string</span>
    338. 

  338. 				<span class="var-name">$path</span><span class="var-description">: The path of the file to import (must be local... i.e. on disk!)</span>			</li>
    339. 

  339. 					<li>
    340. 

  340. 				<span class="var-type">string</span>
    341. 

  341. 				<span class="var-name">$name</span><span class="var-description">: Optional -- a name for the import. If omitted, it will be taken from the path.</span>			</li>
    342. 

  342. 					<li>
    343. 

  343. 				<span class="var-type">integer</span>
    344. 

  344. 				<span class="var-name">$position</span><span class="var-description">: The position at which the slides should be imported. Optional. Defaults to import at the end.</span>			</li>
    345. 

  345. 				</ul>
    346. 

  346. 		
    347. 

  347. 			
    348. 

  348. 	</div>
    349. 

  349. <a name="methodprint_slide_position_menu" id="print_slide_position_menu"><!-- --></a>
    350. 

  350. <div class="evenrow">
    351. 

  351. 	
    352. 

  352. 	<div class="method-header">
    353. 

  353. 		<img src="../media/images/Method.png" />
    354. 

  354. 		<span class="method-title">print_slide_position_menu</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a119">119</a></span>)
    355. 

  355. 	</div> 
    356. 

  356. 	
    357. 

  357. 	<!-- ========== Info from phpDoc block ========= -->
    358. 

  358. <p class="short-description">Display a drop-down menu of slides in the current presentation.</p>
    359. 

  359. 	
    360. 

  360. 	<div class="method-signature">
    361. 

  361. 		<span class="method-result">void</span>
    362. 

  362. 		<span class="method-name">
    363. 

  363. 			print_slide_position_menu
    364. 

  364. 		</span>
    365. 

  365. 					(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    366. 

  366. 			</div>
    367. 

  367. 	
    368. 

  368. 			<ul class="parameters">
    369. 

  369. 					<li>
    370. 

  370. 				<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>
    371. 

  371. 				<span class="var-name">$presenter</span><span class="var-description">: An object representing the Preseter to work from.</span>			</li>
    372. 

  372. 					<li>
    373. 

  373. 				<span class="var-type">integer</span>
    374. 

  374. 				<span class="var-name">$position</span><span class="var-description">: Specifies the intially selected position, if known. Defaults to end.</span>			</li>
    375. 

  375. 				</ul>
    376. 

  376. 		
    377. 

  377. 			
    378. 

  378. 	</div>
    379. 

  379. <a name="methodprocess_upload" id="process_upload"><!-- --></a>
    380. 

  380. <div class="oddrow">
    381. 

  381. 	
    382. 

  382. 	<div class="method-header">
    383. 

  383. 		<img src="../media/images/Method.png" />
    384. 

  384. 		<span class="method-title">process_upload</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a155">155</a></span>)
    385. 

  385. 	</div> 
    386. 

  386. 	
    387. 

  387. 	<!-- ========== Info from phpDoc block ========= -->
    388. 

  388. <p class="short-description">Attempt to process a file upload.</p>
    389. 

  389. 	<ul class="tags">
    390. 

  390. 				<li><span class="field">return:</span> Returns true if an upload occurred succesfully. Returns false if no upload has happened. Returns a string containing an error message if an error occurred.</li>
    391. 

  391. 			</ul>
    392. 

  392. 	
    393. 

  393. 	<div class="method-signature">
    394. 

  394. 		<span class="method-result">bool|string</span>
    395. 

  395. 		<span class="method-name">
    396. 

  396. 			process_upload
    397. 

  397. 		</span>
    398. 

  398. 					(<span class="var-type"></span>&nbsp;<span class="var-name">&$path</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
    399. 

  399. 			</div>
    400. 

  400. 	
    401. 

  401. 			<ul class="parameters">
    402. 

  402. 					<li>
    403. 

  403. 				<span class="var-type">string</span>
    404. 

  404. 				<span class="var-name">$path</span><span class="var-description">: [out] This reference parameter will contain the path of the uploaded file if an upload has been performed. It will be empty if no upload has occurred.</span>			</li>
    405. 

  405. 					<li>
    406. 

  406. 				<span class="var-type">string</span>
    407. 

  407. 				<span class="var-name">$name</span><span class="var-description">: [out] This reference parameter will contain the original name of the uploaded file if an upload has been performed.</span>			</li>
    408. 

  408. 					<li>
    409. 

  409. 				<span class="var-type"></span>
    410. 

  410. 				<span class="var-name">&$path</span>			</li>
    411. 

  411. 					<li>
    412. 

  412. 				<span class="var-type"></span>
    413. 

  413. 				<span class="var-name">&$name</span>			</li>
    414. 

  414. 				</ul>
    415. 

  415. 		
    416. 

  416. 			
    417. 

  417. 	</div>
    418. 

  418. <a name="methodrender" id="render"><!-- --></a>
    419. 

  419. <div class="evenrow">
    420. 

  420. 	
    421. 

  421. 	<div class="method-header">
    422. 

  422. 		<img src="../media/images/Method.png" />
    423. 

  423. 		<span class="method-title">render</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a39">39</a></span>)
    424. 

  424. 	</div> 
    425. 

  425. 	
    426. 

  426. 	<!-- ========== Info from phpDoc block ========= -->
    427. 

  427. <p class="short-description">Render this importer on a web page.</p>
    428. 

  428. <p class="description"><p>All importing functionality should be handled by this function as well.</p></p>
    429. 

  429. 	
    430. 

  430. 	<div class="method-signature">
    431. 

  431. 		<span class="method-result">void</span>
    432. 

  432. 		<span class="method-name">
    433. 

  433. 			render
    434. 

  434. 		</span>
    435. 

  435. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>)
    436. 

  436. 			</div>
    437. 

  437. 	
    438. 

  438. 			<ul class="parameters">
    439. 

  439. 					<li>
    440. 

  440. 				<span class="var-type">string</span>
    441. 

  441. 				<span class="var-name">$url</span><span class="var-description">: A URL to this Presenter, without a &quot;mode&quot; parameter.</span>			</li>
    442. 

  442. 					<li>
    443. 

  443. 				<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>
    444. 

  444. 				<span class="var-name">$presenter</span><span class="var-description">: An object representing this Presenter.</span>			</li>
    445. 

  445. 				</ul>
    446. 

  446. 		
    447. 

  447. 			
    448. 

  448. 	</div>
    449. 

  449. <a name="method_import_ImageMagick" id="_import_ImageMagick"><!-- --></a>
    450. 

  450. <div class="oddrow">
    451. 

  451. 	
    452. 

  452. 	<div class="method-header">
    453. 

  453. 		<img src="../media/images/PrivateMethod.png" />
    454. 

  454. 		<span class="method-title">_import_ImageMagick</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a333">333</a></span>)
    455. 

  455. 	</div> 
    456. 

  456. 	
    457. 

  457. 	<!-- ========== Info from phpDoc block ========= -->
    458. 

  458. <p class="short-description">Imports the given file using the ImageMagick command line programs if possible. (Internal only)</p>
    459. 

  459. 	<ul class="tags">
    460. 

  460. 				<li><span class="field">return:</span> If successful, an integer indicating the number of slides loaded is displayed. If the import does not (or cannot) work, then boolean false is returned.</li>
    461. 

  461. 				<li><span class="field">access:</span> private</li>
    462. 

  462. 			</ul>
    463. 

  463. 	
    464. 

  464. 	<div class="method-signature">
    465. 

  465. 		<span class="method-result">integer|bool</span>
    466. 

  466. 		<span class="method-name">
    467. 

  467. 			_import_ImageMagick
    468. 

  468. 		</span>
    469. 

  469. 					(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$srcfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destpath</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$viewurl</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfileext</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destname</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    470. 

  470. 			</div>
    471. 

  471. 	
    472. 

  472. 			<ul class="parameters">
    473. 

  473. 					<li>
    474. 

  474. 				<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>
    475. 

  475. 				<span class="var-name">$presenter</span><span class="var-description">: An object representing the Presenter we are importing into.</span>			</li>
    476. 

  476. 					<li>
    477. 

  477. 				<span class="var-type">string</span>
    478. 

  478. 				<span class="var-name">$srcfile</span><span class="var-description">: Full path of the PDF file we are importing</span>			</li>
    479. 

  479. 					<li>
    480. 

  480. 				<span class="var-type">string</span>
    481. 

  481. 				<span class="var-name">$destpath</span><span class="var-description">: Folder path to which the imported files will be added.</span>			</li>
    482. 

  482. 					<li>
    483. 

  483. 				<span class="var-type">string</span>
    484. 

  484. 				<span class="var-name">$viewurl</span><span class="var-description">: URl of the folder in which the files can be viewed</span>			</li>
    485. 

  485. 					<li>
    486. 

  486. 				<span class="var-type">string</span>
    487. 

  487. 				<span class="var-name">$destfile</span><span class="var-description">: Name for the output files (excluding extension, such as .jpg). The page numbers will be appended automatically, before the extension</span>			</li>
    488. 

  488. 					<li>
    489. 

  489. 				<span class="var-type">string</span>
    490. 

  490. 				<span class="var-name">$destfileext</span><span class="var-description">: Extension for destination files, not including the dot. (e.g. &quot;jpg&quot; or &quot;png&quot;).</span>			</li>
    491. 

  491. 					<li>
    492. 

  492. 				<span class="var-type">string</span>
    493. 

  493. 				<span class="var-name">$destname</span><span class="var-description">: Basic name to use for each imported slide. The page numbers will be appended automatically.</span>			</li>
    494. 

  494. 					<li>
    495. 

  495. 				<span class="var-type">integer</span>
    496. 

  496. 				<span class="var-name">$position</span><span class="var-description">: The position within the Presentation to add the new slides. Optional. Default is to put them at the end.</span>			</li>
    497. 

  497. 				</ul>
    498. 

  498. 		
    499. 

  499. 			
    500. 

  500. 	</div>
    501. 

  501. <a name="method_import_MagickWand" id="_import_MagickWand"><!-- --></a>
    502. 

  502. <div class="evenrow">
    503. 

  503. 	
    504. 

  504. 	<div class="method-header">
    505. 

  505. 		<img src="../media/images/PrivateMethod.png" />
    506. 

  506. 		<span class="method-title">_import_MagickWand</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__pluginpresenterpdfimporter.php.html#a248">248</a></span>)
    507. 

  507. 	</div> 
    508. 

  508. 	
    509. 

  509. 	<!-- ========== Info from phpDoc block ========= -->
    510. 

  510. <p class="short-description">Imports the given file using the MagickWand extension if possible. (Internal only)</p>
    511. 

  511. 	<ul class="tags">
    512. 

  512. 				<li><span class="field">return:</span> If successful, an integer indicating the number of slides loaded is displayed. If the import does not (or cannot) work, then boolean false is returned.</li>
    513. 

  513. 				<li><span class="field">access:</span> private</li>
    514. 

  514. 			</ul>
    515. 

  515. 	
    516. 

  516. 	<div class="method-signature">
    517. 

  517. 		<span class="method-result">integer|bool</span>
    518. 

  518. 		<span class="method-name">
    519. 

  519. 			_import_MagickWand
    520. 

  520. 		</span>
    521. 

  521. 					(<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>&nbsp;<span class="var-name">$presenter</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$srcfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destpath</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$viewurl</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfile</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destfileext</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$destname</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$position</span> = <span class="var-default">-1</span>])
    522. 

  522. 			</div>
    523. 

  523. 	
    524. 

  524. 			<ul class="parameters">
    525. 

  525. 					<li>
    526. 

  526. 				<span class="var-type"><a href="../sloodle/SloodleModulePresenter.html">SloodleModulePresenter</a></span>
    527. 

  527. 				<span class="var-name">$presenter</span><span class="var-description">: An object representing the Presenter we are importing into.</span>			</li>
    528. 

  528. 					<li>
    529. 

  529. 				<span class="var-type">string</span>
    530. 

  530. 				<span class="var-name">$srcfile</span><span class="var-description">: Full path of the PDF file we are importing</span>			</li>
    531. 

  531. 					<li>
    532. 

  532. 				<span class="var-type">string</span>
    533. 

  533. 				<span class="var-name">$destpath</span><span class="var-description">: Folder path to which the imported files will be added.</span>			</li>
    534. 

  534. 					<li>
    535. 

  535. 				<span class="var-type">string</span>
    536. 

  536. 				<span class="var-name">$viewurl</span><span class="var-description">: URL of the folder in which the imported files will be viewed</span>			</li>
    537. 

  537. 					<li>
    538. 

  538. 				<span class="var-type">string</span>
    539. 

  539. 				<span class="var-name">$destfile</span><span class="var-description">: Name for the output files (excluding extension, such as .jpg). The page numbers will be appended automatically, before the extension</span>			</li>
    540. 

  540. 					<li>
    541. 

  541. 				<span class="var-type">string</span>
    542. 

  542. 				<span class="var-name">$destfileext</span><span class="var-description">: Extension for destination files, not including the dot. (e.g. &quot;jpg&quot; or &quot;png&quot;).</span>			</li>
    543. 

  543. 					<li>
    544. 

  544. 				<span class="var-type">string</span>
    545. 

  545. 				<span class="var-name">$destname</span><span class="var-description">: Basic name to use for each imported slide. The page numbers will be appended automatically.</span>			</li>
    546. 

  546. 					<li>
    547. 

  547. 				<span class="var-type">integer</span>
    548. 

  548. 				<span class="var-name">$position</span><span class="var-description">: The position within the Presentation to add the new slides. Optional. Default is to put them at the end.</span>			</li>
    549. 

  549. 				</ul>
    550. 

  550. 		
    551. 

  551. 			
    552. 

  552. 	</div>
    553. 

  553. 							<h4>Inherited Methods</h4>
    554. 

  554. 				<a name='inherited_methods'><!-- --></a>	
    555. 

  555. 									<!-- =========== Summary =========== -->
    556. 

  556. 					<p>Inherited From <span class="classname"><a href="../sloodle/SloodlePluginBasePresenterImporter.html">SloodlePluginBasePresenterImporter</a></span></p>
    557. 

  557. 					<blockquote>
    558. 

  558. 													<img src="../media/images/Method.png" alt=" "/>
    559. 

  559. 							<span class="method-name"><a href="../sloodle/SloodlePluginBasePresenterImporter.html#methodimport">SloodlePluginBasePresenterImporter::import()</a></span><br>
    560. 

  560. 											</blockquote>
    561. 

  561. 									<!-- =========== Summary =========== -->
    562. 

  562. 					<p>Inherited From <span class="classname"><a href="../sloodle/SloodlePluginBase.html">SloodlePluginBase</a></span></p>
    563. 

  563. 					<blockquote>
    564. 

  564. 													<img src="../media/images/Method.png" alt=" "/>
    565. 

  565. 							<span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_id">SloodlePluginBase::get_id()</a></span><br>
    566. 

  566. 													<img src="../media/images/Method.png" alt=" "/>
    567. 

  567. 							<span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_description">SloodlePluginBase::get_plugin_description()</a></span><br>
    568. 

  568. 													<img src="../media/images/Method.png" alt=" "/>
    569. 

  569. 							<span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_plugin_name">SloodlePluginBase::get_plugin_name()</a></span><br>
    570. 

  570. 													<img src="../media/images/Method.png" alt=" "/>
    571. 

  571. 							<span class="method-name"><a href="../sloodle/SloodlePluginBase.html#methodget_version">SloodlePluginBase::get_version()</a></span><br>
    572. 

  572. 											</blockquote>
    573. 

  573. 										
    574. 

  574. 		</div>
    575. 

  575. 	</div>
    576. 

  576. 

  577. 	
    578. 

  578. 	<p class="notes" id="credit">
    579. 

  579. 		Documentation generated on Fri, 17 Jul 2009 11:02:21 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
    580. 

  580. 	</p>
    581. 

  581. 	</div></body>
    582. 

  582. </html>
    583.