KnpGaufretteBundle Documentation

The stream_wrapper feature allows you to register your configured Gaufrette filesystems as PHP stream wrappers. Once registered, you can access files using a URI format like protocol://domain/path/to/file.txt. This enables you to use standard PHP filesystem functions (like file_get_contents, fopen, etc.) directly with your Gaufrette filesystems.

gaufrette://domain/file.txt

The in_memory adapter is designed for testing purposes. Instead of interacting with a real filesystem, it stores files in an internal array.

You can pre-populate the adapter with files by providing a files array in your configuration. Each file entry is a sub-array that can optionally include content, checksum, and mtime (modification time).

# app/config/config.yml
knp_gaufrette:
    adapters:
        foo:
            in_memory:
                files:
                    'file1.txt':    ~
                    'file2.txt':
                        content:    Some content
                        checksum:   abc1efg2hij3
                        mtime:      123456890123

The safe_local adapter is a variation of the standard local adapter that encodes keys to prevent issues with directory structures. It is useful when you want to store files in a local directory but want the library to handle the creation of nested subdirectories automatically based on encoded keys, avoiding direct manipulation of the filesystem hierarchy.

# app/config/config.yml
knp_gaufrette:
    adapters:
        foo:
            safe_local:
                directory:  /path/to/my/filesystem
                create:     true

The Doctrine DBAL adapter allows you to store file data directly into a database table. You must specify the Doctrine connection name and map the internal Gaufrette fields (key, content, mtime, and checksum) to your specific database column names.

# app/config/config.yml
knp_gaufrette:
    adapters:
        database:
            doctrine_dbal:
                connection_name: default
                table: data
                columns:
                    key: id
                    content: text
                    mtime: date
                    checksum: checksum

To upload a file, inject the knp_gaufrette.filesystem service (if using a single filesystem) or retrieve the specific filesystem from the knp_gaufrette.filesystem_map service.

If you need to perform operations that are not part of the generic Gaufrette API—such as setting specific metadata for an AWS S3 bucket—you can retrieve the underlying adapter using $filesystem->getAdapter() and check its type using instanceof.

/** @var AwsS3 $adapter */
$adapter = $this->filesystem->getAdapter();

// Example: Setting metadata specifically for the AwsS3 adapter
if ($adapter instanceof AwsS3) {
    $adapter->setMetadata($filename, ['contentType' => 'application/pdf']);
}

$adapter->write($myAbsolutePath, file_get_contents($tempPath));

The APC adapter is a non-persistent filesystem adapter. It is suitable for development environments or demo sites where data does not need to persist between requests.

You can configure it under the knp_gaufrette.adapters section in your Symfony configuration. It requires a prefix to act as a namespace for the APC storage.

# app/config/config.yml
knp_gaufrette:
    adapters:
        foo:
            apc:
                prefix: 'my_app_namespace.'
                ttl: 0

The Local Adapter allows you to use a local filesystem as a storage backend. You can define an adapter named foo (or any other name) under the knp_gaufrette.adapters configuration key.

Required parameters:

• directory: The absolute path to the directory of the filesystem.

Optional parameters:

• create: A boolean indicating whether the directory should be created automatically if it does not exist. Defaults to true.

# app/config/config.yml
knp_gaufrette:
    adapters:
        foo:
            local:
                directory:  /path/to/my/filesystem
                create:     true

To use the Phpseclib SFTP adapter, you must define the adapter in your Gaufrette configuration and provide a service ID that points to a configured phpseclib\Net\SFTP (or phpseclib\Net\SFTP for phpseclib 1.x) instance.

Available configuration parameters:

• phpseclib_sftp_id: The ID of the service that provides SFTP access.
• directory: The remote directory to use (defaults to null).
• create: Whether to create the directory if it does not exist (defaults to false).

# app/config/config.yml
knp_gaufrette:
    adapters:
        foo:
            phpseclib_sftp:
                phpseclib_sftp_id: acme_test.sftp
                directory: /example/sftp
                create: true