OMVFilesystemBackendAbstract Class Reference

Inheritance diagram for OMVFilesystemBackendAbstract:

Public Member Functions
	getType ()
	enumerate ()
	isBlkidEnumerated ()
	isTypeOf ($id)
	getProperties ()
	hasProperty ($property)
	hasDiscardSupport ()
	hasPosixAclSupport ()
	hasFstabSupport ()
	getFstabMntOptions ()
	getMkfsOptions ()
	getImpl ($args)
Public Member Functions inherited from OMVObject
	__construct ()
	getLastError ()

Public Attributes
const	PROP_NONE = 0x0
const	PROP_MNTENT = 0x1
const	PROP_POSIX_ACL = 0x2
const	PROP_DISCARD = 0x4

Protected Attributes
	$type
	$properties = self::PROP_NONE
	$mkfsOptions = ""
	$mntOptions = array()

Additional Inherited Members
Protected Member Functions inherited from OMVObject
	setLastError ($error)
	debug ()

Detailed Description

The generic class that represents a filesystem backend.

Member Function Documentation

OMVFilesystemBackendAbstract::enumerate

(

)

Get a list of filesystem devices of the given filesystem backend. Override this method if the filesystem implemented by this backend is not identified by the block device identification library.

Returns

A list of devicefile names, otherwise FALSE.

OMVFilesystemBackendAbstract::getFstabMntOptions

(

)

Get filesystem mount options used in '/etc/fstab'. See http://linux.die.net/man/8/mount.

Returns

An array of mount options.

OMVFilesystemBackendAbstract::getImpl

(

$args

)

Get the object of the class that represents and implements a filesystem of this filesystem backend.

Parameters

args	The arguments to the class constructor.

Returns

The object of the class implementing the given filesystem type, otherwise NULL.

OMVFilesystemBackendAbstract::getMkfsOptions

(

)

Get additional 'mkfs' command options used to create the filesystem. See http://linux.die.net/man/8/mkfs.

Returns

The additional command options string.

OMVFilesystemBackendAbstract::getProperties ( )

final

Get the filesystem properties.

Returns

The properties defined for this filesystem.

OMVFilesystemBackendAbstract::getType ( )

final

Get the type of the filesystem, e.g. 'ext3', 'vfat' or 'btrfs'.

OMVFilesystemBackendAbstract::hasDiscardSupport

(

)

Check whether the filesystem supports the discard/TRIM commands to the underlying block device when blocks are freed. See https://wiki.archlinux.org/index.php/Solid_State_Drives#TRIM.

Returns

TRUE if the filesystem supports the discard/TRIM commands, otherwise FALSE.

OMVFilesystemBackendAbstract::hasFstabSupport

(

)

Is the filesystem mounted via /etc/fstab?

Returns

TRUE if the filesystem is mounted via '/etc/fstab', otherwise FALSE.

OMVFilesystemBackendAbstract::hasPosixAclSupport

(

)

Does the filesystem support POSIX ACL.

Returns

TRUE if the filesystem supports POSIX ACL, otherwise FALSE.

OMVFilesystemBackendAbstract::hasProperty (   $property )

final

Check whether the filesystem has the given property.

Parameters

property

The property to check for, e.g. PROP_POSIX_ACL.

Returns

TRUE if the given property is set, otherwise FALSE.

OMVFilesystemBackendAbstract::isBlkidEnumerated

(

)

Check whether the filesystem implemented by this backend is identified by the block device identification library. If this is not the case, then the backend must override the enumerate method.

Returns

TRUE if the filesystem is identified by the block device identification library, otherwise FALSE.

OMVFilesystemBackendAbstract::isTypeOf

(

$id

)

Check whether the given filesystem identifier is represented by this filesystem backend.

Parameters

id

The filesystem identifier (e.g. UUID or device path), e.g. 78b669c1-9183-4ca3-a32c-80a4e2c61e2d (EXT2/3/4, JFS, XFS) 7A48-BA97 (DOS) 2ED43920D438EC29 (NTFS) /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

Returns

TRUE if successful, otherwise FALSE.

---

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

• system.inc