OMV\System\Filesystem\Btrfs Class Reference

Inheritance diagram for OMV\System\Filesystem\Btrfs:

Public Member Functions
	refresh ()
	getDeviceFiles ()
	getDeviceFilesAssoc ()
	getNumTotalDeviceFiles ()
	getStatistics ()
	remove ()
Public Member Functions inherited from OMV\System\Filesystem\Filesystem
	__construct ($id)
	refresh ()
	exists ()
	hasUuid ()
	assertUuid ()
	getUuid ()
	hasLabel ()
	assertLabel ()
	getLabel ()
	getType ()
	getPartitionType ()
	getPartitionScheme ()
	getUsage ()
	getPartitionEntry ()
	getDeviceFile ()
	getDeviceFileByUuid ()
	hasDeviceFileByUuid ()
	getDeviceFileById ()
	hasDeviceFileById ()
	getDeviceFileByLabel ()
	hasDeviceFileByLabel ()
	getParentDeviceFile ()
	getPredictableDeviceFile ()
	getDeviceFiles ()
	hasMultipleDevices ()
	getBlockSize ()
	grow ()
	shrink ()
	remove ()
	getMountPoint ()
	getStatistics ()
	isMounted ()
	mount ($options="", $dir="")
	umount ($force=FALSE, $lazy=FALSE)
	setBackend (Backend\BackendAbstract $backend)
	getBackend ()
	getDescription ()
Public Member Functions inherited from OMV\System\BlockDevice
	__construct ($deviceFile)
	exists ()
	assertExists ()
	getDeviceFile ()
	getCanonicalDeviceFile ()
	getDeviceFileById ()
	hasDeviceFileById ()
	getDeviceFileByPath ()
	hasDeviceFileByPath ()
	getPredictableDeviceFile ()
	getPreferredDeviceFile ()
	getDeviceFileSymlinks ()
	getDeviceName ($canonical=FALSE)
	getSize ()
	getBlockSize ()
	getSectorSize ()
	getDeviceNumber ()
	getMajor ()
	getMinor ()
	getDescription ()
	hasUdevProperty ($id)
	assertUdevProperty ($id)
	getUdevProperty ($id)
	waitForDevice ($timeout)
Public Member Functions inherited from OMV\System\Filesystem\IFilesystem
	getCanonicalDeviceFile ()
	getPreferredDeviceFile ()
	getDeviceFileSymlinks ()
	getSize ()
	mount ($options)

Protected Member Functions
	getData ()
Protected Member Functions inherited from OMV\System\Filesystem\Filesystem
	isCached ()
	setCached ($cached)
	getData ()
Protected Member Functions inherited from OMV\System\BlockDevice
	getUdevData ($force=FALSE)

Protected Attributes
	$numTotalDeviceFiles = 0
	$deviceFiles = []
Protected Attributes inherited from OMV\System\Filesystem\Filesystem
	$uuid = ""
	$type = ""
	$label = ""
	$partEntry = NULL
	$usage = ""
Protected Attributes inherited from OMV\System\BlockDevice
	$deviceFile = NULL
	$deviceFileById = NULL
	$size = FALSE
	$blockSize = FALSE
	$sectorSize = FALSE
	$udevData = NULL

Additional Inherited Members
Static Public Member Functions inherited from OMV\System\Filesystem\Filesystem
static	hasFileSystem ($deviceFile)
static	getFilesystems ()
static	getImpl ($id)
static	assertGetImpl ($id)
static	getImplByMountPoint ($dir)

Member Function Documentation

getData()

OMV\System\Filesystem\Btrfs::getData ( )

protected

Get the filesystem detailed information.

Returns

TRUE if successful, otherwise FALSE.

getDeviceFiles()

OMV\System\Filesystem\Btrfs::getDeviceFiles

(

)

See parent class definition.

Implements OMV\System\Filesystem\IFilesystem.

getDeviceFilesAssoc()

OMV\System\Filesystem\Btrfs::getDeviceFilesAssoc

(

)

Get the list of all used device files. Note, the array index is the device ID, thus the array starts with index 1. This is BTRFS specific.

Returns

An associative array containing the used device files, otherwise FALSE.

getNumTotalDeviceFiles()

OMV\System\Filesystem\Btrfs::getNumTotalDeviceFiles

(

)

Get the total number of used device files.

Returns

The total number of device files, otherwise FALSE.

getStatistics()

OMV\System\Filesystem\Btrfs::getStatistics

(

)

See parent class definition.

For a btrfs filesystem, size is the raw size of the filesystem (i.e. sum of all device sizes), used is the size of data stored after accounting for DUP/RAID level, and available is an estimate of remaining free space based on current data ratio. e.g. Consider 25 GiB of data stored in a RAID1 filesystem made up of two 100 GiB devices: Size: 200 GiB (total size of filesystem, 2x100 GiB) Used: 25 GiB (data ratio: 2.0, so actually occupies 50 GiB) Available: 75 GiB (raw space remaining: 150 GiB, but based on current ratio will fit only 75 GiB of data)

refresh()

OMV\System\Filesystem\Btrfs::refresh

(

)

See parent class definition.

remove()

OMV\System\Filesystem\Btrfs::remove

(

)

Remove the filesystem.

Returns

None.

Implements OMV\System\Filesystem\IFilesystem.

---

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

• btrfs.inc