PEAR Manual
Prev |  | Next

# Archive_Tar::addString()

Archive_Tar::addString() -- add a string in the archive

## Synopsis

    require_once 'Archive/Tar.php';

``boolean addString` (string $filename, string $content)`

## Description

This method adds the string `content` in the archive like a file with full filename `filename`.

If the archive does not exists it attempts to create it.

## Parameter

- `string $filename` - the path and filename that will be associated with the added string in the archive.

- `string $content` - the string to add in the archive as a file.

## Return value

`boolean` - Returns `TRUE` on success, `FALSE` on failure.

## Throws

Table 38-1. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`NULL` | "Unable to open in write mode `file name`" | The file permissions for an existing file do not allow writing or the file is locked. | Check permissions and possible competive programs using the file.
`NULL` | "Unable to open file `filename`in binary read mode" | The file to add to the archive could not be read. | Check for typing mistakes in the function argument and file permissions.

## Note

This function can not be called statically.

## Example

Example 38-1. Add a string in a compressed archive
    $tar_object = new Archive_Tar("tarname.tgz");
    $content = "this file was generated from a string";
    $tar_object->addString("data/readme.txt", $content);
    // A file is created in the archive with name :
    //   data/readme.txt

Prev | Home | Next
Archive_Tar::extractInString() | Up | File