DcpApiVaultKeys Class Reference

Collaboration diagram for DcpApiVaultKeys:

Public Member Functions
	setVerbose ($verbose)
	setStop ($stop)
	__construct ()
	getSequenceNextVal ($seqName)
	run ($dryRun, $vaultid)
	verifyIndexes ()

Data Fields
const	timeWindow = 10
const	timeWindowFactor = 100

Protected Member Functions
	humanDelay ($delay)
	updateVaultData ($newId, VaultFileInfo $fileInfo)
	logVault ($currentName, $newName)
	recover ()
	verbose ($format)
	verboseColor ($format)
	updateFamilyData ($vaultId, $newId, $docids)
	updateDocData ($vaultId, $newId, $fromid, $docids)
	getFamilyFileAttrIds ($famId)
	getNewVaultId ()

Protected Attributes
	$attrIds = array()
	$vaultFile = null
	$logFile = null
	$dryRun = false
	$verbose = false
	$stop = false

Detailed Description

Definition at line 30 of file renameVaultKeys.php.

Constructor & Destructor Documentation

__construct

(

)

Definition at line 57 of file renameVaultKeys.php.

Here is the call graph for this function:

Member Function Documentation

getFamilyFileAttrIds (   $famId )

protected

Get file attributes for given family

Parameters

int

$famId

family identifier

Returns

mixed

Definition at line 397 of file renameVaultKeys.php.

getNewVaultId ( )

protected

Definition at line 409 of file renameVaultKeys.php.

Here is the call graph for this function:

getSequenceNextVal

(

$seqName

)

Definition at line 68 of file renameVaultKeys.php.

Here is the call graph for this function:

humanDelay (   $delay )

protected

Definition at line 181 of file renameVaultKeys.php.

logVault (   $currentName,   $newName  )

protected

Log current file rename

Parameters

string	$currentName
string	$newName

Exceptions

\Dcp\Exception

Definition at line 248 of file renameVaultKeys.php.

recover ( )

protected

Definition at line 256 of file renameVaultKeys.php.

run	(		$dryRun,
			$vaultid
	)

Definition at line 73 of file renameVaultKeys.php.

Here is the call graph for this function:

setStop

(

$stop

)

Parameters

boolean

$stop

Definition at line 53 of file renameVaultKeys.php.

setVerbose

(

$verbose

)

Parameters

boolean

$verbose

Definition at line 46 of file renameVaultKeys.php.

Here is the call graph for this function:

updateDocData (   $vaultId,   $newId,   $fromid,   $docids  )

protected

Set new index for file document attributes

Parameters

int	$vaultId	current vault identifier
int	$newId	new vault identifier
int	$fromid	document's family identifier to search
	int[]	$docids document identifiers to update

Exceptions

\Dcp\Exception

Definition at line 365 of file renameVaultKeys.php.

Here is the call graph for this function:

updateFamilyData (   $vaultId,   $newId,   $docids  )

protected

Update file family parameters

Parameters

int	$vaultId	current vault identifier
int	$newId	new vault identifier
	int[]	$docids family identifiers

Exceptions

\Dcp\Exception

Definition at line 304 of file renameVaultKeys.php.

Here is the call graph for this function:

updateVaultData (   $newId, VaultFileInfo  $fileInfo  )

protected

Complete rename vault identifier : rename real file name

Parameters

int	$newId	new vault identifier
VaultFileInfo	$fileInfo

Exceptions

\Dcp\Db\Exception
\Dcp\Exception

Definition at line 213 of file renameVaultKeys.php.

Here is the call graph for this function:

verbose (   $format )

protected

Definition at line 276 of file renameVaultKeys.php.

verboseColor (   $format )

protected

Definition at line 282 of file renameVaultKeys.php.

Here is the call graph for this function:

verifyIndexes

(

)

Check Vault integrity indexes

Exceptions

\Dcp\Exception

Definition at line 196 of file renameVaultKeys.php.

Here is the call graph for this function:

Field Documentation

$attrIds = array()

protected

Definition at line 32 of file renameVaultKeys.php.

$dryRun = false

protected

Definition at line 35 of file renameVaultKeys.php.

$logFile = null

protected

Definition at line 34 of file renameVaultKeys.php.

$stop = false

protected

Definition at line 37 of file renameVaultKeys.php.

$vaultFile = null

protected

Definition at line 33 of file renameVaultKeys.php.

$verbose = false

protected

Definition at line 36 of file renameVaultKeys.php.

const timeWindow = 10

Definition at line 41 of file renameVaultKeys.php.

const timeWindowFactor = 100

Definition at line 42 of file renameVaultKeys.php.

---

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

• renameVaultKeys.php