| 1 |
<?php |
| 2 |
|
| 3 |
// Start of Phar v.2.0.2 |
| 4 |
|
| 5 |
class PharException extends Exception { |
| 6 |
protected $message; |
| 7 |
protected $code; |
| 8 |
protected $file; |
| 9 |
protected $line; |
| 10 |
|
| 11 |
|
| 12 |
final private function __clone () {} |
| 13 |
|
| 14 |
/** |
| 15 |
* @param message[optional] |
| 16 |
* @param code[optional] |
| 17 |
* @param previous[optional] |
| 18 |
*/ |
| 19 |
public function __construct ($message, $code, $previous) {} |
| 20 |
|
| 21 |
final public function getMessage () {} |
| 22 |
|
| 23 |
final public function getCode () {} |
| 24 |
|
| 25 |
final public function getFile () {} |
| 26 |
|
| 27 |
final public function getLine () {} |
| 28 |
|
| 29 |
final public function getTrace () {} |
| 30 |
|
| 31 |
final public function getPrevious () {} |
| 32 |
|
| 33 |
final public function getTraceAsString () {} |
| 34 |
|
| 35 |
public function __toString () {} |
| 36 |
|
| 37 |
} |
| 38 |
|
| 39 |
class Phar extends RecursiveDirectoryIterator implements RecursiveIterator, SeekableIterator, Traversable, Iterator, Countable, ArrayAccess { |
| 40 |
const CURRENT_MODE_MASK = 240; |
| 41 |
const CURRENT_AS_PATHNAME = 32; |
| 42 |
const CURRENT_AS_FILEINFO = 0; |
| 43 |
const CURRENT_AS_SELF = 16; |
| 44 |
const KEY_MODE_MASK = 3840; |
| 45 |
const KEY_AS_PATHNAME = 0; |
| 46 |
const FOLLOW_SYMLINKS = 512; |
| 47 |
const KEY_AS_FILENAME = 256; |
| 48 |
const NEW_CURRENT_AND_KEY = 256; |
| 49 |
const OTHER_MODE_MASK = 12288; |
| 50 |
const SKIP_DOTS = 4096; |
| 51 |
const UNIX_PATHS = 8192; |
| 52 |
const BZ2 = 8192; |
| 53 |
const GZ = 4096; |
| 54 |
const NONE = 0; |
| 55 |
const PHAR = 1; |
| 56 |
const TAR = 2; |
| 57 |
const ZIP = 3; |
| 58 |
const COMPRESSED = 61440; |
| 59 |
const PHP = 0; |
| 60 |
const PHPS = 1; |
| 61 |
const MD5 = 1; |
| 62 |
const OPENSSL = 16; |
| 63 |
const SHA1 = 2; |
| 64 |
const SHA256 = 3; |
| 65 |
const SHA512 = 4; |
| 66 |
|
| 67 |
|
| 68 |
/** |
| 69 |
* Construct a Phar archive object |
| 70 |
* @link http://www.php.net/manual/en/phar.construct.php |
| 71 |
* @param filename |
| 72 |
* @param flags[optional] |
| 73 |
* @param alias[optional] |
| 74 |
* @param fileformat[optional] |
| 75 |
*/ |
| 76 |
public function __construct ($filename, $flags, $alias, $fileformat) {} |
| 77 |
|
| 78 |
public function __destruct () {} |
| 79 |
|
| 80 |
/** |
| 81 |
* Add an empty directory to the phar archive |
| 82 |
* @link http://www.php.net/manual/en/phar.addemptydir.php |
| 83 |
* @param dirname string <p> |
| 84 |
* The name of the empty directory to create in the phar archive |
| 85 |
* </p> |
| 86 |
* @return void no return value, exception is thrown on failure. |
| 87 |
*/ |
| 88 |
public function addEmptyDir ($dirname) {} |
| 89 |
|
| 90 |
/** |
| 91 |
* Add a file from the filesystem to the phar archive |
| 92 |
* @link http://www.php.net/manual/en/phar.addfile.php |
| 93 |
* @param file string <p> |
| 94 |
* Full or relative path to a file on disk to be added |
| 95 |
* to the phar archive. |
| 96 |
* </p> |
| 97 |
* @param localname string[optional] <p> |
| 98 |
* Path that the file will be stored in the archive. |
| 99 |
* </p> |
| 100 |
* @return void no return value, exception is thrown on failure. |
| 101 |
*/ |
| 102 |
public function addFile ($file, $localname = null) {} |
| 103 |
|
| 104 |
/** |
| 105 |
* Add a file from a string to the phar archive |
| 106 |
* @link http://www.php.net/manual/en/phar.addfromstring.php |
| 107 |
* @param localname string <p> |
| 108 |
* Path that the file will be stored in the archive. |
| 109 |
* </p> |
| 110 |
* @param contents string <p> |
| 111 |
* The file contents to store |
| 112 |
* </p> |
| 113 |
* @return void no return value, exception is thrown on failure. |
| 114 |
*/ |
| 115 |
public function addFromString ($localname, $contents) {} |
| 116 |
|
| 117 |
/** |
| 118 |
* Construct a phar archive from the files within a directory. |
| 119 |
* @link http://www.php.net/manual/en/phar.buildfromdirectory.php |
| 120 |
* @param base_dir string <p> |
| 121 |
* The full or relative path to the directory that contains all files |
| 122 |
* to add to the archive. |
| 123 |
* </p> |
| 124 |
* @param regex string[optional] <p> |
| 125 |
* An optional pcre regular expression that is used to filter the |
| 126 |
* list of files. Only file paths matching the regular expression |
| 127 |
* will be included in the archive. |
| 128 |
* </p> |
| 129 |
* @return array Phar::buildFromDirectory returns an associative array |
| 130 |
* mapping internal path of file to the full path of the file on the |
| 131 |
* filesystem. |
| 132 |
*/ |
| 133 |
public function buildFromDirectory ($base_dir, $regex = null) {} |
| 134 |
|
| 135 |
/** |
| 136 |
* Construct a phar archive from an iterator. |
| 137 |
* @link http://www.php.net/manual/en/phar.buildfromiterator.php |
| 138 |
* @param iter Iterator <p> |
| 139 |
* Any iterator that either associatively maps phar file to location or |
| 140 |
* returns SplFileInfo objects |
| 141 |
* </p> |
| 142 |
* @param base_directory string[optional] <p> |
| 143 |
* For iterators that return SplFileInfo objects, the portion of each |
| 144 |
* file's full path to remove when adding to the phar archive |
| 145 |
* </p> |
| 146 |
* @return array Phar::buildFromIterator returns an associative array |
| 147 |
* mapping internal path of file to the full path of the file on the |
| 148 |
* filesystem. |
| 149 |
*/ |
| 150 |
public function buildFromIterator ($iter, $base_directory = null) {} |
| 151 |
|
| 152 |
/** |
| 153 |
* Compresses all files in the current Phar archive |
| 154 |
* @link http://www.php.net/manual/en/phar.compressfiles.php |
| 155 |
* @param compression int <p> |
| 156 |
* Compression must be one of Phar::GZ, |
| 157 |
* Phar::BZ2 to add compression, or Phar::NONE |
| 158 |
* to remove compression. |
| 159 |
* </p> |
| 160 |
* @return void |
| 161 |
*/ |
| 162 |
public function compressFiles ($compression) {} |
| 163 |
|
| 164 |
/** |
| 165 |
* Decompresses all files in the current Phar archive |
| 166 |
* @link http://www.php.net/manual/en/phar.decompressfiles.php |
| 167 |
* @return bool Returns true on success, false on failure. |
| 168 |
*/ |
| 169 |
public function decompressFiles () {} |
| 170 |
|
| 171 |
/** |
| 172 |
* Compresses the entire Phar archive using Gzip or Bzip2 compression |
| 173 |
* @link http://www.php.net/manual/en/phar.compress.php |
| 174 |
* @param compression int <p> |
| 175 |
* Compression must be one of Phar::GZ, |
| 176 |
* Phar::BZ2 to add compression, or Phar::NONE |
| 177 |
* to remove compression. |
| 178 |
* </p> |
| 179 |
* @param extension string[optional] <p> |
| 180 |
* By default, the extension is .phar.gz |
| 181 |
* or .phar.bz2 for compressing phar archives, and |
| 182 |
* .phar.tar.gz or .phar.tar.bz2 for |
| 183 |
* compressing tar archives. For decompressing, the default file extensions |
| 184 |
* are .phar and .phar.tar. |
| 185 |
* </p> |
| 186 |
* @return object a Phar object. |
| 187 |
*/ |
| 188 |
public function compress ($compression, $extension = null) {} |
| 189 |
|
| 190 |
/** |
| 191 |
* Decompresses the entire Phar archive |
| 192 |
* @link http://www.php.net/manual/en/phar.decompress.php |
| 193 |
* @param extension string[optional] <p> |
| 194 |
* For decompressing, the default file extensions |
| 195 |
* are .phar and .phar.tar. |
| 196 |
* Use this parameter to specify another file extension. Be aware |
| 197 |
* that all executable phar archives must contain .phar |
| 198 |
* in their filename. |
| 199 |
* </p> |
| 200 |
* @return object A Phar object is returned. |
| 201 |
*/ |
| 202 |
public function decompress ($extension = null) {} |
| 203 |
|
| 204 |
/** |
| 205 |
* Convert a phar archive to another executable phar archive file format |
| 206 |
* @link http://www.php.net/manual/en/phar.converttoexecutable.php |
| 207 |
* @param format int[optional] <p> |
| 208 |
* This should be one of Phar::PHAR, Phar::TAR, |
| 209 |
* or Phar::ZIP. If set to &null;, the existing file format |
| 210 |
* will be preserved. |
| 211 |
* </p> |
| 212 |
* @param compression int[optional] <p> |
| 213 |
* This should be one of Phar::NONE for no whole-archive |
| 214 |
* compression, Phar::GZ for zlib-based compression, and |
| 215 |
* Phar::BZ2 for bzip-based compression. |
| 216 |
* </p> |
| 217 |
* @param extension string[optional] <p> |
| 218 |
* This parameter is used to override the default file extension for a |
| 219 |
* converted archive. Note that all zip- and tar-based phar archives must contain |
| 220 |
* .phar in their file extension in order to be processed as a |
| 221 |
* phar archive. |
| 222 |
* </p> |
| 223 |
* <p> |
| 224 |
* If converting to a phar-based archive, the default extensions are |
| 225 |
* .phar, .phar.gz, or .phar.bz2 |
| 226 |
* depending on the specified compression. For tar-based phar archives, the |
| 227 |
* default extensions are .phar.tar, .phar.tar.gz, |
| 228 |
* and .phar.tar.bz2. For zip-based phar archives, the |
| 229 |
* default extension is .phar.zip. |
| 230 |
* </p> |
| 231 |
* @return Phar The method returns a Phar object on success and throws an |
| 232 |
* exception on failure. |
| 233 |
*/ |
| 234 |
public function convertToExecutable ($format = null, $compression = null, $extension = null) {} |
| 235 |
|
| 236 |
/** |
| 237 |
* Convert a phar archive to a non-executable tar or zip file |
| 238 |
* @link http://www.php.net/manual/en/phar.converttodata.php |
| 239 |
* @param format int[optional] <p> |
| 240 |
* This should be one of Phar::TAR |
| 241 |
* or Phar::ZIP. If set to &null;, the existing file format |
| 242 |
* will be preserved. |
| 243 |
* </p> |
| 244 |
* @param compression int[optional] <p> |
| 245 |
* This should be one of Phar::NONE for no whole-archive |
| 246 |
* compression, Phar::GZ for zlib-based compression, and |
| 247 |
* Phar::BZ2 for bzip-based compression. |
| 248 |
* </p> |
| 249 |
* @param extension string[optional] <p> |
| 250 |
* This parameter is used to override the default file extension for a |
| 251 |
* converted archive. Note that .phar cannot be used |
| 252 |
* anywhere in the filename for a non-executable tar or zip archive. |
| 253 |
* </p> |
| 254 |
* <p> |
| 255 |
* If converting to a tar-based phar archive, the |
| 256 |
* default extensions are .tar, .tar.gz, |
| 257 |
* and .tar.bz2 depending on specified compression. |
| 258 |
* For zip-based archives, the |
| 259 |
* default extension is .zip. |
| 260 |
* </p> |
| 261 |
* @return PharData The method returns a PharData object on success and throws an |
| 262 |
* exception on failure. |
| 263 |
*/ |
| 264 |
public function convertToData ($format = null, $compression = null, $extension = null) {} |
| 265 |
|
| 266 |
/** |
| 267 |
* Copy a file internal to the phar archive to another new file within the phar |
| 268 |
* @link http://www.php.net/manual/en/phar.copy.php |
| 269 |
* @param oldfile string <p> |
| 270 |
* </p> |
| 271 |
* @param newfile string <p> |
| 272 |
* </p> |
| 273 |
* @return bool returns true on success, but it is safer to encase method call in a |
| 274 |
* try/catch block and assume success if no exception is thrown. |
| 275 |
*/ |
| 276 |
public function copy ($oldfile, $newfile) {} |
| 277 |
|
| 278 |
/** |
| 279 |
* Returns the number of entries (files) in the Phar archive |
| 280 |
* @link http://www.php.net/manual/en/phar.count.php |
| 281 |
* @return int The number of files contained within this phar, or 0 (the number zero) |
| 282 |
* if none. |
| 283 |
*/ |
| 284 |
public function count () {} |
| 285 |
|
| 286 |
/** |
| 287 |
* Delete a file within a phar archive |
| 288 |
* @link http://www.php.net/manual/en/phar.delete.php |
| 289 |
* @param entry string <p> |
| 290 |
* Path within an archive to the file to delete. |
| 291 |
* </p> |
| 292 |
* @return bool returns true on success, but it is better to check for thrown exception, |
| 293 |
* and assume success if none is thrown. |
| 294 |
*/ |
| 295 |
public function delete ($entry) {} |
| 296 |
|
| 297 |
/** |
| 298 |
* Deletes the global metadata of the phar |
| 299 |
* @link http://www.php.net/manual/en/phar.delmetadata.php |
| 300 |
* @return bool returns true on success, but it is better to check for thrown exception, |
| 301 |
* and assume success if none is thrown. |
| 302 |
*/ |
| 303 |
public function delMetadata () {} |
| 304 |
|
| 305 |
/** |
| 306 |
* Extract the contents of a phar archive to a directory |
| 307 |
* @link http://www.php.net/manual/en/phar.extractto.php |
| 308 |
* @param pathto string <p> |
| 309 |
* Path within an archive to the file to delete. |
| 310 |
* </p> |
| 311 |
* @param files string|array[optional] <p> |
| 312 |
* The name of a file or directory to extract, or an array of files/directories to extract |
| 313 |
* </p> |
| 314 |
* @param overwrite bool[optional] <p> |
| 315 |
* Set to true to enable overwriting existing files |
| 316 |
* </p> |
| 317 |
* @return bool returns true on success, but it is better to check for thrown exception, |
| 318 |
* and assume success if none is thrown. |
| 319 |
*/ |
| 320 |
public function extractTo ($pathto, $files = null, $overwrite = null) {} |
| 321 |
|
| 322 |
public function getAlias () {} |
| 323 |
|
| 324 |
public function getPath () {} |
| 325 |
|
| 326 |
/** |
| 327 |
* Returns phar archive meta-data |
| 328 |
* @link http://www.php.net/manual/en/phar.getmetadata.php |
| 329 |
* @return mixed any PHP variable that can be serialized and is stored as meta-data for the Phar archive, |
| 330 |
* or &null; if no meta-data is stored. |
| 331 |
*/ |
| 332 |
public function getMetadata () {} |
| 333 |
|
| 334 |
/** |
| 335 |
* Return whether phar was modified |
| 336 |
* @link http://www.php.net/manual/en/phar.getmodified.php |
| 337 |
* @return bool true if the phar has been modified since opened, false if not. |
| 338 |
*/ |
| 339 |
public function getModified () {} |
| 340 |
|
| 341 |
/** |
| 342 |
* Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive |
| 343 |
* @link http://www.php.net/manual/en/phar.getsignature.php |
| 344 |
* @return array Array with the opened archive's signature in hash key and MD5, |
| 345 |
* SHA-1, |
| 346 |
* SHA-256, SHA-512, or OpenSSL |
| 347 |
* in hash_type. This signature is a hash calculated on the |
| 348 |
* entire phar's contents, and may be used to verify the integrity of the archive. |
| 349 |
* A valid signature is absolutely required of all executable phar archives if the |
| 350 |
* phar.require_hash INI variable |
| 351 |
* is set to true. |
| 352 |
*/ |
| 353 |
public function getSignature () {} |
| 354 |
|
| 355 |
/** |
| 356 |
* Return the PHP loader or bootstrap stub of a Phar archive |
| 357 |
* @link http://www.php.net/manual/en/phar.getstub.php |
| 358 |
* @return string a string containing the contents of the bootstrap loader (stub) of |
| 359 |
* the current Phar archive. |
| 360 |
*/ |
| 361 |
public function getStub () {} |
| 362 |
|
| 363 |
/** |
| 364 |
* Return version info of Phar archive |
| 365 |
* @link http://www.php.net/manual/en/phar.getversion.php |
| 366 |
* @return string The opened archive's API version. This is not to be confused with |
| 367 |
* the API version that the loaded phar extension will use to create |
| 368 |
* new phars. Each Phar archive has the API version hard-coded into |
| 369 |
* its manifest. See Phar file format |
| 370 |
* documentation for more information. |
| 371 |
*/ |
| 372 |
public function getVersion () {} |
| 373 |
|
| 374 |
/** |
| 375 |
* Returns whether phar has global meta-data |
| 376 |
* @link http://www.php.net/manual/en/phar.hasmetadata.php |
| 377 |
* @return bool true if meta-data has been set, and false if not. |
| 378 |
*/ |
| 379 |
public function hasMetadata () {} |
| 380 |
|
| 381 |
/** |
| 382 |
* Used to determine whether Phar write operations are being buffered, or are flushing directly to disk |
| 383 |
* @link http://www.php.net/manual/en/phar.isbuffering.php |
| 384 |
* @return bool true if the write operations are being buffer, false otherwise. |
| 385 |
*/ |
| 386 |
public function isBuffering () {} |
| 387 |
|
| 388 |
/** |
| 389 |
* Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on) |
| 390 |
* @link http://www.php.net/manual/en/phar.iscompressed.php |
| 391 |
* @return mixed Phar::GZ, Phar::BZ2 or false |
| 392 |
*/ |
| 393 |
public function isCompressed () {} |
| 394 |
|
| 395 |
/** |
| 396 |
* Returns true if the phar archive is based on the tar/phar/zip file format depending on the parameter |
| 397 |
* @link http://www.php.net/manual/en/phar.isfileformat.php |
| 398 |
* @param format int <p> |
| 399 |
* Either Phar::PHAR, Phar::TAR, or |
| 400 |
* Phar::ZIP to test for the format of the archive. |
| 401 |
* </p> |
| 402 |
* @return bool true if the phar archive matches the file format requested by the parameter |
| 403 |
*/ |
| 404 |
public function isFileFormat ($format) {} |
| 405 |
|
| 406 |
/** |
| 407 |
* Returns true if the phar archive can be modified |
| 408 |
* @link http://www.php.net/manual/en/phar.iswritable.php |
| 409 |
* @return bool true if the phar archive can be modified |
| 410 |
*/ |
| 411 |
public function isWritable () {} |
| 412 |
|
| 413 |
/** |
| 414 |
* determines whether a file exists in the phar |
| 415 |
* @link http://www.php.net/manual/en/phar.offsetexists.php |
| 416 |
* @param offset string <p> |
| 417 |
* The filename (relative path) to look for in a Phar. |
| 418 |
* </p> |
| 419 |
* @return bool true if the file exists within the phar, or false if not. |
| 420 |
*/ |
| 421 |
public function offsetExists ($offset) {} |
| 422 |
|
| 423 |
/** |
| 424 |
* Gets a <classname>PharFileInfo</classname> object for a specific file |
| 425 |
* @link http://www.php.net/manual/en/phar.offsetget.php |
| 426 |
* @param offset string <p> |
| 427 |
* The filename (relative path) to look for in a Phar. |
| 428 |
* </p> |
| 429 |
* @return int A PharFileInfo object is returned that can be used to |
| 430 |
* iterate over a file's contents or to retrieve information about the current file. |
| 431 |
*/ |
| 432 |
public function offsetGet ($offset) {} |
| 433 |
|
| 434 |
/** |
| 435 |
* set the contents of an internal file to those of an external file |
| 436 |
* @link http://www.php.net/manual/en/phar.offsetset.php |
| 437 |
* @param offset string <p> |
| 438 |
* The filename (relative path) to modify in a Phar. |
| 439 |
* </p> |
| 440 |
* @param value string <p> |
| 441 |
* Content of the file. |
| 442 |
* </p> |
| 443 |
* @return void No return values. |
| 444 |
*/ |
| 445 |
public function offsetSet ($offset, $value) {} |
| 446 |
|
| 447 |
/** |
| 448 |
* remove a file from a phar |
| 449 |
* @link http://www.php.net/manual/en/phar.offsetunset.php |
| 450 |
* @param offset string <p> |
| 451 |
* The filename (relative path) to modify in a Phar. |
| 452 |
* </p> |
| 453 |
* @return bool Returns true on success, false on failure. |
| 454 |
*/ |
| 455 |
public function offsetUnset ($offset) {} |
| 456 |
|
| 457 |
/** |
| 458 |
* Set the alias for the Phar archive |
| 459 |
* @link http://www.php.net/manual/en/phar.setalias.php |
| 460 |
* @param alias string <p> |
| 461 |
* A shorthand string that this archive can be referred to in phar |
| 462 |
* stream wrapper access. |
| 463 |
* </p> |
| 464 |
* @return bool |
| 465 |
*/ |
| 466 |
public function setAlias ($alias) {} |
| 467 |
|
| 468 |
/** |
| 469 |
* Used to set the PHP loader or bootstrap stub of a Phar archive to the default loader |
| 470 |
* @link http://www.php.net/manual/en/phar.setdefaultstub.php |
| 471 |
* @param index string[optional] <p> |
| 472 |
* Relative path within the phar archive to run if accessed on the command-line |
| 473 |
* </p> |
| 474 |
* @param webindex string[optional] <p> |
| 475 |
* Relative path within the phar archive to run if accessed through a web browser |
| 476 |
* </p> |
| 477 |
* @return bool Returns true on success, false on failure. |
| 478 |
*/ |
| 479 |
public function setDefaultStub ($index = null, $webindex = null) {} |
| 480 |
|
| 481 |
/** |
| 482 |
* Sets phar archive meta-data |
| 483 |
* @link http://www.php.net/manual/en/phardata.setmetadata.php |
| 484 |
* @param metadata mixed <p> |
| 485 |
* Any PHP variable containing information to store that describes the phar archive |
| 486 |
* </p> |
| 487 |
* @param metadata mixed |
| 488 |
* @return void |
| 489 |
*/ |
| 490 |
public function setMetadata ($metadata, $metadata) {} |
| 491 |
|
| 492 |
/** |
| 493 |
* set the signature algorithm for a phar and apply it. The |
| 494 |
* @link http://www.php.net/manual/en/phardata.setsignaturealgorithm.php |
| 495 |
* @param sigtype int <p> |
| 496 |
* One of Phar::MD5, |
| 497 |
* Phar::SHA1, Phar::SHA256, |
| 498 |
* Phar::SHA512, or Phar::PGP |
| 499 |
* </p> |
| 500 |
* @param privatekey string[optional] <p> |
| 501 |
* The contents of an OpenSSL private key, as extracted from a certificate or |
| 502 |
* OpenSSL key file: |
| 503 |
* |
| 504 |
* setSignatureAlgorithm(Phar::OPENSSL, $pkey); |
| 505 |
* ?> |
| 506 |
* ]]> |
| 507 |
* |
| 508 |
* See phar introduction for instructions on |
| 509 |
* naming and placement of the public key file. |
| 510 |
* </p> |
| 511 |
* @param sigtype int |
| 512 |
* @return void |
| 513 |
*/ |
| 514 |
public function setSignatureAlgorithm ($sigtype, $privatekey = null, $sigtype) {} |
| 515 |
|
| 516 |
/** |
| 517 |
* Used to set the PHP loader or bootstrap stub of a Phar archive |
| 518 |
* @link http://www.php.net/manual/en/phar.setstub.php |
| 519 |
* @param stub string <p> |
| 520 |
* A string or an open stream handle to use as the executable stub for this |
| 521 |
* phar archive. |
| 522 |
* </p> |
| 523 |
* @param len int[optional] <p> |
| 524 |
* |
| 525 |
* </p> |
| 526 |
* @return bool Returns true on success, false on failure. |
| 527 |
*/ |
| 528 |
public function setStub ($stub, $len = null) {} |
| 529 |
|
| 530 |
/** |
| 531 |
* Start buffering Phar write operations, do not modify the Phar object on disk |
| 532 |
* @link http://www.php.net/manual/en/phar.startbuffering.php |
| 533 |
* @return void |
| 534 |
*/ |
| 535 |
public function startBuffering () {} |
| 536 |
|
| 537 |
/** |
| 538 |
* Stop buffering write requests to the Phar archive, and save changes to disk |
| 539 |
* @link http://www.php.net/manual/en/phar.stopbuffering.php |
| 540 |
* @return void |
| 541 |
*/ |
| 542 |
public function stopBuffering () {} |
| 543 |
|
| 544 |
/** |
| 545 |
* Returns the api version |
| 546 |
* @link http://www.php.net/manual/en/phar.apiversion.php |
| 547 |
* @return string The API version string as in "1.0.0". |
| 548 |
*/ |
| 549 |
final public static function apiVersion () {} |
| 550 |
|
| 551 |
/** |
| 552 |
* Returns whether phar extension supports compression using either zlib or bzip2 |
| 553 |
* @link http://www.php.net/manual/en/phar.cancompress.php |
| 554 |
* @param type int[optional] <p> |
| 555 |
* Either Phar::GZ or Phar::BZ2 can be |
| 556 |
* used to test whether compression is possible with a specific compression |
| 557 |
* algorithm (zlib or bzip2). |
| 558 |
* </p> |
| 559 |
* @return bool true if compression/decompression is available, false if not. |
| 560 |
*/ |
| 561 |
final public static function canCompress ($type = null) {} |
| 562 |
|
| 563 |
/** |
| 564 |
* Returns whether phar extension supports writing and creating phars |
| 565 |
* @link http://www.php.net/manual/en/phar.canwrite.php |
| 566 |
* @return bool true if write access is enabled, false if it is disabled. |
| 567 |
*/ |
| 568 |
final public static function canWrite () {} |
| 569 |
|
| 570 |
/** |
| 571 |
* Create a phar-file format specific stub |
| 572 |
* @link http://www.php.net/manual/en/phar.createdefaultstub.php |
| 573 |
* @param indexfile string[optional] |
| 574 |
* @param webindexfile string[optional] |
| 575 |
* @return string a string containing the contents of a customized bootstrap loader (stub) |
| 576 |
* that allows the created Phar archive to work with or without the Phar extension |
| 577 |
* enabled. |
| 578 |
*/ |
| 579 |
final public static function createDefaultStub ($indexfile = null, $webindexfile = null) {} |
| 580 |
|
| 581 |
/** |
| 582 |
* Return array of supported compression algorithms |
| 583 |
* @link http://www.php.net/manual/en/phar.getsupportedcompression.php |
| 584 |
* @return array an array containing any of Phar::GZ or |
| 585 |
* Phar::BZ2, depending on the availability of |
| 586 |
* the zlib extension or the |
| 587 |
* bz2 extension. |
| 588 |
*/ |
| 589 |
final public static function getSupportedCompression () {} |
| 590 |
|
| 591 |
/** |
| 592 |
* Return array of supported signature types |
| 593 |
* @link http://www.php.net/manual/en/phar.getsupportedsignatures.php |
| 594 |
* @return array an array containing any of MD5, SHA-1, |
| 595 |
* SHA-256, SHA-512, or OpenSSL. |
| 596 |
*/ |
| 597 |
final public static function getSupportedSignatures () {} |
| 598 |
|
| 599 |
/** |
| 600 |
* instructs phar to intercept fopen, file_get_contents, opendir, and all of the stat-related functions |
| 601 |
* @link http://www.php.net/manual/en/phar.interceptfilefuncs.php |
| 602 |
* @return void |
| 603 |
*/ |
| 604 |
final public static function interceptFileFuncs () {} |
| 605 |
|
| 606 |
/** |
| 607 |
* Returns whether the given filename is a valid phar filename |
| 608 |
* @link http://www.php.net/manual/en/phar.isvalidpharfilename.php |
| 609 |
* @param filename string <p> |
| 610 |
* The name or full path to a phar archive not yet created |
| 611 |
* </p> |
| 612 |
* @param executable bool[optional] <p> |
| 613 |
* This parameter determines whether the filename should be treated as |
| 614 |
* a phar executable archive, or a data non-executable archive |
| 615 |
* </p> |
| 616 |
* @return bool true if the filename is valid, false if not. |
| 617 |
*/ |
| 618 |
final public static function isValidPharFilename ($filename, $executable = null) {} |
| 619 |
|
| 620 |
/** |
| 621 |
* Loads any phar archive with an alias |
| 622 |
* @link http://www.php.net/manual/en/phar.loadphar.php |
| 623 |
* @param filename string <p> |
| 624 |
* the full or relative path to the phar archive to open |
| 625 |
* </p> |
| 626 |
* @param alias string[optional] <p> |
| 627 |
* The alias that may be used to refer to the phar archive. Note |
| 628 |
* that many phar archives specify an explicit alias inside the |
| 629 |
* phar archive, and a PharException will be thrown if |
| 630 |
* a new alias is specified in this case. |
| 631 |
* </p> |
| 632 |
* @return bool Returns true on success, false on failure. |
| 633 |
*/ |
| 634 |
final public static function loadPhar ($filename, $alias = null) {} |
| 635 |
|
| 636 |
/** |
| 637 |
* Reads the currently executed file (a phar) and registers its manifest |
| 638 |
* @link http://www.php.net/manual/en/phar.mapphar.php |
| 639 |
* @param alias string[optional] <p> |
| 640 |
* The alias that can be used in phar:// URLs to |
| 641 |
* refer to this archive, rather than its full path. |
| 642 |
* </p> |
| 643 |
* @param dataoffset int[optional] <p> |
| 644 |
* Unused variable, here for compatibility with PEAR's PHP_Archive. |
| 645 |
* </p> |
| 646 |
* @return bool Returns true on success, false on failure. |
| 647 |
*/ |
| 648 |
final public static function mapPhar ($alias = null, $dataoffset = null) {} |
| 649 |
|
| 650 |
/** |
| 651 |
* Returns the full path on disk or full phar URL to the currently executing Phar archive |
| 652 |
* @link http://www.php.net/manual/en/phar.running.php |
| 653 |
* @param retphar bool[optional] <p> |
| 654 |
* If false, the full path on disk to the phar |
| 655 |
* archive is returned. If true, a full phar URL is returned. |
| 656 |
* </p> |
| 657 |
* @return string the filename if valid, empty string otherwise. |
| 658 |
*/ |
| 659 |
final public static function running ($retphar = null) {} |
| 660 |
|
| 661 |
/** |
| 662 |
* Mount an external path or file to a virtual location within the phar archive |
| 663 |
* @link http://www.php.net/manual/en/phar.mount.php |
| 664 |
* @param pharpath string <p> |
| 665 |
* The internal path within the phar archive to use as the mounted path location. |
| 666 |
* This must be a relative path within the phar archive, and must not already exist. |
| 667 |
* </p> |
| 668 |
* @param externalpath string <p> |
| 669 |
* A path or URL to an external file or directory to mount within the phar archive |
| 670 |
* </p> |
| 671 |
* @return void No return. PharException is thrown on failure. |
| 672 |
*/ |
| 673 |
final public static function mount ($pharpath, $externalpath) {} |
| 674 |
|
| 675 |
/** |
| 676 |
* Defines a list of up to 4 $_SERVER variables that should be modified for execution |
| 677 |
* @link http://www.php.net/manual/en/phar.mungserver.php |
| 678 |
* @param munglist array <p> |
| 679 |
* an array containing as string indices any of |
| 680 |
* REQUEST_URI, PHP_SELF, |
| 681 |
* SCRIPT_NAME and SCRIPT_FILENAME. |
| 682 |
* Other values trigger an exception, and Phar::mungServer |
| 683 |
* is case-sensitive. |
| 684 |
* </p> |
| 685 |
* @return void No return. |
| 686 |
*/ |
| 687 |
final public static function mungServer (array $munglist) {} |
| 688 |
|
| 689 |
/** |
| 690 |
* Completely remove a phar archive from disk and from memory |
| 691 |
* @link http://www.php.net/manual/en/phar.unlinkarchive.php |
| 692 |
* @param archive string <p> |
| 693 |
* The path on disk to the phar archive. |
| 694 |
* </p> |
| 695 |
* @return bool Returns true on success, false on failure. |
| 696 |
*/ |
| 697 |
final public static function unlinkArchive ($archive) {} |
| 698 |
|
| 699 |
/** |
| 700 |
* mapPhar for web-based phars. front controller for web applications |
| 701 |
* @link http://www.php.net/manual/en/phar.webphar.php |
| 702 |
* @param alias string[optional] <p> |
| 703 |
* The alias that can be used in phar:// URLs to |
| 704 |
* refer to this archive, rather than its full path. |
| 705 |
* </p> |
| 706 |
* @param index string[optional] <p> |
| 707 |
* The location within the phar of the directory index. |
| 708 |
* </p> |
| 709 |
* @param f404 string[optional] <p> |
| 710 |
* The location of the script to run when a file is not found. This |
| 711 |
* script should output the proper HTTP 404 headers. |
| 712 |
* </p> |
| 713 |
* @param mimetypes array[optional] <p> |
| 714 |
* An array mapping additional file extensions to MIME type. |
| 715 |
* If the default mapping is sufficient, pass an empty array. |
| 716 |
* By default, these extensions are mapped to these MIME types: |
| 717 |
* |
| 718 |
* Phar::PHPS, // pass to highlight_file() |
| 719 |
* 'c' => 'text/plain', |
| 720 |
* 'cc' => 'text/plain', |
| 721 |
* 'cpp' => 'text/plain', |
| 722 |
* 'c++' => 'text/plain', |
| 723 |
* 'dtd' => 'text/plain', |
| 724 |
* 'h' => 'text/plain', |
| 725 |
* 'log' => 'text/plain', |
| 726 |
* 'rng' => 'text/plain', |
| 727 |
* 'txt' => 'text/plain', |
| 728 |
* 'xsd' => 'text/plain', |
| 729 |
* 'php' => Phar::PHP, // parse as PHP |
| 730 |
* 'inc' => Phar::PHP, // parse as PHP |
| 731 |
* 'avi' => 'video/avi', |
| 732 |
* 'bmp' => 'image/bmp', |
| 733 |
* 'css' => 'text/css', |
| 734 |
* 'gif' => 'image/gif', |
| 735 |
* 'htm' => 'text/html', |
| 736 |
* 'html' => 'text/html', |
| 737 |
* 'htmls' => 'text/html', |
| 738 |
* 'ico' => 'image/x-ico', |
| 739 |
* 'jpe' => 'image/jpeg', |
| 740 |
* 'jpg' => 'image/jpeg', |
| 741 |
* 'jpeg' => 'image/jpeg', |
| 742 |
* 'js' => 'application/x-javascript', |
| 743 |
* 'midi' => 'audio/midi', |
| 744 |
* 'mid' => 'audio/midi', |
| 745 |
* 'mod' => 'audio/mod', |
| 746 |
* 'mov' => 'movie/quicktime', |
| 747 |
* 'mp3' => 'audio/mp3', |
| 748 |
* 'mpg' => 'video/mpeg', |
| 749 |
* 'mpeg' => 'video/mpeg', |
| 750 |
* 'pdf' => 'application/pdf', |
| 751 |
* 'png' => 'image/png', |
| 752 |
* 'swf' => 'application/shockwave-flash', |
| 753 |
* 'tif' => 'image/tiff', |
| 754 |
* 'tiff' => 'image/tiff', |
| 755 |
* 'wav' => 'audio/wav', |
| 756 |
* 'xbm' => 'image/xbm', |
| 757 |
* 'xml' => 'text/xml', |
| 758 |
* ); |
| 759 |
* ?> |
| 760 |
* ]]> |
| 761 |
* |
| 762 |
* </p> |
| 763 |
* @param rewrites callable[optional] <p> |
| 764 |
* The rewrites function is passed a string as its only parameter and must return a string or false. |
| 765 |
* </p> |
| 766 |
* <p> |
| 767 |
* If you are using fast-cgi or cgi then the parameter passed to the function is the value of the |
| 768 |
* $_SERVER['PATH_INFO'] variable. Otherwise, the parameter passed to the function is the value |
| 769 |
* of the $_SERVER['REQUEST_URI'] variable. |
| 770 |
* </p> |
| 771 |
* <p> |
| 772 |
* If a string is returned it is used as the internal file path. If false is returned then webPhar() will |
| 773 |
* send a HTTP 403 Denied Code. |
| 774 |
* </p> |
| 775 |
* @return void |
| 776 |
*/ |
| 777 |
final public static function webPhar ($alias = null, $index = null, $f404 = null, array $mimetypes = null, $rewrites = null) {} |
| 778 |
|
| 779 |
/** |
| 780 |
* Returns whether current entry is a directory and not '.' or '..' |
| 781 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.haschildren.php |
| 782 |
* @param allow_links bool[optional] <p> |
| 783 |
* |
| 784 |
* </p> |
| 785 |
* @return bool whether the current entry is a directory, but not '.' or '..' |
| 786 |
*/ |
| 787 |
public function hasChildren ($allow_links = null) {} |
| 788 |
|
| 789 |
/** |
| 790 |
* Returns an iterator for the current entry if it is a directory |
| 791 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.getchildren.php |
| 792 |
* @return mixed The filename, file information, or $this depending on the set flags. |
| 793 |
* See the FilesystemIterator |
| 794 |
* constants. |
| 795 |
*/ |
| 796 |
public function getChildren () {} |
| 797 |
|
| 798 |
/** |
| 799 |
* Get sub path |
| 800 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.getsubpath.php |
| 801 |
* @return string The sub path (sub directory). |
| 802 |
*/ |
| 803 |
public function getSubPath () {} |
| 804 |
|
| 805 |
/** |
| 806 |
* Get sub path and name |
| 807 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.getsubpathname.php |
| 808 |
* @return string The sub path (sub directory) and filename. |
| 809 |
*/ |
| 810 |
public function getSubPathname () {} |
| 811 |
|
| 812 |
/** |
| 813 |
* Rewinds back to the beginning |
| 814 |
* @link http://www.php.net/manual/en/filesystemiterator.rewind.php |
| 815 |
* @return void |
| 816 |
*/ |
| 817 |
public function rewind () {} |
| 818 |
|
| 819 |
/** |
| 820 |
* Move to the next file |
| 821 |
* @link http://www.php.net/manual/en/filesystemiterator.next.php |
| 822 |
* @return void |
| 823 |
*/ |
| 824 |
public function next () {} |
| 825 |
|
| 826 |
/** |
| 827 |
* Retrieve the key for the current file |
| 828 |
* @link http://www.php.net/manual/en/filesystemiterator.key.php |
| 829 |
* @return string the pathname or filename depending on the set flags. |
| 830 |
* See the FilesystemIterator constants. |
| 831 |
*/ |
| 832 |
public function key () {} |
| 833 |
|
| 834 |
/** |
| 835 |
* The current file |
| 836 |
* @link http://www.php.net/manual/en/filesystemiterator.current.php |
| 837 |
* @return mixed The filename, file information, or $this depending on the set flags. |
| 838 |
* See the FilesystemIterator constants. |
| 839 |
*/ |
| 840 |
public function current () {} |
| 841 |
|
| 842 |
/** |
| 843 |
* Get the handling flags |
| 844 |
* @link http://www.php.net/manual/en/filesystemiterator.getflags.php |
| 845 |
* @return int The integer value of the set flags. |
| 846 |
*/ |
| 847 |
public function getFlags () {} |
| 848 |
|
| 849 |
/** |
| 850 |
* Sets handling flags |
| 851 |
* @link http://www.php.net/manual/en/filesystemiterator.setflags.php |
| 852 |
* @param flags int[optional] <p> |
| 853 |
* The handling flags to set. |
| 854 |
* See the FilesystemIterator constants. |
| 855 |
* </p> |
| 856 |
* @return void |
| 857 |
*/ |
| 858 |
public function setFlags ($flags = null) {} |
| 859 |
|
| 860 |
/** |
| 861 |
* Return file name of current DirectoryIterator item. |
| 862 |
* @link http://www.php.net/manual/en/directoryiterator.getfilename.php |
| 863 |
* @return string the file name of the current DirectoryIterator item. |
| 864 |
*/ |
| 865 |
public function getFilename () {} |
| 866 |
|
| 867 |
/** |
| 868 |
* Gets the file extension |
| 869 |
* @link http://www.php.net/manual/en/directoryiterator.getextension.php |
| 870 |
* @return string a string containing the file extension, or an |
| 871 |
* empty string if the file has no extension. |
| 872 |
*/ |
| 873 |
public function getExtension () {} |
| 874 |
|
| 875 |
/** |
| 876 |
* Get base name of current DirectoryIterator item. |
| 877 |
* @link http://www.php.net/manual/en/directoryiterator.getbasename.php |
| 878 |
* @param suffix string[optional] <p> |
| 879 |
* If the base name ends in suffix, |
| 880 |
* this will be cut. |
| 881 |
* </p> |
| 882 |
* @return string The base name of the current DirectoryIterator item. |
| 883 |
*/ |
| 884 |
public function getBasename ($suffix = null) {} |
| 885 |
|
| 886 |
/** |
| 887 |
* Determine if current DirectoryIterator item is '.' or '..' |
| 888 |
* @link http://www.php.net/manual/en/directoryiterator.isdot.php |
| 889 |
* @return bool true if the entry is . or .., |
| 890 |
* otherwise false |
| 891 |
*/ |
| 892 |
public function isDot () {} |
| 893 |
|
| 894 |
/** |
| 895 |
* Check whether current DirectoryIterator position is a valid file |
| 896 |
* @link http://www.php.net/manual/en/directoryiterator.valid.php |
| 897 |
* @return bool true if the position is valid, otherwise false |
| 898 |
*/ |
| 899 |
public function valid () {} |
| 900 |
|
| 901 |
/** |
| 902 |
* Seek to a DirectoryIterator item |
| 903 |
* @link http://www.php.net/manual/en/directoryiterator.seek.php |
| 904 |
* @param position int <p> |
| 905 |
* The zero-based numeric position to seek to. |
| 906 |
* </p> |
| 907 |
* @return void |
| 908 |
*/ |
| 909 |
public function seek ($position) {} |
| 910 |
|
| 911 |
/** |
| 912 |
* Get file name as a string |
| 913 |
* @link http://www.php.net/manual/en/directoryiterator.tostring.php |
| 914 |
* @return string the file name of the current DirectoryIterator item. |
| 915 |
*/ |
| 916 |
public function __toString () {} |
| 917 |
|
| 918 |
/** |
| 919 |
* Gets the path to the file |
| 920 |
* @link http://www.php.net/manual/en/splfileinfo.getpathname.php |
| 921 |
* @return string The path to the file. |
| 922 |
*/ |
| 923 |
public function getPathname () {} |
| 924 |
|
| 925 |
/** |
| 926 |
* Gets file permissions |
| 927 |
* @link http://www.php.net/manual/en/splfileinfo.getperms.php |
| 928 |
* @return int the file permissions. |
| 929 |
*/ |
| 930 |
public function getPerms () {} |
| 931 |
|
| 932 |
/** |
| 933 |
* Gets the inode for the file |
| 934 |
* @link http://www.php.net/manual/en/splfileinfo.getinode.php |
| 935 |
* @return int the inode number for the filesystem object. |
| 936 |
*/ |
| 937 |
public function getInode () {} |
| 938 |
|
| 939 |
/** |
| 940 |
* Gets file size |
| 941 |
* @link http://www.php.net/manual/en/splfileinfo.getsize.php |
| 942 |
* @return int The filesize in bytes. |
| 943 |
*/ |
| 944 |
public function getSize () {} |
| 945 |
|
| 946 |
/** |
| 947 |
* Gets the owner of the file |
| 948 |
* @link http://www.php.net/manual/en/splfileinfo.getowner.php |
| 949 |
* @return int The owner id in numerical format. |
| 950 |
*/ |
| 951 |
public function getOwner () {} |
| 952 |
|
| 953 |
/** |
| 954 |
* Gets the file group |
| 955 |
* @link http://www.php.net/manual/en/splfileinfo.getgroup.php |
| 956 |
* @return int The group id in numerical format. |
| 957 |
*/ |
| 958 |
public function getGroup () {} |
| 959 |
|
| 960 |
/** |
| 961 |
* Gets last access time of the file |
| 962 |
* @link http://www.php.net/manual/en/splfileinfo.getatime.php |
| 963 |
* @return int the time the file was last accessed. |
| 964 |
*/ |
| 965 |
public function getATime () {} |
| 966 |
|
| 967 |
/** |
| 968 |
* Gets the last modified time |
| 969 |
* @link http://www.php.net/manual/en/splfileinfo.getmtime.php |
| 970 |
* @return int the last modified time for the file, in a Unix timestamp. |
| 971 |
*/ |
| 972 |
public function getMTime () {} |
| 973 |
|
| 974 |
/** |
| 975 |
* Gets the inode change time |
| 976 |
* @link http://www.php.net/manual/en/splfileinfo.getctime.php |
| 977 |
* @return int The last change time, in a Unix timestamp. |
| 978 |
*/ |
| 979 |
public function getCTime () {} |
| 980 |
|
| 981 |
/** |
| 982 |
* Gets file type |
| 983 |
* @link http://www.php.net/manual/en/splfileinfo.gettype.php |
| 984 |
* @return string A string representing the type of the entry. |
| 985 |
* May be one of file, link, |
| 986 |
* or dir |
| 987 |
*/ |
| 988 |
public function getType () {} |
| 989 |
|
| 990 |
/** |
| 991 |
* Tells if file is readable |
| 992 |
* @link http://www.php.net/manual/en/splfileinfo.isreadable.php |
| 993 |
* @return bool true if readable, false otherwise. |
| 994 |
*/ |
| 995 |
public function isReadable () {} |
| 996 |
|
| 997 |
/** |
| 998 |
* Tells if the file is executable |
| 999 |
* @link http://www.php.net/manual/en/splfileinfo.isexecutable.php |
| 1000 |
* @return bool true if executable, false otherwise. |
| 1001 |
*/ |
| 1002 |
public function isExecutable () {} |
| 1003 |
|
| 1004 |
/** |
| 1005 |
* Tells if the object references a regular file |
| 1006 |
* @link http://www.php.net/manual/en/splfileinfo.isfile.php |
| 1007 |
* @return bool true if the file exists and is a regular file (not a link), false otherwise. |
| 1008 |
*/ |
| 1009 |
public function isFile () {} |
| 1010 |
|
| 1011 |
/** |
| 1012 |
* Tells if the file is a directory |
| 1013 |
* @link http://www.php.net/manual/en/splfileinfo.isdir.php |
| 1014 |
* @return bool true if a directory, false otherwise. |
| 1015 |
*/ |
| 1016 |
public function isDir () {} |
| 1017 |
|
| 1018 |
/** |
| 1019 |
* Tells if the file is a link |
| 1020 |
* @link http://www.php.net/manual/en/splfileinfo.islink.php |
| 1021 |
* @return bool true if the file is a link, false otherwise. |
| 1022 |
*/ |
| 1023 |
public function isLink () {} |
| 1024 |
|
| 1025 |
/** |
| 1026 |
* Gets the target of a link |
| 1027 |
* @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php |
| 1028 |
* @return string the target of the filesystem link. |
| 1029 |
*/ |
| 1030 |
public function getLinkTarget () {} |
| 1031 |
|
| 1032 |
/** |
| 1033 |
* Gets absolute path to file |
| 1034 |
* @link http://www.php.net/manual/en/splfileinfo.getrealpath.php |
| 1035 |
* @return string the path to the file. |
| 1036 |
*/ |
| 1037 |
public function getRealPath () {} |
| 1038 |
|
| 1039 |
/** |
| 1040 |
* Gets an SplFileInfo object for the file |
| 1041 |
* @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php |
| 1042 |
* @param class_name string[optional] <p> |
| 1043 |
* Name of an SplFileInfo derived class to use. |
| 1044 |
* </p> |
| 1045 |
* @return SplFileInfo An SplFileInfo object created for the file. |
| 1046 |
*/ |
| 1047 |
public function getFileInfo ($class_name = null) {} |
| 1048 |
|
| 1049 |
/** |
| 1050 |
* Gets an SplFileInfo object for the path |
| 1051 |
* @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php |
| 1052 |
* @param class_name string[optional] <p> |
| 1053 |
* Name of an SplFileInfo derived class to use. |
| 1054 |
* </p> |
| 1055 |
* @return SplFileInfo an SplFileInfo object for the parent path of the file. |
| 1056 |
*/ |
| 1057 |
public function getPathInfo ($class_name = null) {} |
| 1058 |
|
| 1059 |
/** |
| 1060 |
* Gets an SplFileObject object for the file |
| 1061 |
* @link http://www.php.net/manual/en/splfileinfo.openfile.php |
| 1062 |
* @param open_mode string[optional] <p> |
| 1063 |
* The mode for opening the file. See the fopen |
| 1064 |
* documentation for descriptions of possible modes. The default |
| 1065 |
* is read only. |
| 1066 |
* </p> |
| 1067 |
* @param use_include_path bool[optional] <p> |
| 1068 |
* ¶meter.use_include_path; |
| 1069 |
* </p> |
| 1070 |
* @param context resource[optional] <p> |
| 1071 |
* ¶meter.context; |
| 1072 |
* </p> |
| 1073 |
* @return SplFileObject The opened file as an SplFileObject object. |
| 1074 |
*/ |
| 1075 |
public function openFile ($open_mode = null, $use_include_path = null, $context = null) {} |
| 1076 |
|
| 1077 |
/** |
| 1078 |
* Sets the class name used with <methodname>SplFileInfo::openFile</methodname> |
| 1079 |
* @link http://www.php.net/manual/en/splfileinfo.setfileclass.php |
| 1080 |
* @param class_name string[optional] <p> |
| 1081 |
* The class name to use when openFile() is called. |
| 1082 |
* </p> |
| 1083 |
* @return void |
| 1084 |
*/ |
| 1085 |
public function setFileClass ($class_name = null) {} |
| 1086 |
|
| 1087 |
/** |
| 1088 |
* Sets the class used with getFileInfo and getPathInfo |
| 1089 |
* @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php |
| 1090 |
* @param class_name string[optional] <p> |
| 1091 |
* The class name to use. |
| 1092 |
* </p> |
| 1093 |
* @return void |
| 1094 |
*/ |
| 1095 |
public function setInfoClass ($class_name = null) {} |
| 1096 |
|
| 1097 |
final public function _bad_state_ex () {} |
| 1098 |
|
| 1099 |
} |
| 1100 |
|
| 1101 |
class PharData extends RecursiveDirectoryIterator implements RecursiveIterator, SeekableIterator, Traversable, Iterator, Countable, ArrayAccess { |
| 1102 |
const CURRENT_MODE_MASK = 240; |
| 1103 |
const CURRENT_AS_PATHNAME = 32; |
| 1104 |
const CURRENT_AS_FILEINFO = 0; |
| 1105 |
const CURRENT_AS_SELF = 16; |
| 1106 |
const KEY_MODE_MASK = 3840; |
| 1107 |
const KEY_AS_PATHNAME = 0; |
| 1108 |
const FOLLOW_SYMLINKS = 512; |
| 1109 |
const KEY_AS_FILENAME = 256; |
| 1110 |
const NEW_CURRENT_AND_KEY = 256; |
| 1111 |
const OTHER_MODE_MASK = 12288; |
| 1112 |
const SKIP_DOTS = 4096; |
| 1113 |
const UNIX_PATHS = 8192; |
| 1114 |
|
| 1115 |
|
| 1116 |
/** |
| 1117 |
* Construct a non-executable tar or zip archive object |
| 1118 |
* @link http://www.php.net/manual/en/phardata.construct.php |
| 1119 |
* @param filename |
| 1120 |
* @param flags[optional] |
| 1121 |
* @param alias[optional] |
| 1122 |
* @param fileformat[optional] |
| 1123 |
*/ |
| 1124 |
public function __construct ($filename, $flags, $alias, $fileformat) {} |
| 1125 |
|
| 1126 |
public function __destruct () {} |
| 1127 |
|
| 1128 |
/** |
| 1129 |
* Add an empty directory to the tar/zip archive |
| 1130 |
* @link http://www.php.net/manual/en/phardata.addemptydir.php |
| 1131 |
* @param dirname string <p> |
| 1132 |
* The name of the empty directory to create in the phar archive |
| 1133 |
* </p> |
| 1134 |
* @return bool no return value, exception is thrown on failure. |
| 1135 |
*/ |
| 1136 |
public function addEmptyDir ($dirname) {} |
| 1137 |
|
| 1138 |
/** |
| 1139 |
* Add a file from the filesystem to the tar/zip archive |
| 1140 |
* @link http://www.php.net/manual/en/phardata.addfile.php |
| 1141 |
* @param file string <p> |
| 1142 |
* Full or relative path to a file on disk to be added |
| 1143 |
* to the phar archive. |
| 1144 |
* </p> |
| 1145 |
* @param localname string[optional] <p> |
| 1146 |
* Path that the file will be stored in the archive. |
| 1147 |
* </p> |
| 1148 |
* @return void no return value, exception is thrown on failure. |
| 1149 |
*/ |
| 1150 |
public function addFile ($file, $localname = null) {} |
| 1151 |
|
| 1152 |
/** |
| 1153 |
* Add a file from the filesystem to the tar/zip archive |
| 1154 |
* @link http://www.php.net/manual/en/phardata.addfromstring.php |
| 1155 |
* @param localname string <p> |
| 1156 |
* Path that the file will be stored in the archive. |
| 1157 |
* </p> |
| 1158 |
* @param contents string <p> |
| 1159 |
* The file contents to store |
| 1160 |
* </p> |
| 1161 |
* @return bool no return value, exception is thrown on failure. |
| 1162 |
*/ |
| 1163 |
public function addFromString ($localname, $contents) {} |
| 1164 |
|
| 1165 |
/** |
| 1166 |
* Construct a tar/zip archive from the files within a directory. |
| 1167 |
* @link http://www.php.net/manual/en/phardata.buildfromdirectory.php |
| 1168 |
* @param base_dir string <p> |
| 1169 |
* The full or relative path to the directory that contains all files |
| 1170 |
* to add to the archive. |
| 1171 |
* </p> |
| 1172 |
* @param regex string[optional] <p> |
| 1173 |
* An optional pcre regular expression that is used to filter the |
| 1174 |
* list of files. Only file paths matching the regular expression |
| 1175 |
* will be included in the archive. |
| 1176 |
* </p> |
| 1177 |
* @return array Phar::buildFromDirectory returns an associative array |
| 1178 |
* mapping internal path of file to the full path of the file on the |
| 1179 |
* filesystem. |
| 1180 |
*/ |
| 1181 |
public function buildFromDirectory ($base_dir, $regex = null) {} |
| 1182 |
|
| 1183 |
/** |
| 1184 |
* Construct a tar or zip archive from an iterator. |
| 1185 |
* @link http://www.php.net/manual/en/phardata.buildfromiterator.php |
| 1186 |
* @param iter Iterator <p> |
| 1187 |
* Any iterator that either associatively maps tar/zip file to location or |
| 1188 |
* returns SplFileInfo objects |
| 1189 |
* </p> |
| 1190 |
* @param base_directory string[optional] <p> |
| 1191 |
* For iterators that return SplFileInfo objects, the portion of each |
| 1192 |
* file's full path to remove when adding to the tar/zip archive |
| 1193 |
* </p> |
| 1194 |
* @return array PharData::buildFromIterator returns an associative array |
| 1195 |
* mapping internal path of file to the full path of the file on the |
| 1196 |
* filesystem. |
| 1197 |
*/ |
| 1198 |
public function buildFromIterator ($iter, $base_directory = null) {} |
| 1199 |
|
| 1200 |
/** |
| 1201 |
* Compresses all files in the current tar/zip archive |
| 1202 |
* @link http://www.php.net/manual/en/phardata.compressfiles.php |
| 1203 |
* @param compression int <p> |
| 1204 |
* Compression must be one of Phar::GZ, |
| 1205 |
* Phar::BZ2 to add compression, or Phar::NONE |
| 1206 |
* to remove compression. |
| 1207 |
* </p> |
| 1208 |
* @return bool Returns true on success, false on failure. |
| 1209 |
*/ |
| 1210 |
public function compressFiles ($compression) {} |
| 1211 |
|
| 1212 |
/** |
| 1213 |
* Decompresses all files in the current zip archive |
| 1214 |
* @link http://www.php.net/manual/en/phardata.decompressfiles.php |
| 1215 |
* @return bool Returns true on success, false on failure. |
| 1216 |
*/ |
| 1217 |
public function decompressFiles () {} |
| 1218 |
|
| 1219 |
/** |
| 1220 |
* Compresses the entire tar/zip archive using Gzip or Bzip2 compression |
| 1221 |
* @link http://www.php.net/manual/en/phardata.compress.php |
| 1222 |
* @param compression int <p> |
| 1223 |
* Compression must be one of Phar::GZ, |
| 1224 |
* Phar::BZ2 to add compression, or Phar::NONE |
| 1225 |
* to remove compression. |
| 1226 |
* </p> |
| 1227 |
* @param extension string[optional] <p> |
| 1228 |
* By default, the extension is .tar.gz or .tar.bz2 |
| 1229 |
* for compressing a tar, and .tar for decompressing. |
| 1230 |
* </p> |
| 1231 |
* @return object A PharData object is returned. |
| 1232 |
*/ |
| 1233 |
public function compress ($compression, $extension = null) {} |
| 1234 |
|
| 1235 |
/** |
| 1236 |
* Decompresses the entire Phar archive |
| 1237 |
* @link http://www.php.net/manual/en/phardata.decompress.php |
| 1238 |
* @param extension string[optional] <p> |
| 1239 |
* For decompressing, the default file extension |
| 1240 |
* is .phar.tar. |
| 1241 |
* Use this parameter to specify another file extension. Be aware |
| 1242 |
* that no non-executable archives cannot contain .phar |
| 1243 |
* in their filename. |
| 1244 |
* </p> |
| 1245 |
* @return object A PharData object is returned. |
| 1246 |
*/ |
| 1247 |
public function decompress ($extension = null) {} |
| 1248 |
|
| 1249 |
/** |
| 1250 |
* Convert a non-executable tar/zip archive to an executable phar archive |
| 1251 |
* @link http://www.php.net/manual/en/phardata.converttoexecutable.php |
| 1252 |
* @param format int[optional] <p> |
| 1253 |
* This should be one of Phar::PHAR, Phar::TAR, |
| 1254 |
* or Phar::ZIP. If set to &null;, the existing file format |
| 1255 |
* will be preserved. |
| 1256 |
* </p> |
| 1257 |
* @param compression int[optional] <p> |
| 1258 |
* This should be one of Phar::NONE for no whole-archive |
| 1259 |
* compression, Phar::GZ for zlib-based compression, and |
| 1260 |
* Phar::BZ2 for bzip-based compression. |
| 1261 |
* </p> |
| 1262 |
* @param extension string[optional] <p> |
| 1263 |
* This parameter is used to override the default file extension for a |
| 1264 |
* converted archive. Note that all zip- and tar-based phar archives must contain |
| 1265 |
* .phar in their file extension in order to be processed as a |
| 1266 |
* phar archive. |
| 1267 |
* </p> |
| 1268 |
* <p> |
| 1269 |
* If converting to a phar-based archive, the default extensions are |
| 1270 |
* .phar, .phar.gz, or .phar.bz2 |
| 1271 |
* depending on the specified compression. For tar-based phar archives, the |
| 1272 |
* default extensions are .phar.tar, .phar.tar.gz, |
| 1273 |
* and .phar.tar.bz2. For zip-based phar archives, the |
| 1274 |
* default extension is .phar.zip. |
| 1275 |
* </p> |
| 1276 |
* @return Phar The method returns a Phar object on success and throws an |
| 1277 |
* exception on failure. |
| 1278 |
*/ |
| 1279 |
public function convertToExecutable ($format = null, $compression = null, $extension = null) {} |
| 1280 |
|
| 1281 |
/** |
| 1282 |
* Convert a phar archive to a non-executable tar or zip file |
| 1283 |
* @link http://www.php.net/manual/en/phardata.converttodata.php |
| 1284 |
* @param format int[optional] <p> |
| 1285 |
* This should be one of Phar::TAR |
| 1286 |
* or Phar::ZIP. If set to &null;, the existing file format |
| 1287 |
* will be preserved. |
| 1288 |
* </p> |
| 1289 |
* @param compression int[optional] <p> |
| 1290 |
* This should be one of Phar::NONE for no whole-archive |
| 1291 |
* compression, Phar::GZ for zlib-based compression, and |
| 1292 |
* Phar::BZ2 for bzip-based compression. |
| 1293 |
* </p> |
| 1294 |
* @param extension string[optional] <p> |
| 1295 |
* This parameter is used to override the default file extension for a |
| 1296 |
* converted archive. Note that .phar cannot be used |
| 1297 |
* anywhere in the filename for a non-executable tar or zip archive. |
| 1298 |
* </p> |
| 1299 |
* <p> |
| 1300 |
* If converting to a tar-based phar archive, the |
| 1301 |
* default extensions are .tar, .tar.gz, |
| 1302 |
* and .tar.bz2 depending on specified compression. |
| 1303 |
* For zip-based archives, the |
| 1304 |
* default extension is .zip. |
| 1305 |
* </p> |
| 1306 |
* @return PharData The method returns a PharData object on success and throws an |
| 1307 |
* exception on failure. |
| 1308 |
*/ |
| 1309 |
public function convertToData ($format = null, $compression = null, $extension = null) {} |
| 1310 |
|
| 1311 |
/** |
| 1312 |
* Copy a file internal to the phar archive to another new file within the phar |
| 1313 |
* @link http://www.php.net/manual/en/phardata.copy.php |
| 1314 |
* @param oldfile string <p> |
| 1315 |
* </p> |
| 1316 |
* @param newfile string <p> |
| 1317 |
* </p> |
| 1318 |
* @return bool returns true on success, but it is safer to encase method call in a |
| 1319 |
* try/catch block and assume success if no exception is thrown. |
| 1320 |
*/ |
| 1321 |
public function copy ($oldfile, $newfile) {} |
| 1322 |
|
| 1323 |
public function count () {} |
| 1324 |
|
| 1325 |
/** |
| 1326 |
* Delete a file within a tar/zip archive |
| 1327 |
* @link http://www.php.net/manual/en/phardata.delete.php |
| 1328 |
* @param entry string <p> |
| 1329 |
* Path within an archive to the file to delete. |
| 1330 |
* </p> |
| 1331 |
* @return bool returns true on success, but it is better to check for thrown exception, |
| 1332 |
* and assume success if none is thrown. |
| 1333 |
*/ |
| 1334 |
public function delete ($entry) {} |
| 1335 |
|
| 1336 |
/** |
| 1337 |
* Deletes the global metadata of a zip archive |
| 1338 |
* @link http://www.php.net/manual/en/phardata.delmetadata.php |
| 1339 |
* @return bool returns true on success, but it is better to check for thrown exception, |
| 1340 |
* and assume success if none is thrown. |
| 1341 |
*/ |
| 1342 |
public function delMetadata () {} |
| 1343 |
|
| 1344 |
/** |
| 1345 |
* Extract the contents of a tar/zip archive to a directory |
| 1346 |
* @link http://www.php.net/manual/en/phardata.extractto.php |
| 1347 |
* @param pathto string <p> |
| 1348 |
* Path to extract the given files to |
| 1349 |
* </p> |
| 1350 |
* @param files string|array[optional] <p> |
| 1351 |
* The name of a file or directory to extract, or an array of files/directories to extract |
| 1352 |
* </p> |
| 1353 |
* @param overwrite bool[optional] <p> |
| 1354 |
* Set to true to enable overwriting existing files |
| 1355 |
* </p> |
| 1356 |
* @return bool returns true on success, but it is better to check for thrown exception, |
| 1357 |
* and assume success if none is thrown. |
| 1358 |
*/ |
| 1359 |
public function extractTo ($pathto, $files = null, $overwrite = null) {} |
| 1360 |
|
| 1361 |
public function getAlias () {} |
| 1362 |
|
| 1363 |
public function getPath () {} |
| 1364 |
|
| 1365 |
public function getMetadata () {} |
| 1366 |
|
| 1367 |
public function getModified () {} |
| 1368 |
|
| 1369 |
public function getSignature () {} |
| 1370 |
|
| 1371 |
public function getStub () {} |
| 1372 |
|
| 1373 |
public function getVersion () {} |
| 1374 |
|
| 1375 |
public function hasMetadata () {} |
| 1376 |
|
| 1377 |
public function isBuffering () {} |
| 1378 |
|
| 1379 |
public function isCompressed () {} |
| 1380 |
|
| 1381 |
/** |
| 1382 |
* @param fileformat |
| 1383 |
*/ |
| 1384 |
public function isFileFormat ($fileformat) {} |
| 1385 |
|
| 1386 |
/** |
| 1387 |
* Returns true if the tar/zip archive can be modified |
| 1388 |
* @link http://www.php.net/manual/en/phardata.iswritable.php |
| 1389 |
* @return bool true if the tar/zip archive can be modified |
| 1390 |
*/ |
| 1391 |
public function isWritable () {} |
| 1392 |
|
| 1393 |
/** |
| 1394 |
* @param entry |
| 1395 |
*/ |
| 1396 |
public function offsetExists ($entry) {} |
| 1397 |
|
| 1398 |
/** |
| 1399 |
* @param entry |
| 1400 |
*/ |
| 1401 |
public function offsetGet ($entry) {} |
| 1402 |
|
| 1403 |
/** |
| 1404 |
* set the contents of a file within the tar/zip to those of an external file or string |
| 1405 |
* @link http://www.php.net/manual/en/phardata.offsetset.php |
| 1406 |
* @param offset string <p> |
| 1407 |
* The filename (relative path) to modify in a tar or zip archive. |
| 1408 |
* </p> |
| 1409 |
* @param value string <p> |
| 1410 |
* Content of the file. |
| 1411 |
* </p> |
| 1412 |
* @return void No return values. |
| 1413 |
*/ |
| 1414 |
public function offsetSet ($offset, $value) {} |
| 1415 |
|
| 1416 |
/** |
| 1417 |
* remove a file from a tar/zip archive |
| 1418 |
* @link http://www.php.net/manual/en/phardata.offsetunset.php |
| 1419 |
* @param offset string <p> |
| 1420 |
* The filename (relative path) to modify in the tar/zip archive. |
| 1421 |
* </p> |
| 1422 |
* @return bool Returns true on success, false on failure. |
| 1423 |
*/ |
| 1424 |
public function offsetUnset ($offset) {} |
| 1425 |
|
| 1426 |
/** |
| 1427 |
* dummy function (Phar::setAlias is not valid for PharData) |
| 1428 |
* @link http://www.php.net/manual/en/phardata.setalias.php |
| 1429 |
* @param alias string <p> |
| 1430 |
* A shorthand string that this archive can be referred to in phar |
| 1431 |
* stream wrapper access. This parameter is ignored. |
| 1432 |
* </p> |
| 1433 |
* @return bool |
| 1434 |
*/ |
| 1435 |
public function setAlias ($alias) {} |
| 1436 |
|
| 1437 |
/** |
| 1438 |
* dummy function (Phar::setDefaultStub is not valid for PharData) |
| 1439 |
* @link http://www.php.net/manual/en/phardata.setdefaultstub.php |
| 1440 |
* @param index string[optional] <p> |
| 1441 |
* Relative path within the phar archive to run if accessed on the command-line |
| 1442 |
* </p> |
| 1443 |
* @param webindex string[optional] <p> |
| 1444 |
* Relative path within the phar archive to run if accessed through a web browser |
| 1445 |
* </p> |
| 1446 |
* @return bool Returns true on success, false on failure. |
| 1447 |
*/ |
| 1448 |
public function setDefaultStub ($index = null, $webindex = null) {} |
| 1449 |
|
| 1450 |
/** |
| 1451 |
* @param metadata |
| 1452 |
*/ |
| 1453 |
public function setMetadata ($metadata) {} |
| 1454 |
|
| 1455 |
/** |
| 1456 |
* @param algorithm |
| 1457 |
* @param privatekey[optional] |
| 1458 |
*/ |
| 1459 |
public function setSignatureAlgorithm ($algorithm, $privatekey) {} |
| 1460 |
|
| 1461 |
/** |
| 1462 |
* dummy function (Phar::setStub is not valid for PharData) |
| 1463 |
* @link http://www.php.net/manual/en/phardata.setstub.php |
| 1464 |
* @param stub string <p> |
| 1465 |
* A string or an open stream handle to use as the executable stub for this |
| 1466 |
* phar archive. This parameter is ignored. |
| 1467 |
* </p> |
| 1468 |
* @param len int[optional] <p> |
| 1469 |
* |
| 1470 |
* </p> |
| 1471 |
* @return bool Returns true on success, false on failure. |
| 1472 |
*/ |
| 1473 |
public function setStub ($stub, $len = null) {} |
| 1474 |
|
| 1475 |
public function startBuffering () {} |
| 1476 |
|
| 1477 |
public function stopBuffering () {} |
| 1478 |
|
| 1479 |
final public static function apiVersion () {} |
| 1480 |
|
| 1481 |
/** |
| 1482 |
* @param method[optional] |
| 1483 |
*/ |
| 1484 |
final public static function canCompress ($method) {} |
| 1485 |
|
| 1486 |
final public static function canWrite () {} |
| 1487 |
|
| 1488 |
/** |
| 1489 |
* @param index[optional] |
| 1490 |
* @param webindex[optional] |
| 1491 |
*/ |
| 1492 |
final public static function createDefaultStub ($index, $webindex) {} |
| 1493 |
|
| 1494 |
final public static function getSupportedCompression () {} |
| 1495 |
|
| 1496 |
final public static function getSupportedSignatures () {} |
| 1497 |
|
| 1498 |
final public static function interceptFileFuncs () {} |
| 1499 |
|
| 1500 |
/** |
| 1501 |
* @param filename |
| 1502 |
* @param executable[optional] |
| 1503 |
*/ |
| 1504 |
final public static function isValidPharFilename ($filename, $executable) {} |
| 1505 |
|
| 1506 |
/** |
| 1507 |
* @param filename |
| 1508 |
* @param alias[optional] |
| 1509 |
*/ |
| 1510 |
final public static function loadPhar ($filename, $alias) {} |
| 1511 |
|
| 1512 |
/** |
| 1513 |
* @param alias[optional] |
| 1514 |
* @param offset[optional] |
| 1515 |
*/ |
| 1516 |
final public static function mapPhar ($alias, $offset) {} |
| 1517 |
|
| 1518 |
/** |
| 1519 |
* @param retphar |
| 1520 |
*/ |
| 1521 |
final public static function running ($retphar) {} |
| 1522 |
|
| 1523 |
/** |
| 1524 |
* @param inphar |
| 1525 |
* @param externalfile |
| 1526 |
*/ |
| 1527 |
final public static function mount ($inphar, $externalfile) {} |
| 1528 |
|
| 1529 |
/** |
| 1530 |
* @param munglist |
| 1531 |
*/ |
| 1532 |
final public static function mungServer ($munglist) {} |
| 1533 |
|
| 1534 |
/** |
| 1535 |
* @param archive |
| 1536 |
*/ |
| 1537 |
final public static function unlinkArchive ($archive) {} |
| 1538 |
|
| 1539 |
/** |
| 1540 |
* @param alias[optional] |
| 1541 |
* @param index[optional] |
| 1542 |
* @param f404[optional] |
| 1543 |
* @param mimetypes[optional] |
| 1544 |
* @param rewrites[optional] |
| 1545 |
*/ |
| 1546 |
final public static function webPhar ($alias, $index, $f404, $mimetypes, $rewrites) {} |
| 1547 |
|
| 1548 |
/** |
| 1549 |
* Returns whether current entry is a directory and not '.' or '..' |
| 1550 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.haschildren.php |
| 1551 |
* @param allow_links bool[optional] <p> |
| 1552 |
* |
| 1553 |
* </p> |
| 1554 |
* @return bool whether the current entry is a directory, but not '.' or '..' |
| 1555 |
*/ |
| 1556 |
public function hasChildren ($allow_links = null) {} |
| 1557 |
|
| 1558 |
/** |
| 1559 |
* Returns an iterator for the current entry if it is a directory |
| 1560 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.getchildren.php |
| 1561 |
* @return mixed The filename, file information, or $this depending on the set flags. |
| 1562 |
* See the FilesystemIterator |
| 1563 |
* constants. |
| 1564 |
*/ |
| 1565 |
public function getChildren () {} |
| 1566 |
|
| 1567 |
/** |
| 1568 |
* Get sub path |
| 1569 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.getsubpath.php |
| 1570 |
* @return string The sub path (sub directory). |
| 1571 |
*/ |
| 1572 |
public function getSubPath () {} |
| 1573 |
|
| 1574 |
/** |
| 1575 |
* Get sub path and name |
| 1576 |
* @link http://www.php.net/manual/en/recursivedirectoryiterator.getsubpathname.php |
| 1577 |
* @return string The sub path (sub directory) and filename. |
| 1578 |
*/ |
| 1579 |
public function getSubPathname () {} |
| 1580 |
|
| 1581 |
/** |
| 1582 |
* Rewinds back to the beginning |
| 1583 |
* @link http://www.php.net/manual/en/filesystemiterator.rewind.php |
| 1584 |
* @return void |
| 1585 |
*/ |
| 1586 |
public function rewind () {} |
| 1587 |
|
| 1588 |
/** |
| 1589 |
* Move to the next file |
| 1590 |
* @link http://www.php.net/manual/en/filesystemiterator.next.php |
| 1591 |
* @return void |
| 1592 |
*/ |
| 1593 |
public function next () {} |
| 1594 |
|
| 1595 |
/** |
| 1596 |
* Retrieve the key for the current file |
| 1597 |
* @link http://www.php.net/manual/en/filesystemiterator.key.php |
| 1598 |
* @return string the pathname or filename depending on the set flags. |
| 1599 |
* See the FilesystemIterator constants. |
| 1600 |
*/ |
| 1601 |
public function key () {} |
| 1602 |
|
| 1603 |
/** |
| 1604 |
* The current file |
| 1605 |
* @link http://www.php.net/manual/en/filesystemiterator.current.php |
| 1606 |
* @return mixed The filename, file information, or $this depending on the set flags. |
| 1607 |
* See the FilesystemIterator constants. |
| 1608 |
*/ |
| 1609 |
public function current () {} |
| 1610 |
|
| 1611 |
/** |
| 1612 |
* Get the handling flags |
| 1613 |
* @link http://www.php.net/manual/en/filesystemiterator.getflags.php |
| 1614 |
* @return int The integer value of the set flags. |
| 1615 |
*/ |
| 1616 |
public function getFlags () {} |
| 1617 |
|
| 1618 |
/** |
| 1619 |
* Sets handling flags |
| 1620 |
* @link http://www.php.net/manual/en/filesystemiterator.setflags.php |
| 1621 |
* @param flags int[optional] <p> |
| 1622 |
* The handling flags to set. |
| 1623 |
* See the FilesystemIterator constants. |
| 1624 |
* </p> |
| 1625 |
* @return void |
| 1626 |
*/ |
| 1627 |
public function setFlags ($flags = null) {} |
| 1628 |
|
| 1629 |
/** |
| 1630 |
* Return file name of current DirectoryIterator item. |
| 1631 |
* @link http://www.php.net/manual/en/directoryiterator.getfilename.php |
| 1632 |
* @return string the file name of the current DirectoryIterator item. |
| 1633 |
*/ |
| 1634 |
public function getFilename () {} |
| 1635 |
|
| 1636 |
/** |
| 1637 |
* Gets the file extension |
| 1638 |
* @link http://www.php.net/manual/en/directoryiterator.getextension.php |
| 1639 |
* @return string a string containing the file extension, or an |
| 1640 |
* empty string if the file has no extension. |
| 1641 |
*/ |
| 1642 |
public function getExtension () {} |
| 1643 |
|
| 1644 |
/** |
| 1645 |
* Get base name of current DirectoryIterator item. |
| 1646 |
* @link http://www.php.net/manual/en/directoryiterator.getbasename.php |
| 1647 |
* @param suffix string[optional] <p> |
| 1648 |
* If the base name ends in suffix, |
| 1649 |
* this will be cut. |
| 1650 |
* </p> |
| 1651 |
* @return string The base name of the current DirectoryIterator item. |
| 1652 |
*/ |
| 1653 |
public function getBasename ($suffix = null) {} |
| 1654 |
|
| 1655 |
/** |
| 1656 |
* Determine if current DirectoryIterator item is '.' or '..' |
| 1657 |
* @link http://www.php.net/manual/en/directoryiterator.isdot.php |
| 1658 |
* @return bool true if the entry is . or .., |
| 1659 |
* otherwise false |
| 1660 |
*/ |
| 1661 |
public function isDot () {} |
| 1662 |
|
| 1663 |
/** |
| 1664 |
* Check whether current DirectoryIterator position is a valid file |
| 1665 |
* @link http://www.php.net/manual/en/directoryiterator.valid.php |
| 1666 |
* @return bool true if the position is valid, otherwise false |
| 1667 |
*/ |
| 1668 |
public function valid () {} |
| 1669 |
|
| 1670 |
/** |
| 1671 |
* Seek to a DirectoryIterator item |
| 1672 |
* @link http://www.php.net/manual/en/directoryiterator.seek.php |
| 1673 |
* @param position int <p> |
| 1674 |
* The zero-based numeric position to seek to. |
| 1675 |
* </p> |
| 1676 |
* @return void |
| 1677 |
*/ |
| 1678 |
public function seek ($position) {} |
| 1679 |
|
| 1680 |
/** |
| 1681 |
* Get file name as a string |
| 1682 |
* @link http://www.php.net/manual/en/directoryiterator.tostring.php |
| 1683 |
* @return string the file name of the current DirectoryIterator item. |
| 1684 |
*/ |
| 1685 |
public function __toString () {} |
| 1686 |
|
| 1687 |
/** |
| 1688 |
* Gets the path to the file |
| 1689 |
* @link http://www.php.net/manual/en/splfileinfo.getpathname.php |
| 1690 |
* @return string The path to the file. |
| 1691 |
*/ |
| 1692 |
public function getPathname () {} |
| 1693 |
|
| 1694 |
/** |
| 1695 |
* Gets file permissions |
| 1696 |
* @link http://www.php.net/manual/en/splfileinfo.getperms.php |
| 1697 |
* @return int the file permissions. |
| 1698 |
*/ |
| 1699 |
public function getPerms () {} |
| 1700 |
|
| 1701 |
/** |
| 1702 |
* Gets the inode for the file |
| 1703 |
* @link http://www.php.net/manual/en/splfileinfo.getinode.php |
| 1704 |
* @return int the inode number for the filesystem object. |
| 1705 |
*/ |
| 1706 |
public function getInode () {} |
| 1707 |
|
| 1708 |
/** |
| 1709 |
* Gets file size |
| 1710 |
* @link http://www.php.net/manual/en/splfileinfo.getsize.php |
| 1711 |
* @return int The filesize in bytes. |
| 1712 |
*/ |
| 1713 |
public function getSize () {} |
| 1714 |
|
| 1715 |
/** |
| 1716 |
* Gets the owner of the file |
| 1717 |
* @link http://www.php.net/manual/en/splfileinfo.getowner.php |
| 1718 |
* @return int The owner id in numerical format. |
| 1719 |
*/ |
| 1720 |
public function getOwner () {} |
| 1721 |
|
| 1722 |
/** |
| 1723 |
* Gets the file group |
| 1724 |
* @link http://www.php.net/manual/en/splfileinfo.getgroup.php |
| 1725 |
* @return int The group id in numerical format. |
| 1726 |
*/ |
| 1727 |
public function getGroup () {} |
| 1728 |
|
| 1729 |
/** |
| 1730 |
* Gets last access time of the file |
| 1731 |
* @link http://www.php.net/manual/en/splfileinfo.getatime.php |
| 1732 |
* @return int the time the file was last accessed. |
| 1733 |
*/ |
| 1734 |
public function getATime () {} |
| 1735 |
|
| 1736 |
/** |
| 1737 |
* Gets the last modified time |
| 1738 |
* @link http://www.php.net/manual/en/splfileinfo.getmtime.php |
| 1739 |
* @return int the last modified time for the file, in a Unix timestamp. |
| 1740 |
*/ |
| 1741 |
public function getMTime () {} |
| 1742 |
|
| 1743 |
/** |
| 1744 |
* Gets the inode change time |
| 1745 |
* @link http://www.php.net/manual/en/splfileinfo.getctime.php |
| 1746 |
* @return int The last change time, in a Unix timestamp. |
| 1747 |
*/ |
| 1748 |
public function getCTime () {} |
| 1749 |
|
| 1750 |
/** |
| 1751 |
* Gets file type |
| 1752 |
* @link http://www.php.net/manual/en/splfileinfo.gettype.php |
| 1753 |
* @return string A string representing the type of the entry. |
| 1754 |
* May be one of file, link, |
| 1755 |
* or dir |
| 1756 |
*/ |
| 1757 |
public function getType () {} |
| 1758 |
|
| 1759 |
/** |
| 1760 |
* Tells if file is readable |
| 1761 |
* @link http://www.php.net/manual/en/splfileinfo.isreadable.php |
| 1762 |
* @return bool true if readable, false otherwise. |
| 1763 |
*/ |
| 1764 |
public function isReadable () {} |
| 1765 |
|
| 1766 |
/** |
| 1767 |
* Tells if the file is executable |
| 1768 |
* @link http://www.php.net/manual/en/splfileinfo.isexecutable.php |
| 1769 |
* @return bool true if executable, false otherwise. |
| 1770 |
*/ |
| 1771 |
public function isExecutable () {} |
| 1772 |
|
| 1773 |
/** |
| 1774 |
* Tells if the object references a regular file |
| 1775 |
* @link http://www.php.net/manual/en/splfileinfo.isfile.php |
| 1776 |
* @return bool true if the file exists and is a regular file (not a link), false otherwise. |
| 1777 |
*/ |
| 1778 |
public function isFile () {} |
| 1779 |
|
| 1780 |
/** |
| 1781 |
* Tells if the file is a directory |
| 1782 |
* @link http://www.php.net/manual/en/splfileinfo.isdir.php |
| 1783 |
* @return bool true if a directory, false otherwise. |
| 1784 |
*/ |
| 1785 |
public function isDir () {} |
| 1786 |
|
| 1787 |
/** |
| 1788 |
* Tells if the file is a link |
| 1789 |
* @link http://www.php.net/manual/en/splfileinfo.islink.php |
| 1790 |
* @return bool true if the file is a link, false otherwise. |
| 1791 |
*/ |
| 1792 |
public function isLink () {} |
| 1793 |
|
| 1794 |
/** |
| 1795 |
* Gets the target of a link |
| 1796 |
* @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php |
| 1797 |
* @return string the target of the filesystem link. |
| 1798 |
*/ |
| 1799 |
public function getLinkTarget () {} |
| 1800 |
|
| 1801 |
/** |
| 1802 |
* Gets absolute path to file |
| 1803 |
* @link http://www.php.net/manual/en/splfileinfo.getrealpath.php |
| 1804 |
* @return string the path to the file. |
| 1805 |
*/ |
| 1806 |
public function getRealPath () {} |
| 1807 |
|
| 1808 |
/** |
| 1809 |
* Gets an SplFileInfo object for the file |
| 1810 |
* @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php |
| 1811 |
* @param class_name string[optional] <p> |
| 1812 |
* Name of an SplFileInfo derived class to use. |
| 1813 |
* </p> |
| 1814 |
* @return SplFileInfo An SplFileInfo object created for the file. |
| 1815 |
*/ |
| 1816 |
public function getFileInfo ($class_name = null) {} |
| 1817 |
|
| 1818 |
/** |
| 1819 |
* Gets an SplFileInfo object for the path |
| 1820 |
* @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php |
| 1821 |
* @param class_name string[optional] <p> |
| 1822 |
* Name of an SplFileInfo derived class to use. |
| 1823 |
* </p> |
| 1824 |
* @return SplFileInfo an SplFileInfo object for the parent path of the file. |
| 1825 |
*/ |
| 1826 |
public function getPathInfo ($class_name = null) {} |
| 1827 |
|
| 1828 |
/** |
| 1829 |
* Gets an SplFileObject object for the file |
| 1830 |
* @link http://www.php.net/manual/en/splfileinfo.openfile.php |
| 1831 |
* @param open_mode string[optional] <p> |
| 1832 |
* The mode for opening the file. See the fopen |
| 1833 |
* documentation for descriptions of possible modes. The default |
| 1834 |
* is read only. |
| 1835 |
* </p> |
| 1836 |
* @param use_include_path bool[optional] <p> |
| 1837 |
* ¶meter.use_include_path; |
| 1838 |
* </p> |
| 1839 |
* @param context resource[optional] <p> |
| 1840 |
* ¶meter.context; |
| 1841 |
* </p> |
| 1842 |
* @return SplFileObject The opened file as an SplFileObject object. |
| 1843 |
*/ |
| 1844 |
public function openFile ($open_mode = null, $use_include_path = null, $context = null) {} |
| 1845 |
|
| 1846 |
/** |
| 1847 |
* Sets the class name used with <methodname>SplFileInfo::openFile</methodname> |
| 1848 |
* @link http://www.php.net/manual/en/splfileinfo.setfileclass.php |
| 1849 |
* @param class_name string[optional] <p> |
| 1850 |
* The class name to use when openFile() is called. |
| 1851 |
* </p> |
| 1852 |
* @return void |
| 1853 |
*/ |
| 1854 |
public function setFileClass ($class_name = null) {} |
| 1855 |
|
| 1856 |
/** |
| 1857 |
* Sets the class used with getFileInfo and getPathInfo |
| 1858 |
* @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php |
| 1859 |
* @param class_name string[optional] <p> |
| 1860 |
* The class name to use. |
| 1861 |
* </p> |
| 1862 |
* @return void |
| 1863 |
*/ |
| 1864 |
public function setInfoClass ($class_name = null) {} |
| 1865 |
|
| 1866 |
final public function _bad_state_ex () {} |
| 1867 |
|
| 1868 |
} |
| 1869 |
|
| 1870 |
class PharFileInfo extends SplFileInfo { |
| 1871 |
|
| 1872 |
/** |
| 1873 |
* Construct a Phar entry object |
| 1874 |
* @link http://www.php.net/manual/en/pharfileinfo.construct.php |
| 1875 |
* @param filename |
| 1876 |
*/ |
| 1877 |
public function __construct ($filename) {} |
| 1878 |
|
| 1879 |
public function __destruct () {} |
| 1880 |
|
| 1881 |
/** |
| 1882 |
* Sets file-specific permission bits |
| 1883 |
* @link http://www.php.net/manual/en/pharfileinfo.chmod.php |
| 1884 |
* @param permissions int <p> |
| 1885 |
* permissions (see chmod) |
| 1886 |
* </p> |
| 1887 |
* @return void |
| 1888 |
*/ |
| 1889 |
public function chmod ($permissions) {} |
| 1890 |
|
| 1891 |
/** |
| 1892 |
* Compresses the current Phar entry with either zlib or bzip2 compression |
| 1893 |
* @link http://www.php.net/manual/en/pharfileinfo.compress.php |
| 1894 |
* @param compression int |
| 1895 |
* @return bool Returns true on success, false on failure. |
| 1896 |
*/ |
| 1897 |
public function compress ($compression) {} |
| 1898 |
|
| 1899 |
/** |
| 1900 |
* Decompresses the current Phar entry within the phar |
| 1901 |
* @link http://www.php.net/manual/en/pharfileinfo.decompress.php |
| 1902 |
* @return bool Returns true on success, false on failure. |
| 1903 |
*/ |
| 1904 |
public function decompress () {} |
| 1905 |
|
| 1906 |
/** |
| 1907 |
* Deletes the metadata of the entry |
| 1908 |
* @link http://www.php.net/manual/en/pharfileinfo.delmetadata.php |
| 1909 |
* @return bool true if successful, false if the entry had no metadata. |
| 1910 |
* As with all functionality that modifies the contents of |
| 1911 |
* a phar, the phar.readonly INI variable |
| 1912 |
* must be off in order to succeed if the file is within a Phar |
| 1913 |
* archive. Files within PharData archives do not have |
| 1914 |
* this restriction. |
| 1915 |
*/ |
| 1916 |
public function delMetadata () {} |
| 1917 |
|
| 1918 |
/** |
| 1919 |
* Returns the actual size of the file (with compression) inside the Phar archive |
| 1920 |
* @link http://www.php.net/manual/en/pharfileinfo.getcompressedsize.php |
| 1921 |
* @return int The size in bytes of the file within the Phar archive on disk. |
| 1922 |
*/ |
| 1923 |
public function getCompressedSize () {} |
| 1924 |
|
| 1925 |
/** |
| 1926 |
* Returns CRC32 code or throws an exception if CRC has not been verified |
| 1927 |
* @link http://www.php.net/manual/en/pharfileinfo.getcrc32.php |
| 1928 |
* @return int The crc32 checksum of the file within the Phar archive. |
| 1929 |
*/ |
| 1930 |
public function getCRC32 () {} |
| 1931 |
|
| 1932 |
public function getContent () {} |
| 1933 |
|
| 1934 |
/** |
| 1935 |
* Returns file-specific meta-data saved with a file |
| 1936 |
* @link http://www.php.net/manual/en/pharfileinfo.getmetadata.php |
| 1937 |
* @return mixed any PHP variable that can be serialized and is stored as meta-data for the file, |
| 1938 |
* or &null; if no meta-data is stored. |
| 1939 |
*/ |
| 1940 |
public function getMetadata () {} |
| 1941 |
|
| 1942 |
/** |
| 1943 |
* Returns the Phar file entry flags |
| 1944 |
* @link http://www.php.net/manual/en/pharfileinfo.getpharflags.php |
| 1945 |
* @return int The Phar flags (always 0 in the current implementation) |
| 1946 |
*/ |
| 1947 |
public function getPharFlags () {} |
| 1948 |
|
| 1949 |
/** |
| 1950 |
* Returns the metadata of the entry |
| 1951 |
* @link http://www.php.net/manual/en/pharfileinfo.hasmetadata.php |
| 1952 |
* @return bool false if no metadata is set or is &null;, true if metadata is not &null; |
| 1953 |
*/ |
| 1954 |
public function hasMetadata () {} |
| 1955 |
|
| 1956 |
/** |
| 1957 |
* Returns whether the entry is compressed |
| 1958 |
* @link http://www.php.net/manual/en/pharfileinfo.iscompressed.php |
| 1959 |
* @param compression_type int[optional] <p> |
| 1960 |
* One of Phar::GZ or Phar::BZ2, |
| 1961 |
* defaults to any compression. |
| 1962 |
* </p> |
| 1963 |
* @return bool true if the file is compressed within the Phar archive, false if not. |
| 1964 |
*/ |
| 1965 |
public function isCompressed ($compression_type = null) {} |
| 1966 |
|
| 1967 |
/** |
| 1968 |
* Returns whether file entry has had its CRC verified |
| 1969 |
* @link http://www.php.net/manual/en/pharfileinfo.iscrcchecked.php |
| 1970 |
* @return bool true if the file has had its CRC verified, false if not. |
| 1971 |
*/ |
| 1972 |
public function isCRCChecked () {} |
| 1973 |
|
| 1974 |
/** |
| 1975 |
* Sets file-specific meta-data saved with a file |
| 1976 |
* @link http://www.php.net/manual/en/pharfileinfo.setmetadata.php |
| 1977 |
* @param metadata mixed <p> |
| 1978 |
* Any PHP variable containing information to store alongside a file |
| 1979 |
* </p> |
| 1980 |
* @return void |
| 1981 |
*/ |
| 1982 |
public function setMetadata ($metadata) {} |
| 1983 |
|
| 1984 |
/** |
| 1985 |
* Gets the path without filename |
| 1986 |
* @link http://www.php.net/manual/en/splfileinfo.getpath.php |
| 1987 |
* @return string the path to the file. |
| 1988 |
*/ |
| 1989 |
public function getPath () {} |
| 1990 |
|
| 1991 |
/** |
| 1992 |
* Gets the filename |
| 1993 |
* @link http://www.php.net/manual/en/splfileinfo.getfilename.php |
| 1994 |
* @return string The filename. |
| 1995 |
*/ |
| 1996 |
public function getFilename () {} |
| 1997 |
|
| 1998 |
/** |
| 1999 |
* Gets the file extension |
| 2000 |
* @link http://www.php.net/manual/en/splfileinfo.getextension.php |
| 2001 |
* @return string a string containing the file extension, or an |
| 2002 |
* empty string if the file has no extension. |
| 2003 |
*/ |
| 2004 |
public function getExtension () {} |
| 2005 |
|
| 2006 |
/** |
| 2007 |
* Gets the base name of the file |
| 2008 |
* @link http://www.php.net/manual/en/splfileinfo.getbasename.php |
| 2009 |
* @param suffix string[optional] <p> |
| 2010 |
* Optional suffix to omit from the base name returned. |
| 2011 |
* </p> |
| 2012 |
* @return string the base name without path information. |
| 2013 |
*/ |
| 2014 |
public function getBasename ($suffix = null) {} |
| 2015 |
|
| 2016 |
/** |
| 2017 |
* Gets the path to the file |
| 2018 |
* @link http://www.php.net/manual/en/splfileinfo.getpathname.php |
| 2019 |
* @return string The path to the file. |
| 2020 |
*/ |
| 2021 |
public function getPathname () {} |
| 2022 |
|
| 2023 |
/** |
| 2024 |
* Gets file permissions |
| 2025 |
* @link http://www.php.net/manual/en/splfileinfo.getperms.php |
| 2026 |
* @return int the file permissions. |
| 2027 |
*/ |
| 2028 |
public function getPerms () {} |
| 2029 |
|
| 2030 |
/** |
| 2031 |
* Gets the inode for the file |
| 2032 |
* @link http://www.php.net/manual/en/splfileinfo.getinode.php |
| 2033 |
* @return int the inode number for the filesystem object. |
| 2034 |
*/ |
| 2035 |
public function getInode () {} |
| 2036 |
|
| 2037 |
/** |
| 2038 |
* Gets file size |
| 2039 |
* @link http://www.php.net/manual/en/splfileinfo.getsize.php |
| 2040 |
* @return int The filesize in bytes. |
| 2041 |
*/ |
| 2042 |
public function getSize () {} |
| 2043 |
|
| 2044 |
/** |
| 2045 |
* Gets the owner of the file |
| 2046 |
* @link http://www.php.net/manual/en/splfileinfo.getowner.php |
| 2047 |
* @return int The owner id in numerical format. |
| 2048 |
*/ |
| 2049 |
public function getOwner () {} |
| 2050 |
|
| 2051 |
/** |
| 2052 |
* Gets the file group |
| 2053 |
* @link http://www.php.net/manual/en/splfileinfo.getgroup.php |
| 2054 |
* @return int The group id in numerical format. |
| 2055 |
*/ |
| 2056 |
public function getGroup () {} |
| 2057 |
|
| 2058 |
/** |
| 2059 |
* Gets last access time of the file |
| 2060 |
* @link http://www.php.net/manual/en/splfileinfo.getatime.php |
| 2061 |
* @return int the time the file was last accessed. |
| 2062 |
*/ |
| 2063 |
public function getATime () {} |
| 2064 |
|
| 2065 |
/** |
| 2066 |
* Gets the last modified time |
| 2067 |
* @link http://www.php.net/manual/en/splfileinfo.getmtime.php |
| 2068 |
* @return int the last modified time for the file, in a Unix timestamp. |
| 2069 |
*/ |
| 2070 |
public function getMTime () {} |
| 2071 |
|
| 2072 |
/** |
| 2073 |
* Gets the inode change time |
| 2074 |
* @link http://www.php.net/manual/en/splfileinfo.getctime.php |
| 2075 |
* @return int The last change time, in a Unix timestamp. |
| 2076 |
*/ |
| 2077 |
public function getCTime () {} |
| 2078 |
|
| 2079 |
/** |
| 2080 |
* Gets file type |
| 2081 |
* @link http://www.php.net/manual/en/splfileinfo.gettype.php |
| 2082 |
* @return string A string representing the type of the entry. |
| 2083 |
* May be one of file, link, |
| 2084 |
* or dir |
| 2085 |
*/ |
| 2086 |
public function getType () {} |
| 2087 |
|
| 2088 |
/** |
| 2089 |
* Tells if the entry is writable |
| 2090 |
* @link http://www.php.net/manual/en/splfileinfo.iswritable.php |
| 2091 |
* @return bool true if writable, false otherwise; |
| 2092 |
*/ |
| 2093 |
public function isWritable () {} |
| 2094 |
|
| 2095 |
/** |
| 2096 |
* Tells if file is readable |
| 2097 |
* @link http://www.php.net/manual/en/splfileinfo.isreadable.php |
| 2098 |
* @return bool true if readable, false otherwise. |
| 2099 |
*/ |
| 2100 |
public function isReadable () {} |
| 2101 |
|
| 2102 |
/** |
| 2103 |
* Tells if the file is executable |
| 2104 |
* @link http://www.php.net/manual/en/splfileinfo.isexecutable.php |
| 2105 |
* @return bool true if executable, false otherwise. |
| 2106 |
*/ |
| 2107 |
public function isExecutable () {} |
| 2108 |
|
| 2109 |
/** |
| 2110 |
* Tells if the object references a regular file |
| 2111 |
* @link http://www.php.net/manual/en/splfileinfo.isfile.php |
| 2112 |
* @return bool true if the file exists and is a regular file (not a link), false otherwise. |
| 2113 |
*/ |
| 2114 |
public function isFile () {} |
| 2115 |
|
| 2116 |
/** |
| 2117 |
* Tells if the file is a directory |
| 2118 |
* @link http://www.php.net/manual/en/splfileinfo.isdir.php |
| 2119 |
* @return bool true if a directory, false otherwise. |
| 2120 |
*/ |
| 2121 |
public function isDir () {} |
| 2122 |
|
| 2123 |
/** |
| 2124 |
* Tells if the file is a link |
| 2125 |
* @link http://www.php.net/manual/en/splfileinfo.islink.php |
| 2126 |
* @return bool true if the file is a link, false otherwise. |
| 2127 |
*/ |
| 2128 |
public function isLink () {} |
| 2129 |
|
| 2130 |
/** |
| 2131 |
* Gets the target of a link |
| 2132 |
* @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php |
| 2133 |
* @return string the target of the filesystem link. |
| 2134 |
*/ |
| 2135 |
public function getLinkTarget () {} |
| 2136 |
|
| 2137 |
/** |
| 2138 |
* Gets absolute path to file |
| 2139 |
* @link http://www.php.net/manual/en/splfileinfo.getrealpath.php |
| 2140 |
* @return string the path to the file. |
| 2141 |
*/ |
| 2142 |
public function getRealPath () {} |
| 2143 |
|
| 2144 |
/** |
| 2145 |
* Gets an SplFileInfo object for the file |
| 2146 |
* @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php |
| 2147 |
* @param class_name string[optional] <p> |
| 2148 |
* Name of an SplFileInfo derived class to use. |
| 2149 |
* </p> |
| 2150 |
* @return SplFileInfo An SplFileInfo object created for the file. |
| 2151 |
*/ |
| 2152 |
public function getFileInfo ($class_name = null) {} |
| 2153 |
|
| 2154 |
/** |
| 2155 |
* Gets an SplFileInfo object for the path |
| 2156 |
* @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php |
| 2157 |
* @param class_name string[optional] <p> |
| 2158 |
* Name of an SplFileInfo derived class to use. |
| 2159 |
* </p> |
| 2160 |
* @return SplFileInfo an SplFileInfo object for the parent path of the file. |
| 2161 |
*/ |
| 2162 |
public function getPathInfo ($class_name = null) {} |
| 2163 |
|
| 2164 |
/** |
| 2165 |
* Gets an SplFileObject object for the file |
| 2166 |
* @link http://www.php.net/manual/en/splfileinfo.openfile.php |
| 2167 |
* @param open_mode string[optional] <p> |
| 2168 |
* The mode for opening the file. See the fopen |
| 2169 |
* documentation for descriptions of possible modes. The default |
| 2170 |
* is read only. |
| 2171 |
* </p> |
| 2172 |
* @param use_include_path bool[optional] <p> |
| 2173 |
* ¶meter.use_include_path; |
| 2174 |
* </p> |
| 2175 |
* @param context resource[optional] <p> |
| 2176 |
* ¶meter.context; |
| 2177 |
* </p> |
| 2178 |
* @return SplFileObject The opened file as an SplFileObject object. |
| 2179 |
*/ |
| 2180 |
public function openFile ($open_mode = null, $use_include_path = null, $context = null) {} |
| 2181 |
|
| 2182 |
/** |
| 2183 |
* Sets the class name used with <methodname>SplFileInfo::openFile</methodname> |
| 2184 |
* @link http://www.php.net/manual/en/splfileinfo.setfileclass.php |
| 2185 |
* @param class_name string[optional] <p> |
| 2186 |
* The class name to use when openFile() is called. |
| 2187 |
* </p> |
| 2188 |
* @return void |
| 2189 |
*/ |
| 2190 |
public function setFileClass ($class_name = null) {} |
| 2191 |
|
| 2192 |
/** |
| 2193 |
* Sets the class used with getFileInfo and getPathInfo |
| 2194 |
* @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php |
| 2195 |
* @param class_name string[optional] <p> |
| 2196 |
* The class name to use. |
| 2197 |
* </p> |
| 2198 |
* @return void |
| 2199 |
*/ |
| 2200 |
public function setInfoClass ($class_name = null) {} |
| 2201 |
|
| 2202 |
final public function _bad_state_ex () {} |
| 2203 |
|
| 2204 |
/** |
| 2205 |
* Returns the path to the file as a string |
| 2206 |
* @link http://www.php.net/manual/en/splfileinfo.tostring.php |
| 2207 |
* @return void the path to the file. |
| 2208 |
*/ |
| 2209 |
public function __toString () {} |
| 2210 |
|
| 2211 |
} |
| 2212 |
// End of Phar v.2.0.2 |
| 2213 |
?> |