OMV\System\Filesystem\Backend\Manager Class Reference

Inheritance diagram for OMV\System\Filesystem\Backend\Manager:

Public Member Functions
	getIterator ()
	registerBackend (BackendAbstract $backend)
	unregisterBackend ($type)
	getBackendByType ($type)
	assertBackendExistsByType ($type)
	getBackendById ($id)
	assertBackendExistsById ($id)
	isSupported ($type)
	enumerate ()
	dump ()

Static Public Member Functions
static &	getInstance ()

Detailed Description

Helper class that implements functions regarding file systems.

Member Function Documentation

assertBackendExistsById()

OMV\System\Filesystem\Backend\Manager::assertBackendExistsById (   $id )

final

Assert that the backend for the specified filesystem exists.

Parameters

id

The UUID, label or device path of the filesystem, e.g. 78b669c1-9183-4ca3-a32c-80a4e2c61e2d (EXT2/3/4, JFS, XFS) 7A48-BA97 (FAT) 2ED43920D438EC29 (NTFS) 2015-01-13-21-48-46-00 (ISO9660) /dev/sde1 /dev/disk/by-id/scsi-SATA_ST3200XXXX2AS_5XWXXXR6-part1 /dev/disk/by-label/DATA /dev/disk/by-path/pci-0000:00:10.0-scsi-0:0:0:0-part2 /dev/disk/by-uuid/ad3ee177-777c-4ad3-8353-9562f85c0895 /dev/cciss/c0d0p2 tank/multimedia/movies

Exceptions

assertBackendExistsByType()

OMV\System\Filesystem\Backend\Manager::assertBackendExistsByType (   $type )

final

Assert that the backend for the specified filesystem type exists.

Parameters

type	Specifies the filesystem type, e.g. 'ext3', 'vfat', ...

Exceptions

dump()

OMV\System\Filesystem\Backend\Manager::dump ( )

final

Dump all registered RPC services.

enumerate()

OMV\System\Filesystem\Backend\Manager::enumerate ( )

final

Enumerate all available/detected file systems.

Returns

An array of objects with the fields devicefile, uuid, label and type.

Exceptions

getBackendById()

OMV\System\Filesystem\Backend\Manager::getBackendById (   $id )

final

Get the backend of the specified filesystem identifier.

Parameters

id

The UUID, label or device path of the filesystem, e.g. 78b669c1-9183-4ca3-a32c-80a4e2c61e2d (EXT2/3/4, JFS, XFS) 7A48-BA97 (FAT/exFAT) 2ED43920D438EC29 (NTFS) 2015-01-13-21-48-46-00 (ISO9660) /dev/sde1 /dev/disk/by-id/scsi-SATA_ST3200XXXX2AS_5XWXXXR6-part1 /dev/disk/by-label/DATA /dev/disk/by-path/pci-0000:00:10.0-scsi-0:0:0:0-part2 /dev/disk/by-uuid/ad3ee177-777c-4ad3-8353-9562f85c0895 /dev/cciss/c0d0p2 tank/multimedia/movies

Returns

The backend that implements the given filesystem, otherwise NULL.

getBackendByType()

OMV\System\Filesystem\Backend\Manager::getBackendByType (   $type )

final

Get the backend of the specified filesystem type.

Parameters

type	Specifies the filesystem type, e.g. 'ext3', 'vfat', ...

Returns

The backend that implements the given filesystem, otherwise NULL.

getInstance()

static& OMV\System\Filesystem\Backend\Manager::getInstance ( )

static

Returns a manager singleton.

Returns

The manager object.

isSupported()

OMV\System\Filesystem\Backend\Manager::isSupported (   $type )

final

Check whether the given file system type is supported.

Parameters

type	The file system type, e.g. 'ext4', 'iso9660', ...

Returns

TRUE if the file system is supported, otherwise FALSE.

registerBackend()

OMV\System\Filesystem\Backend\Manager::registerBackend ( BackendAbstract  $backend )

final

Register a filesystem backend.

Parameters

backend

The filesystem backend object to register.

Returns

TRUE if successful, otherwise FALSE.

unregisterBackend()

OMV\System\Filesystem\Backend\Manager::unregisterBackend (   $type )

final

Unregister a filesystem backend.

Parameters

type	Specifies the filesystem type, e.g. 'ext3', 'vfat', ...

Returns

TRUE if successful, otherwise FALSE.

---

The documentation for this class was generated from the following file:

• system/filesystem/backend/manager.inc