phardata.extractto(3) [php man page]
PHARDATA.EXTRACTTO(3) 1 PHARDATA.EXTRACTTO(3) PharData::extractTo - Extract the contents of a tar/zip archive to a directory SYNOPSIS
bool PharData::extractTo (string $pathto, [string|array $files], [bool $overwrite = false]) DESCRIPTION
Extract all files within a tar/zip archive to disk. Extracted files and directories preserve permissions as stored in the archive. The optional parameters allow optional control over which files are extracted, and whether existing files on disk can be overwritten. The sec- ond parameter files can be either the name of a file or directory to extract, or an array of names of files and directories to extract. By default, this method will not overwrite existing files, the third parameter can be set to true to enable overwriting of files. This method is similar to ZipArchive.extractTo(3). PARAMETERS
o $pathto - Path to extract the given files to o $files - The name of a file or directory to extract, or an array of files/directories to extract o $overwrite - Set to TRUE to enable overwriting existing files RETURN VALUES
returns TRUE on success, but it is better to check for thrown exception, and assume success if none is thrown. ERRORS
/EXCEPTIONS Throws PharException if errors occur while flushing changes to disk. EXAMPLES
Example #1 A PharData.extractTo(3) example <?php try { $phar = new PharData('myphar.tar'); $phar->extractTo('/full/path'); // extract all files $phar->extractTo('/another/path', 'file.txt'); // extract only file.txt $phar->extractTo('/this/path', array('file1.txt', 'file2.txt')); // extract 2 files only $phar->extractTo('/third/path', null, true); // extract all files, and overwrite } catch (Exception $e) { // handle errors } ?> SEE ALSO
Phar.extractTo(3). PHP Documentation Group PHARDATA.EXTRACTTO(3)
Check Out this Related Man Page
PHAR.CREATEDEFAULTSTUB(3) 1 PHAR.CREATEDEFAULTSTUB(3) Phar::createDefaultStub - Create a phar-file format specific stub SYNOPSIS
finalpublicstatic string Phar::createDefaultStub ([string $indexfile], [string $webindexfile]) DESCRIPTION
This method is intended for creation of phar-file format-specific stubs, and is not intended for use with tar- or zip-based phar archives. Phar archives contain a bootstrap loader, or stub written in PHP that is executed when the archive is executed in PHP either via include: <?php include 'myphar.phar'; ?> php myphar.phar This method provides a simple and easy method to create a stub that will run a startup file from the phar archive. In addition, different files can be specified for running the phar archive from the command line versus through a web server. The loader stub also calls Phar.interceptFileFuncs(3) to allow easy bundling of a PHP application that accesses the file system. If the phar extension is not present, the loader stub will extract the phar archive to a temporary directory and then operate on the files. A shutdown function erases the tempo- rary files on exit. RETURN VALUES
Returns a string containing the contents of a customized bootstrap loader (stub) that allows the created Phar archive to work with or without the Phar extension enabled. ERRORS
/EXCEPTIONS Throws UnexpectedValueException if either parameter is longer than 400 bytes. EXAMPLES
Example #1 A Phar.createDefaultStub(3) example <?php try { $phar = new Phar('myphar.phar'); $phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php')); } catch (Exception $e) { // handle errors } ?> SEE ALSO
Phar.setStub(3), Phar.getStub(3). PHP Documentation Group PHAR.CREATEDEFAULTSTUB(3)