Class: System_Mount_Entry

Source Location: /System_Mount-1.0.1/System/Mount.php

Class Overview

File_Fstab_Entry
   |
   --System_Mount_Entry

Class which handles the mount/unmount operation

Author(s):

Ian Eure <ieure at php.net>

Version:

@version@

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 96]
Class which handles the mount/unmount operation

This is the heart of System_Mount- the main class exists only to instruct File_Fstab to use this class, making it easier on the end-user.

Author: Ian Eure <ieure@php.net>
Version: @version@
Copyright: Copyright © 2004, Ian Eure
License: PHP License 3.0

[ Top ]

Class Variables

$_mtab =

[line 108]

File_Fstab instance

This contains an instance of File_Fstab (created with File_Fstab::singleton() so we don't waste memory) which parses /etc/mtab and holds the current device mount state.

See: File_Fstab
Access: protected

Type:

object

[ Top ]

$_smOptions =

[line 119]

System_Mount options

This contains the options passed to System_Mount when it was instantiated

See: System_Mount::System_Mount()
Access: protected

Type:

array

[ Top ]

Method Detail

System_Mount_Entry (Constructor) [line 129]

void System_Mount_Entry(
[$entry
$entry = false])

Constructor

See: File_Fstab::File_Fstab()

Parameters:

$entry $entry — fstab entry

[ Top ]

isMounted [line 144]

boolean isMounted(
)

Is this device mounted?

Return: true if mounted, false if unmounted

[ Top ]

mayMount [line 179]

boolean mayMount(
)

May this device be mounted?

Similar to userMayMount(), but this takes the UID the script is running as in to account, and returns 'true' if the current UID is 0, or the result of userMayMount otherwise.

Return: true if user may mount, false if not
See: System_Mount_Entry::userMayMount()

[ Top ]

mount [line 195]

mixed mount(
)

Mount the device

Return: boolean or PEAR_Error
See: System_Mount_Entry::_mount()

[ Top ]

unMount [line 210]

mixed unMount(
)

Unmount the device

Return: boolean true on success, PEAR_Error otherwise
See: System_Mount_Entry::_mount()

[ Top ]

userMayMount [line 163]

boolean userMayMount(
)

May a user mount this device?

Return: true if user may mount, false if not

[ Top ]

_mount [line 227]

return _mount(
int
$command)

Dispatch an (un)mount command

Return: value from System_Command or PEAR_Error
See: System_Command::execute()
Access: protected

Parameters:

int $command — SYSTEM_MOUNT_CMD_MOUNT (to mount device) or _UNMOUNT (to unmount device)

[ Top ]