PageRenderTime 54ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/music/lib/docs/php-reader/ASF/ASF_Object_ContentDescription.html

http://xepec.googlecode.com/
HTML | 325 lines | 258 code | 58 blank | 9 comment | 0 complexity | 914b477baa0e750ea3ab1cdbc48487a8 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1 
    

  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 ASF_Object_ContentDescription</title>

    7. 

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

    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>

    9. 

  9. 		</head>

    10. 

  10. 		<body>

    11. 

  11. 			<div class="page-body">			


    12. 

  12. <h2 class="class-name">Class ASF_Object_ContentDescription</h2>

    13. 

  13. 

    14. 

  14. <a name="sec-description"></a>

    15. 

  15. <div class="info-box">

    16. 

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

    17. 

  17. 	<div class="nav-bar">

    18. 

  18. 					<span class="disabled">Description</span> |

    19. 

  19. 													<a href="#sec-vars">Vars</a>

    20. 

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

    21. 

  21. 						

    22. 

  22. 					</div>

    23. 

  23. 	<div class="info-box-body">

    24. 

  24.         		<!-- ========== Info from phpDoc block ========= -->

    25. 

  25. <p class="short-description">The <em>Content Description Object</em> lets authors record well-known data  describing the file and its contents. This object is used to store standard  bibliographic information such as title, author, copyright, description, and  rating information. This information is pertinent to the entire file.</p>

    26. 

  26. 	<ul class="tags">

    27. 

  27. 				<li><span class="field">author:</span> Sven Vollbehr &lt;<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>&gt;</li>

    28. 

  28. 				<li><span class="field">version:</span> $Rev: 102 $</li>

    29. 

  29. 				<li><span class="field">copyright:</span> Copyright (c) 2006-2008 The PHP Reader Project Workgroup</li>

    30. 

  30. 				<li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>

    31. 

  31. 			</ul>

    32. 

  32. 		<p class="notes">

    33. 

  33. 			Located in <a class="field" href="_ASF---Object---ContentDescription.php.html">/ASF/Object/ContentDescription.php</a> (line <span class="field">56</span>)

    34. 

  34. 		</p>

    35. 

  35. 		

    36. 

  36. 				

    37. 

  37. 		<pre><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a>
    38. 

  38.    |
    39. 

  39.    --ASF_Object_ContentDescription</pre>

    40. 

  40. 	

    41. 

  41. 			</div>

    42. 

  42. </div>

    43. 

  43. 

    44. 

  44. 

    45. 

  45. 

    46. 

  46. 

    47. 

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

    48. 

  48. 	<div class="info-box">

    49. 

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

    50. 

  50. 		<div class="nav-bar">

    51. 

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

    52. 

  52. 																		<a href="#sec-vars">Vars</a>

    53. 

  53. 				 

    54. 

  54. 				|

    55. 

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

    56. 

  56. 		</div>

    57. 

  57. 		<div class="info-box-body">			

    58. 

  58. 			<div class="method-summary">

    59. 

  59. 																																																				

    60. 

  60. 												<div class="method-definition">

    61. 

  61. 											<span class="method-result">ASF_Object_ContentDescription</span>

    62. 

  62. 										<a href="#__construct" title="details" class="method-name">__construct</a>

    63. 

  63. 											(<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>&nbsp;<span class="var-name">$reader</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)

    64. 

  64. 									</div>

    65. 

  65. 																<div class="method-definition">

    66. 

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

    67. 

  67. 										<a href="#getAuthor" title="details" class="method-name">getAuthor</a>

    68. 

  68. 										()

    69. 

  69. 									</div>

    70. 

  70. 																<div class="method-definition">

    71. 

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

    72. 

  72. 										<a href="#getCopyright" title="details" class="method-name">getCopyright</a>

    73. 

  73. 										()

    74. 

  74. 									</div>

    75. 

  75. 																<div class="method-definition">

    76. 

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

    77. 

  77. 										<a href="#getDescription" title="details" class="method-name">getDescription</a>

    78. 

  78. 										()

    79. 

  79. 									</div>

    80. 

  80. 																<div class="method-definition">

    81. 

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

    82. 

  82. 										<a href="#getRating" title="details" class="method-name">getRating</a>

    83. 

  83. 										()

    84. 

  84. 									</div>

    85. 

  85. 																<div class="method-definition">

    86. 

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

    87. 

  87. 										<a href="#getTitle" title="details" class="method-name">getTitle</a>

    88. 

  88. 										()

    89. 

  89. 									</div>

    90. 

  90. 								</div>

    91. 

  91. 		</div>

    92. 

  92. 	</div>		

    93. 

  93. 

    94. 

  94. 	<a name="sec-vars"></a>

    95. 

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

    96. 

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

    97. 

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

    98. 

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

    99. 

  99. 										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)

    100. 

  100. 						

    101. 

  101. 			

    102. 

  102. 										| 

    103. 

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

    104. 

  104. 							

    105. 

  105. 					</div>

    106. 

  106. 		<div class="info-box-body">

    107. 

  107. 			
							<h4>Inherited Variables</h4>

    108. 

  108. 				<A NAME='inherited_vars'><!-- --></A>

    109. 

  109. 									<p>Inherited from <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>

    110. 

  110. 					<blockquote>

    111. 

  111. 													<span class="var-title">

    112. 

  112. 								<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_options">ASF_Object::$_options</a></span><br>

    113. 

  113. 							</span>

    114. 

  114. 													<span class="var-title">

    115. 

  115. 								<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_reader">ASF_Object::$_reader</a></span><br>

    116. 

  116. 							</span>

    117. 

  117. 											</blockquote> 

    118. 

  118. 										

    119. 

  119. 		</div>

    120. 

  120. 	</div>

    121. 

  121. 	

    122. 

  122. 	<a name="sec-methods"></a>

    123. 

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

    124. 

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

    125. 

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

    126. 

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

    127. 

  127. 															<a href="#sec-vars">Vars</a>

    128. 

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

    129. 

  129. 						

    130. 

  130. 		</div>

    131. 

  131. 		<div class="info-box-body">

    132. 

  132. 			<A NAME='method_detail'></A>

    133. 

  133. 

    134. 

  134. <a name="method__construct" id="__construct"><!-- --></a>

    135. 

  135. <div class="oddrow">

    136. 

  136. 	

    137. 

  137. 	<div class="method-header">

    138. 

  138. 		<span class="method-title">Constructor __construct</span> (line <span class="line-number">80</span>)

    139. 

  139. 	</div> 

    140. 

  140. 	

    141. 

  141. 	<!-- ========== Info from phpDoc block ========= -->

    142. 

  142. <p class="short-description">Constructs the class with given parameters and reads object related data  from the ASF file.</p>

    143. 

  143. 	<ul class="tags">

    144. 

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

    145. 

  145. 			</ul>

    146. 

  146. 	

    147. 

  147. 	<div class="method-signature">

    148. 

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

    149. 

  149. 		<span class="method-name">

    150. 

  150. 			__construct

    151. 

  151. 		</span>

    152. 

  152. 					(<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>&nbsp;<span class="var-name">$reader</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)

    153. 

  153. 			</div>

    154. 

  154. 	

    155. 

  155. 			<ul class="parameters">

    156. 

  156. 					<li>

    157. 

  157. 				<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>

    158. 

  158. 				<span class="var-name">$reader</span><span class="var-description">: The reader object.</span>			</li>

    159. 

  159. 					<li>

    160. 

  160. 				<span class="var-type">Array</span>

    161. 

  161. 				<span class="var-name">$options</span><span class="var-description">: The options array.</span>			</li>

    162. 

  162. 					<li>

    163. 

  163. 				<span class="var-type"></span>

    164. 

  164. 				<span class="var-name">&$options</span>			</li>

    165. 

  165. 				</ul>

    166. 

  166. 		

    167. 

  167. 			<hr class="separator" />

    168. 

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

    169. 

  169. 		<dl>

    170. 

  170. 			<dt><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></dt>

    171. 

  171. 						<dd>Constructs the class with given parameters and options.</dd>

    172. 

  172. 					</dl>

    173. 

  173. 			

    174. 

  174. 	</div>

    175. 

  175. <a name="methodgetAuthor" id="getAuthor"><!-- --></a>

    176. 

  176. <div class="evenrow">

    177. 

  177. 	

    178. 

  178. 	<div class="method-header">

    179. 

  179. 		<span class="method-title">getAuthor</span> (line <span class="line-number">119</span>)

    180. 

  180. 	</div> 

    181. 

  181. 	

    182. 

  182. 	<!-- ========== Info from phpDoc block ========= -->

    183. 

  183. <p class="short-description">Returns the author information.</p>

    184. 

  184. 	<ul class="tags">

    185. 

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

    186. 

  186. 			</ul>

    187. 

  187. 	

    188. 

  188. 	<div class="method-signature">

    189. 

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

    190. 

  190. 		<span class="method-name">

    191. 

  191. 			getAuthor

    192. 

  192. 		</span>

    193. 

  193. 				()

    194. 

  194. 			</div>

    195. 

  195. 	

    196. 

  196. 		

    197. 

  197. 			

    198. 

  198. 	</div>

    199. 

  199. <a name="methodgetCopyright" id="getCopyright"><!-- --></a>

    200. 

  200. <div class="oddrow">

    201. 

  201. 	

    202. 

  202. 	<div class="method-header">

    203. 

  203. 		<span class="method-title">getCopyright</span> (line <span class="line-number">126</span>)

    204. 

  204. 	</div> 

    205. 

  205. 	

    206. 

  206. 	<!-- ========== Info from phpDoc block ========= -->

    207. 

  207. <p class="short-description">Returns the copyright information.</p>

    208. 

  208. 	<ul class="tags">

    209. 

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

    210. 

  210. 			</ul>

    211. 

  211. 	

    212. 

  212. 	<div class="method-signature">

    213. 

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

    214. 

  214. 		<span class="method-name">

    215. 

  215. 			getCopyright

    216. 

  216. 		</span>

    217. 

  217. 				()

    218. 

  218. 			</div>

    219. 

  219. 	

    220. 

  220. 		

    221. 

  221. 			

    222. 

  222. 	</div>

    223. 

  223. <a name="methodgetDescription" id="getDescription"><!-- --></a>

    224. 

  224. <div class="evenrow">

    225. 

  225. 	

    226. 

  226. 	<div class="method-header">

    227. 

  227. 		<span class="method-title">getDescription</span> (line <span class="line-number">133</span>)

    228. 

  228. 	</div> 

    229. 

  229. 	

    230. 

  230. 	<!-- ========== Info from phpDoc block ========= -->

    231. 

  231. <p class="short-description">Returns the description information.</p>

    232. 

  232. 	<ul class="tags">

    233. 

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

    234. 

  234. 			</ul>

    235. 

  235. 	

    236. 

  236. 	<div class="method-signature">

    237. 

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

    238. 

  238. 		<span class="method-name">

    239. 

  239. 			getDescription

    240. 

  240. 		</span>

    241. 

  241. 				()

    242. 

  242. 			</div>

    243. 

  243. 	

    244. 

  244. 		

    245. 

  245. 			

    246. 

  246. 	</div>

    247. 

  247. <a name="methodgetRating" id="getRating"><!-- --></a>

    248. 

  248. <div class="oddrow">

    249. 

  249. 	

    250. 

  250. 	<div class="method-header">

    251. 

  251. 		<span class="method-title">getRating</span> (line <span class="line-number">140</span>)

    252. 

  252. 	</div> 

    253. 

  253. 	

    254. 

  254. 	<!-- ========== Info from phpDoc block ========= -->

    255. 

  255. <p class="short-description">Returns the rating information.</p>

    256. 

  256. 	<ul class="tags">

    257. 

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

    258. 

  258. 			</ul>

    259. 

  259. 	

    260. 

  260. 	<div class="method-signature">

    261. 

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

    262. 

  262. 		<span class="method-name">

    263. 

  263. 			getRating

    264. 

  264. 		</span>

    265. 

  265. 				()

    266. 

  266. 			</div>

    267. 

  267. 	

    268. 

  268. 		

    269. 

  269. 			

    270. 

  270. 	</div>

    271. 

  271. <a name="methodgetTitle" id="getTitle"><!-- --></a>

    272. 

  272. <div class="evenrow">

    273. 

  273. 	

    274. 

  274. 	<div class="method-header">

    275. 

  275. 		<span class="method-title">getTitle</span> (line <span class="line-number">112</span>)

    276. 

  276. 	</div> 

    277. 

  277. 	

    278. 

  278. 	<!-- ========== Info from phpDoc block ========= -->

    279. 

  279. <p class="short-description">Returns the title information.</p>

    280. 

  280. 	<ul class="tags">

    281. 

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

    282. 

  282. 			</ul>

    283. 

  283. 	

    284. 

  284. 	<div class="method-signature">

    285. 

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

    286. 

  286. 		<span class="method-name">

    287. 

  287. 			getTitle

    288. 

  288. 		</span>

    289. 

  289. 				()

    290. 

  290. 			</div>

    291. 

  291. 	

    292. 

  292. 		

    293. 

  293. 			

    294. 

  294. 	</div>

    295. 

  295. 							<h4>Inherited Methods</h4>

    296. 

  296. 				<a name='inherited_methods'><!-- --></a>	

    297. 

  297. 									<!-- =========== Summary =========== -->

    298. 

  298. 					<p>Inherited From <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>

    299. 

  299. 					<blockquote>

    300. 

  300. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></span><br>

    301. 

  301. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetIdentifier">ASF_Object::getIdentifier()</a></span><br>

    302. 

  302. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOffset">ASF_Object::getOffset()</a></span><br>

    303. 

  303. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOption">ASF_Object::getOption()</a></span><br>

    304. 

  304. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOptions">ASF_Object::getOptions()</a></span><br>

    305. 

  305. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetParent">ASF_Object::getParent()</a></span><br>

    306. 

  306. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetSize">ASF_Object::getSize()</a></span><br>

    307. 

  307. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetIdentifier">ASF_Object::setIdentifier()</a></span><br>

    308. 

  308. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOffset">ASF_Object::setOffset()</a></span><br>

    309. 

  309. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOption">ASF_Object::setOption()</a></span><br>

    310. 

  310. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOptions">ASF_Object::setOptions()</a></span><br>

    311. 

  311. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetParent">ASF_Object::setParent()</a></span><br>

    312. 

  312. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetSize">ASF_Object::setSize()</a></span><br>

    313. 

  313. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__get">ASF_Object::__get()</a></span><br>

    314. 

  314. 													<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__set">ASF_Object::__set()</a></span><br>

    315. 

  315. 											</blockquote>

    316. 

  316. 										

    317. 

  317. 		</div>

    318. 

  318. 	</div>

    319. 

  319. 

    320. 

  320. 

    321. 

  321. 	<p class="notes" id="credit">

    322. 

  322. 		Documentation generated on Thu, 01 Jan 2009 14:59:10 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>

    323. 

  323. 	</p>

    324. 

  324. 	</div></body>

    325. 

  325. </html>

    326.