PEAR Manual
Prev |  | Next

# Archive_Tar::extractInString()

Archive_Tar::extractInString() -- extract one file and return it as a string

## Synopsis

    require_once 'Archive/Tar.php';

``boolean extractInString` (string $path)`

## Description

This method extracts the file identified by `path` from the archive and returns it as a string. It does not use temporary files.

## Parameter

- `string $path` - the path of the file to extract

## Return value

`string` - the content of the extracted file

## Throws

Table 38-1. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`NULL` | " Unable to open in read mode `archive` " | The file is exclusive locked by another application. | Check for other applications working on the file. This can not be caused by a competive processing the archive with Archive_Tar
`NULL` | " Invalid extractinstring mode `mode` " | Implementation error | Should not occur, please set up a bug report.
`NULL` | " Error while opening `name` in write binary mode " | The file could not be created. | The file is maybe locked.
`NULL` | " Extracted file `filename` does not have the correct file size `filesize` (`size` expected). Archive may be corrupted. " | Read the message. | Read the message.

## Note

This function can not be called statically.

## Example

Example 38-1. Extract a file in a string
    // tarname.tar with files :
    //   dev/data/file.txt
    //   dev/data/log.txt
    //   dev/readme.txt

    $tar_object = new Archive_Tar("tarname.tar");
    $text = $tar_object->extractInString("dev/readme.txt");
    echo $text;

Prev | Home | Next
Archive_Tar::listContent() | Up | Archive_Tar::addString()