| [ Index ] |
|
Code source de PRADO 3.0.6 |
1 <?xml version="1.0" encoding="iso-8859-1"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <!-- template designed by Marco Von Ballmoos --> 6 <title>Docs For Class TTarFileExtractor</title> 7 <link rel="stylesheet" href="../media/stylesheet.css" /> 8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> 9 </head> 10 <body> 11 <div class="page-body"> 12 <h2 class="class-name">Class TTarFileExtractor</h2> 13 14 <a name="sec-description"></a> 15 <div class="info-box"> 16 <div class="info-box-title">Description</div> 17 <div class="nav-bar"> 18 <span class="disabled">Description</span> | 19 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) 20 21 </div> 22 <div class="info-box-body"> 23 <!-- ========== Info from phpDoc block ========= --> 24 <p class="short-description">TTarFileExtractor class</p> 25 <ul class="tags"> 26 <li><span class="field">since:</span> 3.0</li> 27 <li><span class="field">version:</span> $Id: TTarFileExtractor.php 1397 2006-09-07 07:55:53Z wei $</li> 28 <li><span class="field">author:</span> Vincent Blavet <<a href="mailto:vincent@phpconcept.net">vincent@phpconcept.net</a>></li> 29 </ul> 30 <p class="notes"> 31 Located in <a class="field" href="_IO_TTarFileExtractor_php.html">/IO/TTarFileExtractor.php</a> (line <span class="field">38</span>) 32 </p> 33 34 35 <pre></pre> 36 37 </div> 38 </div> 39 40 41 42 43 <a name="sec-method-summary"></a> 44 <div class="info-box"> 45 <div class="info-box-title">Method Summary</span></div> 46 <div class="nav-bar"> 47 <a href="#sec-description">Description</a> | 48 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) 49 </div> 50 <div class="info-box-body"> 51 <div class="method-summary"> 52 53 <div class="method-definition"> 54 <span class="method-result">TTarFileExtractor</span> 55 <a href="#__construct" title="details" class="method-name">__construct</a> 56 (<span class="var-type">string</span> <span class="var-name">$p_tarname</span>) 57 </div> 58 59 <div class="method-definition"> 60 <span class="method-result">void</span> 61 <a href="#__destruct" title="details" class="method-name">__destruct</a> 62 () 63 </div> 64 65 <div class="method-definition"> 66 <span class="method-result">void</span> 67 <a href="#extract" title="details" class="method-name">extract</a> 68 ([<span class="var-type">mixed</span> <span class="var-name">$p_path</span> = <span class="var-default">''</span>]) 69 </div> 70 71 <div class="method-definition"> 72 <span class="method-result">boolean</span> 73 <a href="#extractModify" title="details" class="method-name">extractModify</a> 74 (<span class="var-type">string</span> <span class="var-name">$p_path</span>, <span class="var-type">string</span> <span class="var-name">$p_remove_path</span>) 75 </div> 76 77 <div class="method-definition"> 78 <span class="method-result">bool</span> 79 <a href="#_dirCheck" title="details" class="method-name">_dirCheck</a> 80 (<span class="var-type">string</span> <span class="var-name">$p_dir</span>) 81 </div> 82 83 <div class="method-definition"> 84 <span class="method-result">void</span> 85 <a href="#_error" title="details" class="method-name">_error</a> 86 (<span class="var-type">mixed</span> <span class="var-name">$p_message</span>) 87 </div> 88 89 <div class="method-definition"> 90 <span class="method-result">void</span> 91 <a href="#_extractList" title="details" class="method-name">_extractList</a> 92 (<span class="var-type">mixed</span> <span class="var-name">$p_path</span>, <span class="var-type">mixed</span> <span class="var-name">&$p_list_detail</span>, <span class="var-type">mixed</span> <span class="var-name">$p_mode</span>, <span class="var-type">mixed</span> <span class="var-name">$p_file_list</span>, <span class="var-type">mixed</span> <span class="var-name">$p_remove_path</span>) 93 </div> 94 95 <div class="method-definition"> 96 <span class="method-result">void</span> 97 <a href="#_translateWinPath" title="details" class="method-name">_translateWinPath</a> 98 (<span class="var-type">mixed</span> <span class="var-name">$p_path</span>, [<span class="var-type">mixed</span> <span class="var-name">$p_remove_disk_letter</span> = <span class="var-default">true</span>]) 99 </div> 100 </div> 101 </div> 102 </div> 103 104 105 <a name="sec-methods"></a> 106 <div class="info-box"> 107 <div class="info-box-title">Methods</div> 108 <div class="nav-bar"> 109 <a href="#sec-description">Description</a> | 110 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) 111 112 </div> 113 <div class="info-box-body"> 114 <A NAME='method_detail'></A> 115 <a name="method__construct" id="__construct"><!-- --></a> 116 <div class="oddrow"> 117 118 <div class="method-header"> 119 <span class="method-title">Constructor __construct</span> (line <span class="line-number">63</span>) 120 </div> 121 122 <!-- ========== Info from phpDoc block ========= --> 123 <p class="short-description">Archive_Tar Class constructor. This flavour of the constructor only declare a new Archive_Tar object, identifying it by the name of the tar file.</p> 124 <ul class="tags"> 125 <li><span class="field">access:</span> public</li> 126 </ul> 127 128 <div class="method-signature"> 129 <span class="method-result">TTarFileExtractor</span> 130 <span class="method-name"> 131 __construct 132 </span> 133 (<span class="var-type">string</span> <span class="var-name">$p_tarname</span>) 134 </div> 135 136 <ul class="parameters"> 137 <li> 138 <span class="var-type">string</span> 139 <span class="var-name">$p_tarname</span><span class="var-description">: The name of the tar archive to create</span> </li> 140 </ul> 141 142 143 </div> 144 <a name="method__destruct" id="__destruct"><!-- --></a> 145 <div class="evenrow"> 146 147 <div class="method-header"> 148 <span class="method-title">Destructor __destruct</span> (line <span class="line-number">68</span>) 149 </div> 150 151 <!-- ========== Info from phpDoc block ========= --> 152 <ul class="tags"> 153 <li><span class="field">access:</span> public</li> 154 </ul> 155 156 <div class="method-signature"> 157 <span class="method-result">void</span> 158 <span class="method-name"> 159 __destruct 160 </span> 161 () 162 </div> 163 164 165 166 </div> 167 <a name="methodextract" id="extract"><!-- --></a> 168 <div class="oddrow"> 169 170 <div class="method-header"> 171 <span class="method-title">extract</span> (line <span class="line-number">76</span>) 172 </div> 173 174 <!-- ========== Info from phpDoc block ========= --> 175 <ul class="tags"> 176 <li><span class="field">access:</span> public</li> 177 </ul> 178 179 <div class="method-signature"> 180 <span class="method-result">void</span> 181 <span class="method-name"> 182 extract 183 </span> 184 ([<span class="var-type">mixed</span> <span class="var-name">$p_path</span> = <span class="var-default">''</span>]) 185 </div> 186 187 188 189 </div> 190 <a name="methodextractModify" id="extractModify"><!-- --></a> 191 <div class="evenrow"> 192 193 <div class="method-header"> 194 <span class="method-title">extractModify</span> (line <span class="line-number">113</span>) 195 </div> 196 197 <!-- ========== Info from phpDoc block ========= --> 198 <p class="short-description">This method extract all the content of the archive in the directory indicated by $p_path. When relevant the memorized path of the files/dir can be modified by removing the $p_remove_path path at the beginning of the file/dir path.</p> 199 <p class="description"><p>While extracting a file, if the directory path does not exists it is created. While extracting a file, if the file already exists it is replaced without looking for last modification date. While extracting a file, if the file already exists and is write protected, the extraction is aborted. While extracting a file, if a directory with the same name already exists, the extraction is aborted. While extracting a directory, if a file with the same name already exists, the extraction is aborted. While extracting a file/directory if the destination directory exist and is write protected, or does not exist but can not be created, the extraction is aborted. If after extraction an extracted file does not show the correct stored file size, the extraction is aborted. When the extraction is aborted, a PEAR error text is set and false is returned. However the result can be a partial extraction that may need to be manually cleaned.</p></p> 200 <ul class="tags"> 201 <li><span class="field">return:</span> true on success, false on error.</li> 202 <li><span class="field">access:</span> protected</li> 203 </ul> 204 205 <div class="method-signature"> 206 <span class="method-result">boolean</span> 207 <span class="method-name"> 208 extractModify 209 </span> 210 (<span class="var-type">string</span> <span class="var-name">$p_path</span>, <span class="var-type">string</span> <span class="var-name">$p_remove_path</span>) 211 </div> 212 213 <ul class="parameters"> 214 <li> 215 <span class="var-type">string</span> 216 <span class="var-name">$p_path</span><span class="var-description">: The path of the directory where the files/dir need to by extracted.</span> </li> 217 <li> 218 <span class="var-type">string</span> 219 <span class="var-name">$p_remove_path</span><span class="var-description">: Part of the memorized path that can be removed if present at the beginning of the file/dir path.</span> </li> 220 </ul> 221 222 223 </div> 224 <a name="method_dirCheck" id="_dirCheck"><!-- --></a> 225 <div class="oddrow"> 226 227 <div class="method-header"> 228 <span class="method-title">_dirCheck</span> (line <span class="line-number">537</span>) 229 </div> 230 231 <!-- ========== Info from phpDoc block ========= --> 232 <p class="short-description">Check if a directory exists and create it (including parent dirs) if not.</p> 233 <ul class="tags"> 234 <li><span class="field">return:</span> true if the directory exists or was created</li> 235 <li><span class="field">access:</span> protected</li> 236 </ul> 237 238 <div class="method-signature"> 239 <span class="method-result">bool</span> 240 <span class="method-name"> 241 _dirCheck 242 </span> 243 (<span class="var-type">string</span> <span class="var-name">$p_dir</span>) 244 </div> 245 246 <ul class="parameters"> 247 <li> 248 <span class="var-type">string</span> 249 <span class="var-name">$p_dir</span><span class="var-description">: directory to check</span> </li> 250 </ul> 251 252 253 </div> 254 <a name="method_error" id="_error"><!-- --></a> 255 <div class="evenrow"> 256 257 <div class="method-header"> 258 <span class="method-title">_error</span> (line <span class="line-number">127</span>) 259 </div> 260 261 <!-- ========== Info from phpDoc block ========= --> 262 <ul class="tags"> 263 <li><span class="field">access:</span> protected</li> 264 </ul> 265 266 <div class="method-signature"> 267 <span class="method-result">void</span> 268 <span class="method-name"> 269 _error 270 </span> 271 (<span class="var-type">mixed</span> <span class="var-name">$p_message</span>) 272 </div> 273 274 275 276 </div> 277 <a name="method_extractList" id="_extractList"><!-- --></a> 278 <div class="oddrow"> 279 280 <div class="method-header"> 281 <span class="method-title">_extractList</span> (line <span class="line-number">322</span>) 282 </div> 283 284 <!-- ========== Info from phpDoc block ========= --> 285 <ul class="tags"> 286 <li><span class="field">access:</span> protected</li> 287 </ul> 288 289 <div class="method-signature"> 290 <span class="method-result">void</span> 291 <span class="method-name"> 292 _extractList 293 </span> 294 (<span class="var-type">mixed</span> <span class="var-name">$p_path</span>, <span class="var-type">mixed</span> <span class="var-name">&$p_list_detail</span>, <span class="var-type">mixed</span> <span class="var-name">$p_mode</span>, <span class="var-type">mixed</span> <span class="var-name">$p_file_list</span>, <span class="var-type">mixed</span> <span class="var-name">$p_remove_path</span>) 295 </div> 296 297 298 299 </div> 300 <a name="method_translateWinPath" id="_translateWinPath"><!-- --></a> 301 <div class="evenrow"> 302 303 <div class="method-header"> 304 <span class="method-title">_translateWinPath</span> (line <span class="line-number">558</span>) 305 </div> 306 307 <!-- ========== Info from phpDoc block ========= --> 308 <ul class="tags"> 309 <li><span class="field">access:</span> protected</li> 310 </ul> 311 312 <div class="method-signature"> 313 <span class="method-result">void</span> 314 <span class="method-name"> 315 _translateWinPath 316 </span> 317 (<span class="var-type">mixed</span> <span class="var-name">$p_path</span>, [<span class="var-type">mixed</span> <span class="var-name">$p_remove_disk_letter</span> = <span class="var-default">true</span>]) 318 </div> 319 320 321 322 </div> 323 324 </div> 325 </div> 326 327 328 <p class="notes" id="credit"> 329 Documentation generated on Mon, 04 Dec 2006 11:27:40 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a> 330 </p> 331 </div></body> 332 </html>
titre
Description
Corps
titre
Description
Corps
titre
Description
Corps
titre
Corps
| Généré le : Sun Feb 25 21:07:04 2007 | par Balluche grâce à PHPXref 0.7 |