PageRenderTime 43ms CodeModel.GetById 13ms RepoModel.GetById 1ms app.codeStats 0ms

/common/libraries/plugin/google/documentation/api/core/db_Gdata_MimeBodyString.html

https://bitbucket.org/chamilo/chamilo-dev/
HTML | 270 lines | 267 code | 3 blank | 0 comment | 0 complexity | 5716c6cf843464489f8deff50484bd09 MD5 | raw file
Possible License(s): GPL-2.0, BSD-3-Clause, LGPL-2.1, LGPL-3.0, GPL-3.0, MIT 
    

  1. <html xmlns="http://www.w3.org/1999/xhtml">
    2. 

  2. <head>
    3. 

  3. <title>Zend Gdata API Documentation</title>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
    5. 

  5. <link rel="stylesheet" href="css/black-tie/jquery-ui-1.8.2.custom.css"
    6. 

  6. 	type="text/css"></link>
    7. 

  7. <link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link>
    8. 

  8. <link rel="stylesheet" href="css/theme.css" type="text/css"></link>
    9. 

  9. <script type="text/javascript" src="js/jquery-1.4.2.min.js"></script>
    10. 

  10. <script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script>
    11. 

  11. <script type="text/javascript" src="js/jquery.cookie.js"></script>
    12. 

  12. <script type="text/javascript" src="js/jquery.treeview.js"></script>
    13. 

  13. <script type="text/javascript">
    14. 

  14.             $(document).ready(function() {
    15. 

  15.                 $(".filetree").treeview({
    16. 

  16.                     collapsed: true,
    17. 

  17.                     persist: "cookie"
    18. 

  18.                 });
    19. 

  19. 

  20.                 $("#accordion").accordion({
    21. 

  21.                     collapsible: true,
    22. 

  22.                     autoHeight:  false,
    23. 

  23.                     fillSpace:   true
    24. 

  24.                 });
    25. 

  25. 

  26.                 $(".tabs").tabs();
    27. 

  27.             });
    28. 

  28.         </script>
    29. 

  29. </head>
    30. 

  30. <body>
    31. 

  31. <div xmlns="" class="content">
    32. 

  32. <div class="sub-page-main-header-api-documentation">
    33. 

  33. <h2>API Documentation</h2>
    34. 

  34. </div>
    35. 

  35. <div class="dotted-line"></div>
    36. 

  36. </div>
    37. 

  37. <div xmlns="" id="content"><script type="text/javascript"
    38. 

  38. 	src="js/menu.js"></script><script>
    39. 

  39.       $(document).ready(function() {
    40. 

  40.         $('a.gripper').click(function() {
    41. 

  41.             $(this).nextAll('div.code-tabs').slideToggle();
    42. 

  42.             $(this).children('img').toggle();
    43. 

  43.             return false;
    44. 

  44.         });
    45. 

  45.         $('div.code-tabs').hide();
    46. 

  46.         $('a.gripper').show();
    47. 

  47.         $('div.file-nav').show();
    48. 

  48.       });
    49. 

  49.     </script>
    50. 

  50. <h1 class="file">Gdata/MimeBodyString.php</h1>
    51. 

  51. <div class="file-nav">
    52. 

  52. <ul id="file-nav">
    53. 

  53. 	<li><a href="#top">Global</a></li>
    54. 

  54. 	<li><a href="#classes"><img src="images/icons/class.png"
    55. 

  55. 		height="14"> Classes </a>
    56. 

  56. 	<ul>
    57. 

  57. 		<li><a href="#%5CZend_Gdata_MimeBodyString">\Zend_Gdata_MimeBodyString</a></li>
    58. 

  58. 	</ul>
    59. 

  59. 	</li>
    60. 

  60. </ul>
    61. 

  61. </div>
    62. 

  62. <a name="top"></a>
    63. 

  63. <div id="file-description">
    64. 

  64. <p class="short-description">Zend Framework</p>
    65. 

  65. <div class="long-description">
    66. 

  66. <p>LICENSE</p>
    67. 

  67. 

  68. <p>This source file is subject to the new BSD license that is
    69. 

  69. bundled with this package in the file LICENSE.txt. It is also available
    70. 

  70. through the world-wide-web at this URL:
    71. 

  71. http://framework.zend.com/license/new-bsd If you did not receive a copy
    72. 

  72. of the license and are unable to obtain it through the world-wide-web,
    73. 

  73. please send an email to license@zend.com so we can send you a copy
    74. 

  74. immediately.</p>
    75. 

  75. </div>
    76. 

  76. </div>
    77. 

  77. <dl class="file-info">
    78. 

  78. 	<dt>category</dt>
    79. 

  79. 	<dd>Zend  </dd>
    80. 

  80. 	<dt>copyright</dt>
    81. 

  81. 	<dd>Copyright (c) 2005-2011 Zend Technologies USA Inc.
    82. 

  82. 	(http://www.zend.com)  </dd>
    83. 

  83. 	<dt>license</dt>
    84. 

  84. 	<dd><a href="http://framework.zend.com/license/new-bsd">New
    85. 

  85. 	BSD License</a>  </dd>
    86. 

  86. 	<dt>package</dt>
    87. 

  87. 	<dd>Zend_Gdata  </dd>
    88. 

  88. 	<dt>subpackage</dt>
    89. 

  89. 	<dd>Gdata  </dd>
    90. 

  90. 	<dt>version</dt>
    91. 

  91. 	<dd>$Id: MimeBodyString.php 23775 2011-03-01 17:25:24Z ralph $  </dd>
    92. 

  92. </dl>
    93. 

  93. <a name="classes"></a><a id="\Zend_Gdata_MimeBodyString"></a>
    94. 

  94. <h2 class="class">\Zend_Gdata_MimeBodyString
    95. 

  95. <div class="to-top"><a href="#top">jump to top</a></div>
    96. 

  96. </h2>
    97. 

  97. <div class="class">
    98. 

  98. <p class="short-description">A wrapper for strings for buffered
    99. 

  99. reading.</p>
    100. 

  100. <div class="long-description"></div>
    101. 

  101. <dl class="class-info">
    102. 

  102. 	<dt>category</dt>
    103. 

  103. 	<dd>Zend  </dd>
    104. 

  104. 	<dt>copyright</dt>
    105. 

  105. 	<dd>Copyright (c) 2005-2011 Zend Technologies USA Inc.
    106. 

  106. 	(http://www.zend.com)  </dd>
    107. 

  107. 	<dt>license</dt>
    108. 

  108. 	<dd><a href="http://framework.zend.com/license/new-bsd">New
    109. 

  109. 	BSD License</a>  </dd>
    110. 

  110. 	<dt>package</dt>
    111. 

  111. 	<dd>Zend_Gdata  </dd>
    112. 

  112. 	<dt>subpackage</dt>
    113. 

  113. 	<dd>Gdata  </dd>
    114. 

  114. </dl>
    115. 

  115. <h3>Properties</h3>
    116. 

  116. <div><a id="\Zend_Gdata_MimeBodyString::$_bytesRead"></a>
    117. 

  117. <div class="property"><a href="#" class="gripper"><img
    118. 

  118. 	src="images/icons/arrow_right.png"><img
    119. 

  119. 	src="images/icons/arrow_down.png" style="display: none;"></a><code><img
    120. 

  120. 	src="images/icons/property.png" alt="Property"><img
    121. 

  121. 	src="images/icons/visibility_protected.png" style="margin-right: 5px"
    122. 

  122. 	alt="protected">integer  <span class="highlight">$_bytesRead</span>=
    123. 

  123. '0' </code>
    124. 

  124. <div class="description">
    125. 

  125. <p class="short-description">The size of the MIME message.</p>
    126. 

  126. </div>
    127. 

  127. <div class="code-tabs">
    128. 

  128. <div class="long-description"></div>
    129. 

  129. <strong>Default value</strong><code>0</code><strong>Details</strong>
    130. 

  130. <dl class="property-info">
    131. 

  131. 	<dt>Type</dt>
    132. 

  132. 	<dd>integer</dd>
    133. 

  133. </dl>
    134. 

  134. </div>
    135. 

  135. <div class="clear"></div>
    136. 

  136. </div>
    137. 

  137. <a id="\Zend_Gdata_MimeBodyString::$_sourceString"></a>
    138. 

  138. <div class="property"><a href="#" class="gripper"><img
    139. 

  139. 	src="images/icons/arrow_right.png"><img
    140. 

  140. 	src="images/icons/arrow_down.png" style="display: none;"></a><code><img
    141. 

  141. 	src="images/icons/property.png" alt="Property"><img
    142. 

  142. 	src="images/icons/visibility_protected.png" style="margin-right: 5px"
    143. 

  143. 	alt="protected">string  <span class="highlight">$_sourceString</span>=
    144. 

  144. '' </code>
    145. 

  145. <div class="description">
    146. 

  146. <p class="short-description">The source string.</p>
    147. 

  147. </div>
    148. 

  148. <div class="code-tabs">
    149. 

  149. <div class="long-description"></div>
    150. 

  150. <strong>Details</strong>
    151. 

  151. <dl class="property-info">
    152. 

  152. 	<dt>Type</dt>
    153. 

  153. 	<dd>string</dd>
    154. 

  154. </dl>
    155. 

  155. </div>
    156. 

  156. <div class="clear"></div>
    157. 

  157. </div>
    158. 

  158. </div>
    159. 

  159. <h3>Methods</h3>
    160. 

  160. <div><a id="\Zend_Gdata_MimeBodyString::__construct()"></a>
    161. 

  161. <div class="method"><a href="#" class="gripper"><img
    162. 

  162. 	src="images/icons/arrow_right.png"><img
    163. 

  163. 	src="images/icons/arrow_down.png" style="display: none;"></a><code><img
    164. 

  164. 	src="images/icons/method.png" alt="method"><img
    165. 

  165. 	src="images/icons/visibility_public.png" style="margin-right: 5px"
    166. 

  166. 	alt="public"><span class="highlight">__construct</span><span
    167. 

  167. 	class="nb-faded-text">( string $sourceString ) </span> : void</code>
    168. 

  168. <div class="description">
    169. 

  169. <p class="short_description">Create a new MimeBodyString object.</p>
    170. 

  170. </div>
    171. 

  171. <div class="code-tabs">
    172. 

  172. <div class="long-description"></div>
    173. 

  173. <strong>Parameters</strong>
    174. 

  174. <table class="argument-info">
    175. 

  175. 	<thead>
    176. 

  176. 		<tr>
    177. 

  177. 			<th>Name</th>
    178. 

  178. 			<th>Type</th>
    179. 

  179. 			<th>Description</th>
    180. 

  180. 		</tr>
    181. 

  181. 	</thead>
    182. 

  182. 	<tr>
    183. 

  183. 		<th>$sourceString</th>
    184. 

  184. 		<td>string</td>
    185. 

  185. 		<td><em>The string we are wrapping.</em></td>
    186. 

  186. 	</tr>
    187. 

  187. </table>
    188. 

  188. </div>
    189. 

  189. <div class="clear"></div>
    190. 

  190. </div>
    191. 

  191. <a id="\Zend_Gdata_MimeBodyString::getSize()"></a>
    192. 

  192. <div class="method"><a href="#" class="gripper"><img
    193. 

  193. 	src="images/icons/arrow_right.png"><img
    194. 

  194. 	src="images/icons/arrow_down.png" style="display: none;"></a><code><img
    195. 

  195. 	src="images/icons/method.png" alt="method"><img
    196. 

  196. 	src="images/icons/visibility_public.png" style="margin-right: 5px"
    197. 

  197. 	alt="public"><span class="highlight">getSize</span><span
    198. 

  198. 	class="nb-faded-text">( ) </span> : int</code>
    199. 

  199. <div class="description">
    200. 

  200. <p class="short_description">The length of the string.</p>
    201. 

  201. </div>
    202. 

  202. <div class="code-tabs">
    203. 

  203. <div class="long-description"></div>
    204. 

  204. <strong>Returns</strong>
    205. 

  205. <table class="argument-info">
    206. 

  206. 	<thead>
    207. 

  207. 		<tr>
    208. 

  208. 			<th>Type</th>
    209. 

  209. 			<th>Description</th>
    210. 

  210. 		</tr>
    211. 

  211. 	</thead>
    212. 

  212. 	<tr>
    213. 

  213. 		<td>int</td>
    214. 

  214. 		<td>The length of the string contained in the object.</td>
    215. 

  215. 	</tr>
    216. 

  216. </table>
    217. 

  217. </div>
    218. 

  218. <div class="clear"></div>
    219. 

  219. </div>
    220. 

  220. <a id="\Zend_Gdata_MimeBodyString::read()"></a>
    221. 

  221. <div class="method"><a href="#" class="gripper"><img
    222. 

  222. 	src="images/icons/arrow_right.png"><img
    223. 

  223. 	src="images/icons/arrow_down.png" style="display: none;"></a><code><img
    224. 

  224. 	src="images/icons/method.png" alt="method"><img
    225. 

  225. 	src="images/icons/visibility_public.png" style="margin-right: 5px"
    226. 

  226. 	alt="public"><span class="highlight">read</span><span
    227. 

  227. 	class="nb-faded-text">( integer $bytesRequested ) </span> : string</code>
    228. 

  228. <div class="description">
    229. 

  229. <p class="short_description">Read the next chunk of the string.</p>
    230. 

  230. </div>
    231. 

  231. <div class="code-tabs">
    232. 

  232. <div class="long-description"></div>
    233. 

  233. <strong>Parameters</strong>
    234. 

  234. <table class="argument-info">
    235. 

  235. 	<thead>
    236. 

  236. 		<tr>
    237. 

  237. 			<th>Name</th>
    238. 

  238. 			<th>Type</th>
    239. 

  239. 			<th>Description</th>
    240. 

  240. 		</tr>
    241. 

  241. 	</thead>
    242. 

  242. 	<tr>
    243. 

  243. 		<th>$bytesRequested</th>
    244. 

  244. 		<td>integer</td>
    245. 

  245. 		<td><em>The size of the chunk that is to be read.</em></td>
    246. 

  246. 	</tr>
    247. 

  247. </table>
    248. 

  248. <strong>Returns</strong>
    249. 

  249. <table class="argument-info">
    250. 

  250. 	<thead>
    251. 

  251. 		<tr>
    252. 

  252. 			<th>Type</th>
    253. 

  253. 			<th>Description</th>
    254. 

  254. 		</tr>
    255. 

  255. 	</thead>
    256. 

  256. 	<tr>
    257. 

  257. 		<td>string</td>
    258. 

  258. 		<td>A corresponding piece of the string.</td>
    259. 

  259. 	</tr>
    260. 

  260. </table>
    261. 

  261. </div>
    262. 

  262. <div class="clear"></div>
    263. 

  263. </div>
    264. 

  264. </div>
    265. 

  265. </div>
    266. 

  266. </div>
    267. 

  267. <small xmlns="" class="footer">Documentation was generated by <a
    268. 

  268. 	href="http://docblox-project.org">DocBlox 0.13.3</a>. </small>
    269. 

  269. </body>
    270. 

  270. </html>
    271. 

  271.