Nextcloud PHP API (master)

IExportDestination

Tags
since
24.0.0

Table of Contents

Methods

addFileAsStream()  : void
Adds a file to the export as a stream
addFileContents()  : void
Adds a file to the export
close()  : void
Called after export is complete
copyFolder()  : void
Copy a folder to the export
setMigratorVersions()  : void

Methods

addFileAsStream()

Adds a file to the export as a stream

public addFileAsStream(string $path, resource $stream) : void
Parameters
$path : string

Full path to the file in the export archive. Parent directories will be created if needed.

$stream : resource

A stream resource to read from to get the file content.

Tags
throws
UserMigrationException
since
24.0.0

addFileContents()

Adds a file to the export

public addFileContents(string $path, string $content) : void
Parameters
$path : string

Full path to the file in the export archive. Parent directories will be created if needed.

$content : string

The full content of the file.

Tags
throws
UserMigrationException
since
24.0.0

copyFolder()

Copy a folder to the export

public copyFolder(Folder $folder, string $destinationPath[, callable(Node): bool|null $nodeFilter = null ]) : void
Parameters
$folder : Folder

folder to copy to the export archive.

$destinationPath : string

Full path to the folder in the export archive. Parent directories will be created if needed.

$nodeFilter : callable(Node): bool|null = null

Callback to filter nodes to copy

Tags
throws
UserMigrationException
since
24.0.0

setMigratorVersions()

public setMigratorVersions(array<string, int> $versions) : void
Parameters
$versions : array<string, int>

Migrators and their versions.

Tags
throws
UserMigrationException
since
24.0.0

        
On this page

Search results