\
Omega
Application
Archive
Cache
Adapter
Exception
Factory
ServiceProvider
Config
ServiceProvider
Container
Exception
ServiceProvider
Database
Adapter
Command
Exception
Factory
Migration
Field
QueryBuilder
ServiceProvider
Environment
Command
Exception
Exceptions
Filesystem
Adapter
Amazon
Ftp
Local
Memory
Sftp
Contracts
Exception
Factory
ServiceProvider
Stream
Util
Http
ServiceProvider
Logging
Exception
Factory
ServiceProvider
Queue
Adapter
Command
Exception
Factory
ServiceProvider
Routing
ServiceProvider
Session
Exception
Factory
ServiceProvider
Storage
Support
Facade
Exception
Facades
Factory
Singleton
Exception
Validation
Exception
Rule
ServiceProvider
View
Engine
ServiceProvider

\Omega\Filesystem\Adapter\Sftp Sftp

Sftp Adapter.

This class provides an interface for interacting with a remote SFTP server. It implements methods for reading, writing, renaming, deleting files, and managing directories. The adapter can be initialized with a remote directory and offers options to create it if it does not exist. This class requires the "phpseclib/phpseclib" package for SFTP functionality.

Summary

Methods
Properties
Constants
__construct
read
rename
write
exists
isDirectory
keys
listKeys
mtime
delete
createFile
No public properties found
No public constants found
initialize
ensureDirectoryExists
computePath
fetchKeys
initialized
sftp
directory
create
No protected constants found
No private methods found
No private properties found
No private constants found

Properties

$initialized

$initialized : bool

Indicates if the adapter has been initialized.

Type

bool — Indicates if the adapter has been initialized.

$sftp

$sftp : \phpseclib\Net\SFTP

Type

SFTP

$directory

$directory : ?string

Type

string|null

$create

$create : bool

Type

bool

Methods

__construct()

__construct(\phpseclib\Net\SFTP  $sftp, string|null  $directory = null, bool  $create = false) : mixed

Constructor for the Sftp adapter.

Initializes an instance of the Sftp adapter with the provided SFTP connection, remote directory, and option to create the directory if it does not exist.

Parameters

\phpseclib\Net\SFTP $sftp

An Sftp instance for SFTP operations.
string|null $directory

The remote directory to use.
bool $create

Whether to create the remote directory if it does not exist.

Throws

\LogicException

if the SecLibSFTP class is not available.

Returns

mixed —

read()

read(string  $key) : string|bool

Reads the content of the file.

Parameters

string $key

The key or path of the file to read.

Returns

string|bool —

The content of the file or false if it cannot be read.

rename()

rename(string  $sourceKey, string  $targetKey) : bool

Renames a file.

Parameters

string $sourceKey

The current key or path of the file.
string $targetKey

The new key or path for the file.

Returns

bool —

True on success, false on failure.

write()

write(string  $key, string  $content) : int|bool

Writes the given content into the file.

Parameters

string $key

The key or path of the file to write.
string $content

The content to write into the file.

Returns

int|bool —

The number of bytes written or false on failure.

exists()

exists(string  $key) : bool

Indicates whether the file exists.

Parameters

string $key

The key or path of the file to check.

Returns

bool —

True if the file exists, false otherwise.

isDirectory()

isDirectory(string  $key) : bool

Check if the key represents a directory.

Parameters

string $key

The key or path to check.

Returns

bool —

True if the key is a directory, false otherwise.

keys()

keys() : array

Returns an array of all keys (files and directories).

Returns

array —

The list of keys.

listKeys()

listKeys(string  $prefix = '') : array

Lists keys that begin with the given prefix.

Parameters

string $prefix

The prefix to filter the keys (optional, defaults to an empty string).

Returns

array —

An array of keys starting with the specified prefix.

mtime()

mtime(string  $key) : int|bool

Returns the last modified time.

Parameters

string $key

The key or path of the file.

Returns

int|bool —

The last modified time as a UNIX timestamp, or false on failure.

delete()

delete(string  $key) : bool

Deletes the file.

Parameters

string $key

The key or path of the file to delete.

Returns

bool —

True on success, false on failure.

createFile()

createFile(string  $key, \Omega\Filesystem\Filesystem  $filesystem) : \Omega\Filesystem\File

Creates a new File instance.

Parameters

string $key

The unique key that identifies the file in the filesystem.
\Omega\Filesystem\Filesystem $filesystem

The filesystem instance that will manage the file.

Returns

\Omega\Filesystem\File —

Returns a new instance of the File class.

initialize()

initialize() : void

Initializes the SFTP adapter.

Ensures the root directory exists and sets the initialized flag to true.

Returns

void —

ensureDirectoryExists()

ensureDirectoryExists(string  $directory, bool  $create) : void

Ensures that the specified directory exists.

If the directory does not exist and $create is true, it will attempt to create it.

Parameters

string $directory

The directory to check.
bool $create

Whether to create the directory if it does not exist.

Throws

\RuntimeException

if the directory does not exist and cannot be created.

Returns

void —

computePath()

computePath(string  $key) : string

Computes the full path for a given key.

Parameters

string $key

The key for which to compute the path.

Returns

string —

The full path to the file or directory.

fetchKeys()

fetchKeys(string  $directory = '', bool  $onlyKeys = true) : array

Fetches keys and directories from the specified directory.

Parameters

string $directory

The directory to fetch keys from.
bool $onlyKeys

Whether to only fetch file keys.

Returns

array —

An associative array containing keys and directories.