File System API

Read API

getMetadata(FileSystemQueryTransfer $fileSystemQueryTransfer)

Return FileSystemResourceMetadataTransfer, null on failure

<?php
$fileSystemQueryTransfer = new FileSystemQueryTransfer();
$fileSystemQueryTransfer->setFileSystemName('media');
$fileSystemQueryTransfer->setPath('/foo/bar.jpg');

$metadataTransfer = $fileSystemService->getMetadata($fileSystemQueryTransfer);

getMimeType(FileSystemQueryTransfer $fileSystemQueryTransfer)

Return resource mimetype, false on failure

<?php
$fileSystemQueryTransfer = new FileSystemQueryTransfer();
$fileSystemQueryTransfer->setFileSystemName('media');
$fileSystemQueryTransfer->setPath('/foo/bar.jpg');

$mimeType = $fileSystemService->getMimeType($fileSystemQueryTransfer);

getTimestamp(FileSystemQueryTransfer $fileSystemQueryTransfer)

Return resource timestamp, false on failure

<?php
$fileSystemQueryTransfer = new FileSystemQueryTransfer();
$fileSystemQueryTransfer->setFileSystemName('media');
$fileSystemQueryTransfer->setPath('/foo/bar.jpg');

$timestamp = $fileSystemService->getTimestamp($fileSystemQueryTransfer);

getSize(FileSystemQueryTransfer $fileSystemQueryTransfer)

Return resource size, false on failure

<?php
$fileSystemQueryTransfer = new FileSystemQueryTransfer();
$fileSystemQueryTransfer->setFileSystemName('media');
$fileSystemQueryTransfer->setPath('/foo/bar.jpg');

$size = $fileSystemService->getSize($fileSystemQueryTransfer);

isPrivate($filesystemName, $path)

Check if resource has private access rights.

Return true if resource has private access rights.

<?php
$fileSystemQueryTransfer = new FileSystemQueryTransfer();
$fileSystemQueryTransfer->setFileSystemName('media');
$fileSystemQueryTransfer->setPath('/foo/bar.jpg');

$isPrivate = $fileSystemService->isPrivate($fileSystemQueryTransfer);

read(FileSystemQueryTransfer $fileSystemQueryTransfer)

Read file.

Return file content, false on failure.

<?php
$fileSystemQueryTransfer = new FileSystemQueryTransfer();
$fileSystemQueryTransfer->setFileSystemName('media');
$fileSystemQueryTransfer->setPath('/foo/bar.jpg');

$content = $fileSystemService->read($fileSystemQueryTransfer);

listContents(FileSystemListTransfer $fileSystemListTransfer)

List contents under a path.

Return array of `FileSystemResourceTransfer` objects located under given path.

<?php
$fileSystemListTransfer = new FileSystemListTransfer();
$fileSystemListTransfer->setFileSystemName('media');
$fileSystemListTransfer->setPath('/');
$fileSystemListTransfer->setRecursive(true);

$resourceList = $fileSystemService->listContents($fileSystemListTransfer);

has(FileSystemQueryTransfer $fileSystemQueryTransfer)

Check if resource exists.

Return true if resource exist, false otherwise.

<?php
$fileSystemQueryTransfer = new FileSystemQueryTransfer();
$fileSystemQueryTransfer->setFileSystemName('media');
$fileSystemQueryTransfer->setPath('/foo/bar.jpg');

$has = $fileSystemService->has($fileSystemQueryTransfer);

Write API

markAsPrivate(FileSystemVisibilityTransfer $fileSystemVisibilityTransfer)

Mark resource with private access rights.

Return true on success, false on failure.

<?php
$fileSystemVisibilityTransfer = new FileSystemVisibilityTransfer();
$fileSystemVisibilityTransfer->setFileSystemName('media');
$fileSystemVisibilityTransfer->setPath('/foo/bar.jpg');

$result = $fileSystemService->markAsPrivate($fileSystemVisibilityTransfer);

markAsPublic(FileSystemVisibilityTransfer $fileSystemVisibilityTransfer)

Mark resource with public access rights.

Return true on success, false on failure.

<?php
$fileSystemVisibilityTransfer = new FileSystemVisibilityTransfer();
$fileSystemVisibilityTransfer->setFileSystemName('media');
$fileSystemVisibilityTransfer->setPath('/foo/bar.jpg');

$result = $fileSystemService->markAsPublic($fileSystemVisibilityTransfer);

createDirectory(FileSystemCreateDirectoryTransfer $fileSystemCreateDirectoryTransfer)

Create directory with its path.

Return true on success, false on failure.

<?php
$fileSystemCreateDirectoryTransfer = new FileSystemCreateDirectoryTransfer();
$fileSystemCreateDirectoryTransfer->setFileSystemName('media');
$fileSystemCreateDirectoryTransfer->setPath('/foo/bar');

$result = $fileSystemService->createDirectory($fileSystemCreateDirectoryTransfer);

deleteDirectory(FileSystemDeleteDirectoryTransfer $fileSystemDeleteDirectoryTransfer)

Delete empty directory.

Return true on success, false on failure.

<?php
$fileSystemDeleteDirectoryTransfer = new FileSystemDeleteDirectoryTransfer();
$fileSystemDeleteDirectoryTransfer->setFileSystemName('media');
$fileSystemDeleteDirectoryTransfer->setPath('foo/bar');

