ClearFoundation

ClearOS API

Class DmCrypt

Description
Description | Vars (details) | Methods (details) Constants

DmCrypt base class.

Located in /api/DmCrypt.class.php (line 60) 

Engine
   |
   --DmCrypt
Variable Summary
Description | Vars (details) | Methods (details) Constants
mixed $config
mixed $loaded
Method Summary
Description | Constants Vars (details) | Methods (details)
void __construct ()
void __destruct ()
void CreateVolume ( $name,  $mount_point,  $device,  $size,  $passwd,  $verify)
void DeleteVolume ( $name)
void GetVolumes ()
void IsMounted ( $name)
boolean IsValidMountPoint ( $mount, string $name)
boolean IsValidName (string $name)
boolean IsValidPassword (string $passwd)
boolean IsValidSize (string $size)
void MountVolume ( $name,  $passwd)
void UnmountVolume ( $name)
void VolumeExists ( $name,  $mount_point,  $device)
Variables
Description | Vars (details) Constants | Methods (details)
mixed $config = array() (line 66)
mixed $loaded = false (line 67)

Inherited Variables

Inherited from Engine

Engine::$errors
Methods
Description | Vars (details) Constants Methods (details)
Constructor __construct (line 79)

Dmcrypt constructor.

  • access: public
void __construct ()
Redefinition of:
Engine::__construct()
Engine constructor.
Destructor __destruct (line 467)
  • access: public
void __destruct ()
Redefinition of:
Engine::__destruct()
CreateVolume (line 199)
  • access: public
void CreateVolume ( $name,  $mount_point,  $device,  $size,  $passwd,  $verify)
  • $name
  • $mount_point
  • $device
  • $size
  • $passwd
  • $verify
DeleteVolume (line 274)
  • access: public
void DeleteVolume ( $name)
  • $name
GetVolumes (line 128)
  • access: public
void GetVolumes ()
IsMounted (line 363)
  • access: public
void IsMounted ( $name)
  • $name
IsValidMountPoint (line 402)

Validation routine for mount point.

boolean IsValidMountPoint ( $mount, string $name)
  • string $name: volume name
  • $mount
IsValidName (line 382)

Validation routine for a name.

boolean IsValidName (string $name)
  • string $name: volume name
IsValidPassword (line 427)

Validation routine for password.

boolean IsValidPassword (string $passwd)
  • string $passwd: volume password
IsValidSize (line 449)

Validation routine for volume size.

boolean IsValidSize (string $size)
  • string $size: volume size
MountVolume (line 308)
  • access: public
void MountVolume ( $name,  $passwd)
  • $name
  • $passwd
UnmountVolume (line 339)
  • access: public
void UnmountVolume ( $name)
  • $name
VolumeExists (line 139)
  • access: public
void VolumeExists ( $name,  $mount_point,  $device)
  • $name
  • $mount_point
  • $device

Inherited Methods

Inherited From Engine

Engine::__construct()
Engine::AddValidationError()
Engine::CheckValidationErrors()
Engine::CopyValidationErrors()
Engine::GetValidationErrors()
Engine::Log()
Engine::__destruct()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from Engine

Engine::COMMAND_API

Documentation generated on Fri, 28 Aug 2009 20:32:03 -0400 by phpDocumentor 1.3.2