/Resources/phpdoc/default/AbstractBoleto.html

https://github.com/rafaelgou/PHPBol · HTML · 440 lines · 339 code · 89 blank · 12 comment · 0 complexity · 89635444234546c6fe60940f0c04d05a MD5 · raw file 

    

  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 AbstractBoleto</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 AbstractBoleto</h2>
    13. 

  13. 

  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-descendents">Descendents</a>
    20. 

  20. 			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    21. 

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

  22. 						
    23. 

  23. 					</div>
    24. 

  24. 	<div class="info-box-body">
    25. 

  25.         		<!-- ========== Info from phpDoc block ========= -->
    26. 

  26. <p class="short-description">Abstract Class to Boletos  Contains common methods to all banks</p>
    27. 

  27. 	<ul class="tags">
    28. 

  28. 				<li><span class="field">author:</span> Francisco Luz &lt;<a href="mailto:drupalist@naosei.com">drupalist@naosei.com</a>&gt;</li>
    29. 

  29. 				<li><span class="field">author:</span> Rafael Goulart &lt;<a href="mailto:rafaelgou@gmail.com">rafaelgou@gmail.com</a>&gt;</li>
    30. 

  30. 			</ul>
    31. 

  31. 		<p class="notes">
    32. 

  32. 			Located in <a class="field" href="_PHPBol---Boleto---AbstractBoleto.php.html">/PHPBol/Boleto/AbstractBoleto.php</a> (line <span class="field">21</span>)
    33. 

  33. 		</p>
    34. 

  34. 		
    35. 

  35. 				
    36. 

  36. 		<pre>Data
    37. 

  37.    |
    38. 

  38.    --AbstractBoleto</pre>
    39. 

  39. 	
    40. 

  40. 			</div>
    41. 

  41. </div>
    42. 

  42. 

  43. 	<a name="sec-descendents"></a>
    44. 

  44. 	<div class="info-box">
    45. 

  45. 		<div class="info-box-title">Direct descendents</div>
    46. 

  46. 		<div class="nav-bar">
    47. 

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

  48. 			<span class="disabled">Descendents</span>
    49. 

  49. 			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    50. 

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

  51. 							
    52. 

  52. 								</div>
    53. 

  53. 		<div class="info-box-body">
    54. 

  54. 			<table cellpadding="2" cellspacing="0" class="class-table">
    55. 

  55. 				<tr>
    56. 

  56. 					<th class="class-table-header">Class</th>
    57. 

  57. 					<th class="class-table-header">Description</th>
    58. 

  58. 				</tr>
    59. 

  59. 								<tr>
    60. 

  60. 					<td style="padding-right: 2em"><a href="../default/BoletoBB.html">BoletoBB</a></td>
    61. 

  61. 					<td>
    62. 

  62. 											Abstração para Boletos  Contém funções elementares para todos Templates
    63. 

  63. 										</td>
    64. 

  64. 				</tr>
    65. 

  65. 							</table>
    66. 

  66. 		</div>
    67. 

  67. 	</div>
    68. 

  68. 

  69. 

  70. 	<a name="sec-var-summary"></a>
    71. 

  71. 	<div class="info-box">
    72. 

  72. 		<div class="info-box-title">Variable Summary</span></div>
    73. 

  73. 		<div class="nav-bar">
    74. 

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

  75. 							<a href="#sec-descendents">Descendents</a> |
    76. 

  76. 						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
    77. 

  77. 							| 
    78. 

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

  79. 							
    80. 

  80. 								</div>
    81. 

  81. 		<div class="info-box-body">
    82. 

  82. 			<div class="var-summary">
    83. 

  83. 																																																								<div class="var-title">
    84. 

  84. 					<span class="var-type">\PHPBol\Data\BasicAvalista</span>
    85. 

  85. 					<a href="#$avalista" title="details" class="var-name">$avalista</a>
    86. 

  86. 				</div>
    87. 

  87. 																<div class="var-title">
    88. 

  88. 					<span class="var-type">\PHPBol\Data\BasicBoleto</span>
    89. 

  89. 					<a href="#$boletoData" title="details" class="var-name">$boletoData</a>
    90. 

  90. 				</div>
    91. 

  91. 																<div class="var-title">
    92. 

  92. 					<span class="var-type">\PHPBol\Data\BasicCedente</span>
    93. 

  93. 					<a href="#$cedente" title="details" class="var-name">$cedente</a>
    94. 

  94. 				</div>
    95. 

  95. 																<div class="var-title">
    96. 

  96. 					<span class="var-type">array</span>
    97. 

  97. 					<a href="#$classes" title="details" class="var-name">$classes</a>
    98. 

  98. 				</div>
    99. 

  99. 																<div class="var-title">
    100. 

  100. 					<span class="var-type">\PHPBol\Data\BasicSacado</span>
    101. 

  101. 					<a href="#$sacado" title="details" class="var-name">$sacado</a>
    102. 

  102. 				</div>
    103. 

  103. 											</div>
    104. 

  104. 		</div>
    105. 

  105. 	</div>
    106. 

  106. 

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

  108. 	<div class="info-box">
    109. 

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

  110. 		<div class="nav-bar">
    111. 

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

  112. 							<a href="#sec-descendents">Descendents</a> |
    113. 

  113. 																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    114. 

  114. 				 
    115. 

  115. 				|
    116. 

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

  117. 		</div>
    118. 

  118. 		<div class="info-box-body">			
    119. 

  119. 			<div class="method-summary">
    120. 

  120. 																																												
    121. 

  121. 												<div class="method-definition">
    122. 

  122. 											<span class="method-result">array</span>
    123. 

  123. 										<a href="#getMetadata" title="details" class="method-name">getMetadata</a>
    124. 

  124. 										()
    125. 

  125. 									</div>
    126. 

  126. 																<div class="method-definition">
    127. 

  127. 											<span class="method-result">void</span>
    128. 

  128. 										<a href="#setAvalista" title="details" class="method-name">setAvalista</a>
    129. 

  129. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$avalista</span>)
    130. 

  130. 									</div>
    131. 

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

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

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

  134. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boletoData</span>)
    135. 

  135. 									</div>
    136. 

  136. 																<div class="method-definition">
    137. 

  137. 											<span class="method-result">void</span>
    138. 

  138. 										<a href="#setCedente" title="details" class="method-name">setCedente</a>
    139. 

  139. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$cedente</span>)
    140. 

  140. 									</div>
    141. 

  141. 																<div class="method-definition">
    142. 

  142. 											<span class="method-result">void</span>
    143. 

  143. 										<a href="#setSacado" title="details" class="method-name">setSacado</a>
    144. 

  144. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$sacado</span>)
    145. 

  145. 									</div>
    146. 

  146. 								</div>
    147. 

  147. 		</div>
    148. 

  148. 	</div>		
    149. 

  149. 

  150. 	<a name="sec-vars"></a>
    151. 

  151. 	<div class="info-box">
    152. 

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

  153. 		<div class="nav-bar">
    154. 

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

  155. 							<a href="#sec-descendents">Descendents</a> |
    156. 

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

  157. 						
    158. 

  158. 			
    159. 

  159. 										| 
    160. 

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

  161. 							
    162. 

  162. 					</div>
    163. 

  163. 		<div class="info-box-body">
    164. 

  164. 			<a name="var$avalista" id="$avalista"><!-- --></A>
    165. 

  165. <div class="evenrow">
    166. 

  166. 

  167. 	<div class="var-header">
    168. 

  168. 		<span class="var-title">
    169. 

  169. 			<span class="var-type">\PHPBol\Data\BasicAvalista</span>
    170. 

  170. 			<span class="var-name">$avalista</span>
    171. 

  171. 						(line <span class="line-number">40</span>)
    172. 

  172. 		</span>
    173. 

  173. 	</div>
    174. 

  174. 

  175. 	<!-- ========== Info from phpDoc block ========= -->
    176. 

  176. <p class="short-description">Avalista</p>
    177. 

  177. 	<ul class="tags">
    178. 

  178. 				<li><span class="field">access:</span> protected</li>
    179. 

  179. 			</ul>
    180. 

  180. 	
    181. 

  181. 	
    182. 

  182. 		
    183. 

  183. 		
    184. 

  184. 

  185. </div>
    186. 

  186. <a name="var$boletoData" id="$boletoData"><!-- --></A>
    187. 

  187. <div class="oddrow">
    188. 

  188. 

  189. 	<div class="var-header">
    190. 

  190. 		<span class="var-title">
    191. 

  191. 			<span class="var-type">\PHPBol\Data\BasicBoleto</span>
    192. 

  192. 			<span class="var-name">$boletoData</span>
    193. 

  193. 						(line <span class="line-number">46</span>)
    194. 

  194. 		</span>
    195. 

  195. 	</div>
    196. 

  196. 

  197. 	<!-- ========== Info from phpDoc block ========= -->
    198. 

  198. <p class="short-description">BoletoData</p>
    199. 

  199. 	<ul class="tags">
    200. 

  200. 				<li><span class="field">access:</span> protected</li>
    201. 

  201. 			</ul>
    202. 

  202. 	
    203. 

  203. 	
    204. 

  204. 		
    205. 

  205. 		
    206. 

  206. 

  207. </div>
    208. 

  208. <a name="var$cedente" id="$cedente"><!-- --></A>
    209. 

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

  210. 

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

  212. 		<span class="var-title">
    213. 

  213. 			<span class="var-type">\PHPBol\Data\BasicCedente</span>
    214. 

  214. 			<span class="var-name">$cedente</span>
    215. 

  215. 						(line <span class="line-number">28</span>)
    216. 

  216. 		</span>
    217. 

  217. 	</div>
    218. 

  218. 

  219. 	<!-- ========== Info from phpDoc block ========= -->
    220. 

  220. <p class="short-description">Cedente</p>
    221. 

  221. 	<ul class="tags">
    222. 

  222. 				<li><span class="field">access:</span> protected</li>
    223. 

  223. 			</ul>
    224. 

  224. 	
    225. 

  225. 	
    226. 

  226. 		
    227. 

  227. 		
    228. 

  228. 

  229. </div>
    230. 

  230. <a name="var$classes" id="$classes"><!-- --></A>
    231. 

  231. <div class="oddrow">
    232. 

  232. 

  233. 	<div class="var-header">
    234. 

  234. 		<span class="var-title">
    235. 

  235. 			<span class="var-type">array</span>
    236. 

  236. 			<span class="var-name">$classes</span>
    237. 

  237. 			 = <span class="var-default">array(<br />        'cedente' =&gt; '\PHPBol\Data\BasicCedente',<br />        'sacado'   =&gt; '\PHPBol\Data\BasicSacado',<br />        'avalista' =&gt; '\PHPBol\Data\BasicAvalista',<br />        'boletoData'   =&gt; '\PHPBol\Data\BasicBoletoData',<br />    )</span>			(line <span class="line-number">52</span>)
    238. 

  238. 		</span>
    239. 

  239. 	</div>
    240. 

  240. 

  241. 	<!-- ========== Info from phpDoc block ========= -->
    242. 

  242. <p class="short-description">Classes for all object data</p>
    243. 

  243. 	<ul class="tags">
    244. 

  244. 				<li><span class="field">access:</span> protected</li>
    245. 

  245. 			</ul>
    246. 

  246. 	
    247. 

  247. 	
    248. 

  248. 		
    249. 

  249. 		
    250. 

  250. 

  251. </div>
    252. 

  252. <a name="var$sacado" id="$sacado"><!-- --></A>
    253. 

  253. <div class="evenrow">
    254. 

  254. 

  255. 	<div class="var-header">
    256. 

  256. 		<span class="var-title">
    257. 

  257. 			<span class="var-type">\PHPBol\Data\BasicSacado</span>
    258. 

  258. 			<span class="var-name">$sacado</span>
    259. 

  259. 						(line <span class="line-number">34</span>)
    260. 

  260. 		</span>
    261. 

  261. 	</div>
    262. 

  262. 

  263. 	<!-- ========== Info from phpDoc block ========= -->
    264. 

  264. <p class="short-description">Sacado</p>
    265. 

  265. 	<ul class="tags">
    266. 

  266. 				<li><span class="field">access:</span> protected</li>
    267. 

  267. 			</ul>
    268. 

  268. 	
    269. 

  269. 	
    270. 

  270. 		
    271. 

  271. 		
    272. 

  272. 

  273. </div>
    274. 

  274. 						
    275. 

  275. 		</div>
    276. 

  276. 	</div>
    277. 

  277. 	
    278. 

  278. 	<a name="sec-methods"></a>
    279. 

  279. 	<div class="info-box">
    280. 

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

  281. 		<div class="nav-bar">
    282. 

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

  283. 							<a href="#sec-descendents">Descendents</a> |
    284. 

  284. 															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
    285. 

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

  286. 						
    287. 

  287. 		</div>
    288. 

  288. 		<div class="info-box-body">
    289. 

  289. 			<A NAME='method_detail'></A>
    290. 

  290. 

  291. <a name="methodgetMetadata" id="getMetadata"><!-- --></a>
    292. 

  292. <div class="oddrow">
    293. 

  293. 	
    294. 

  294. 	<div class="method-header">
    295. 

  295. 		<span class="method-title">getMetadata</span> (line <span class="line-number">64</span>)
    296. 

  296. 	</div> 
    297. 

  297. 	
    298. 

  298. 	<!-- ========== Info from phpDoc block ========= -->
    299. 

  299. <p class="short-description">Metadata info for the class</p>
    300. 

  300. 	<ul class="tags">
    301. 

  301. 				<li><span class="field">access:</span> protected</li>
    302. 

  302. 			</ul>
    303. 

  303. 	
    304. 

  304. 	<div class="method-signature">
    305. 

  305. 		<span class="method-result">array</span>
    306. 

  306. 		<span class="method-name">
    307. 

  307. 			getMetadata
    308. 

  308. 		</span>
    309. 

  309. 				()
    310. 

  310. 			</div>
    311. 

  311. 	
    312. 

  312. 		
    313. 

  313. 			
    314. 

  314. 	</div>
    315. 

  315. <a name="methodsetAvalista" id="setAvalista"><!-- --></a>
    316. 

  316. <div class="evenrow">
    317. 

  317. 	
    318. 

  318. 	<div class="method-header">
    319. 

  319. 		<span class="method-title">setAvalista</span> (line <span class="line-number">119</span>)
    320. 

  320. 	</div> 
    321. 

  321. 	
    322. 

  322. 	<!-- ========== Info from phpDoc block ========= -->
    323. 

  323. <p class="short-description">Set Avalista</p>
    324. 

  324. 	<ul class="tags">
    325. 

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

  326. 			</ul>
    327. 

  327. 	
    328. 

  328. 	<div class="method-signature">
    329. 

  329. 		<span class="method-result">void</span>
    330. 

  330. 		<span class="method-name">
    331. 

  331. 			setAvalista
    332. 

  332. 		</span>
    333. 

  333. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$avalista</span>)
    334. 

  334. 			</div>
    335. 

  335. 	
    336. 

  336. 			<ul class="parameters">
    337. 

  337. 					<li>
    338. 

  338. 				<span class="var-type">mixed</span>
    339. 

  339. 				<span class="var-name">$avalista</span><span class="var-description">: Array or \PHPBol\Data\BasicAvalista value</span>			</li>
    340. 

  340. 				</ul>
    341. 

  341. 		
    342. 

  342. 			
    343. 

  343. 	</div>
    344. 

  344. <a name="methodsetBoletoData" id="setBoletoData"><!-- --></a>
    345. 

  345. <div class="oddrow">
    346. 

  346. 	
    347. 

  347. 	<div class="method-header">
    348. 

  348. 		<span class="method-title">setBoletoData</span> (line <span class="line-number">129</span>)
    349. 

  349. 	</div> 
    350. 

  350. 	
    351. 

  351. 	<!-- ========== Info from phpDoc block ========= -->
    352. 

  352. <p class="short-description">Set BoletoData</p>
    353. 

  353. 	<ul class="tags">
    354. 

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

  355. 			</ul>
    356. 

  356. 	
    357. 

  357. 	<div class="method-signature">
    358. 

  358. 		<span class="method-result">void</span>
    359. 

  359. 		<span class="method-name">
    360. 

  360. 			setBoletoData
    361. 

  361. 		</span>
    362. 

  362. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$boletoData</span>)
    363. 

  363. 			</div>
    364. 

  364. 	
    365. 

  365. 			<ul class="parameters">
    366. 

  366. 					<li>
    367. 

  367. 				<span class="var-type">mixed</span>
    368. 

  368. 				<span class="var-name">$boletoData</span><span class="var-description">: Array or \PHPBol\Data\BasicAvalista value</span>			</li>
    369. 

  369. 				</ul>
    370. 

  370. 		
    371. 

  371. 			
    372. 

  372. 	</div>
    373. 

  373. <a name="methodsetCedente" id="setCedente"><!-- --></a>
    374. 

  374. <div class="evenrow">
    375. 

  375. 	
    376. 

  376. 	<div class="method-header">
    377. 

  377. 		<span class="method-title">setCedente</span> (line <span class="line-number">99</span>)
    378. 

  378. 	</div> 
    379. 

  379. 	
    380. 

  380. 	<!-- ========== Info from phpDoc block ========= -->
    381. 

  381. <p class="short-description">Set Cedente</p>
    382. 

  382. 	<ul class="tags">
    383. 

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

  384. 			</ul>
    385. 

  385. 	
    386. 

  386. 	<div class="method-signature">
    387. 

  387. 		<span class="method-result">void</span>
    388. 

  388. 		<span class="method-name">
    389. 

  389. 			setCedente
    390. 

  390. 		</span>
    391. 

  391. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$cedente</span>)
    392. 

  392. 			</div>
    393. 

  393. 	
    394. 

  394. 			<ul class="parameters">
    395. 

  395. 					<li>
    396. 

  396. 				<span class="var-type">mixed</span>
    397. 

  397. 				<span class="var-name">$cedente</span><span class="var-description">: Array or \PHPBol\Data\BasicCedente value</span>			</li>
    398. 

  398. 				</ul>
    399. 

  399. 		
    400. 

  400. 			
    401. 

  401. 	</div>
    402. 

  402. <a name="methodsetSacado" id="setSacado"><!-- --></a>
    403. 

  403. <div class="oddrow">
    404. 

  404. 	
    405. 

  405. 	<div class="method-header">
    406. 

  406. 		<span class="method-title">setSacado</span> (line <span class="line-number">109</span>)
    407. 

  407. 	</div> 
    408. 

  408. 	
    409. 

  409. 	<!-- ========== Info from phpDoc block ========= -->
    410. 

  410. <p class="short-description">Set Sacado</p>
    411. 

  411. 	<ul class="tags">
    412. 

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

  413. 			</ul>
    414. 

  414. 	
    415. 

  415. 	<div class="method-signature">
    416. 

  416. 		<span class="method-result">void</span>
    417. 

  417. 		<span class="method-name">
    418. 

  418. 			setSacado
    419. 

  419. 		</span>
    420. 

  420. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$sacado</span>)
    421. 

  421. 			</div>
    422. 

  422. 	
    423. 

  423. 			<ul class="parameters">
    424. 

  424. 					<li>
    425. 

  425. 				<span class="var-type">mixed</span>
    426. 

  426. 				<span class="var-name">$sacado</span><span class="var-description">: Array or \PHPBol\Data\BasicSacado value</span>			</li>
    427. 

  427. 				</ul>
    428. 

  428. 		
    429. 

  429. 			
    430. 

  430. 	</div>
    431. 

  431. 						
    432. 

  432. 		</div>
    433. 

  433. 	</div>
    434. 

  434. 

  435. 

  436. 	<p class="notes" id="credit">
    437. 

  437. 		Documentation generated on Sat, 01 Oct 2011 19:06:10 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
    438. 

  438. 	</p>
    439. 

  439. 	</div></body>
    440. 

  440. </html>
    441.