$result = $fileSystemService->deleteDirectory($fileSystemDeleteDirectoryTransfer);

copy(FileSystemCopyTransfer $fileSystemCopyTransfer)

Copy file, the destination must not exist.

Return true on success, false on failure.

<?php
$fileSystemCopyTransfer = new FileSystemCopyTransfer();
$fileSystemCopyTransfer->setFileSystemName('media');
$fileSystemCopyTransfer->setSourcePath('foo/bar.jpg');
$fileSystemCopyTransfer->setDestinationPath('newpath/foobar.jpg');

$result = $fileSystemService->copy($fileSystemCopyTransfer);

delete(FileSystemDeleteTransfer $fileSystemDeleteTransfer)

Delete file.

Return true on success, false on failure.

<?php
$fileSystemDeleteTransfer = new FileSystemDeleteTransfer();
$fileSystemDeleteTransfer->setFileSystemName('media');
$fileSystemDeleteTransfer->setPath('foo/bar.jpg');

$result = $fileSystemService->delete($fileSystemDeleteTransfer);

put(FileSystemContentTransfer $fileSystemContentTransfer)

Create a file or update if exists.

Return true on success, false on failure.

<?php
$fileSystemContentTransfer = new FileSystemContentTransfer();
$fileSystemContentTransfer->setFileSystemName('media');
$fileSystemContentTransfer->setPath('foo/bar.jpg');
$fileSystemContentTransfer->setContent('Lorem Ipsum');

$result = $fileSystemService->put($fileSystemContentTransfer);

rename(FileSystemRenameTransfer $fileSystemRenameTransfer)

Create a file or update if exists.

Return true on success, false on failure.

<?php
$fileSystemRenameTransfer = new FileSystemRenameTransfer();
$fileSystemRenameTransfer->setFileSystemName('media');
$fileSystemRenameTransfer->setPath('foo/bar.jpg');
$fileSystemRenameTransfer->setNewPath('foo/buzz.jpg');

$result = $fileSystemService->rename($fileSystemRenameTransfer);

update(FileSystemContentTransfer $fileSystemContentTransfer)

Update an existing file.

Return true on success, false on failure.

<?php
$fileSystemContentTransfer = new FileSystemContentTransfer();
$fileSystemContentTransfer->setFileSystemName('media');
$fileSystemContentTransfer->setPath('foo/bar.jpg');
$fileSystemContentTransfer->setContent('Lorem Ipsum');

$result = $fileSystemService->update($fileSystemContentTransfer);

write(FileSystemContentTransfer $fileSystemContentTransfer)

Write a new file.

Return true on success, false on failure.

<?php
$fileSystemContentTransfer = new FileSystemContentTransfer();
$fileSystemContentTransfer->setFileSystemName('media');
$fileSystemContentTransfer->setPath('foo/bar.jpg');
$fileSystemContentTransfer->setContent('Lorem Ipsum');

$result = $fileSystemService->write($fileSystemRenameTransfer);

Stream API

putStream(FileSystemStreamTransfer $fileSystemStreamTransfer, $stream)

Create a file or update if exists using stream.

Return true on success, false on failure.

<?php
$fileSystemStreamTransfer = new FileSystemStreamTransfer();
$fileSystemStreamTransfer->setFileSystemName('media');
$fileSystemStreamTransfer->setPath('foo/bar.jpg');

$stream = fopen('some/file.jpg', 'r+');
$result = $fileSystemService->putStream($fileSystemStreamTransfer, $stream);

if (is_resource($stream)) {
    fclose($stream);
}

readStream(FileSystemStreamTransfer $fileSystemStreamTransfer)

Retrieve stream for a file.

Return a read-stream for the path, false on failure.

<?php
$fileSystemStreamTransfer = new FileSystemStreamTransfer();
$fileSystemStreamTransfer->setFileSystemName('media');
$fileSystemStreamTransfer->setPath('foo/bar.jpg');

$stream = $fileSystemService->readStream($fileSystemStreamTransfer);

updateStream(FileSystemStreamTransfer $fileSystemStreamTransfer, $stream)

Update an existing file using a stream.

Return true on success, false on failure.

<?php
$fileSystemStreamTransfer = new FileSystemStreamTransfer();
$fileSystemStreamTransfer->setFileSystemName('media');
$fileSystemStreamTransfer->setPath('foo/bar.jpg');

$stream = fopen('some/file.jpg', 'r+');
$result = $fileSystemService->updateStream($fileSystemStreamTransfer, $stream);

if (is_resource($stream)) {
    fclose($stream);
}

writeStream(FileSystemStreamTransfer $fileSystemStreamTransfer, $stream)

Write a new file using a stream.

Return true on success, false on failure.

<?php
$fileSystemStreamTransfer = new FileSystemStreamTransfer();
$fileSystemStreamTransfer->setFileSystemName('media');
$fileSystemStreamTransfer->setPath('foo/bar.jpg');

$stream = fopen('some/file.jpg', 'r+');
$result = $fileSystemService->writeStream($fileSystemStreamTransfer, $stream);

if (is_resource($stream)) {
    fclose($stream);
}

Related Topics