Référence de la classe AKAbstractUnarchiver

Graphe d'héritage de AKAbstractUnarchiver:

Fonctions membres publiques
	__wakeup ()
	shutdown ()
	isIgnoredDirectory ($shortFilename)
Fonctions membres publiques hérités de AKAbstractPart
	tick ()
	getState ()
	getStatusArray ()
	setup ($parametersArray)
	getDomain ()
	getStep ()
	getSubstep ()
	attach (AKAbstractPartObserver $obs)
	detach (AKAbstractPartObserver $obs)
Fonctions membres publiques hérités de AKAbstractObject
	getError ($i=null)
	getErrors ()
	resetErrors ()
	getWarning ($i=null)
	getWarnings ()
	resetWarnings ()
	propagateToObject (&$object)
	propagateFromObject (&$object)
	setError ($error)
	setWarning ($warning)

Champs de données
	$archiveList = array()
	$totalSize = array()
	$renameFiles = array()
	$renameDirs = array()
	$skipFiles = array()

Fonctions membres protégées
	_prepare ()
	readArchiveHeader ()
	_run ()
	readFileHeader ()
	processFileData ()
	_finalize ()
	nextFile ()
	isEOF ($local=false)
	setCorrectPermissions ($path)
	fread ($fp, $length=null)
	removePath ($path)
Fonctions membres protégées hérités de AKAbstractPart
	_prepare ()
	_run ()
	_finalize ()
	_makeReturnTable ()
	setState ($state='init', $errorMessage='Invalid setState argument')
	setBreakFlag ()
	setDomain ($new_domain)
	setStep ($new_step)
	setSubstep ($new_substep)
	notify ($message)
Fonctions membres protégées hérités de AKAbstractObject
	setErrorsQueueSize ($newSize=0)
	setWarningsQueueSize ($newSize=0)

Attributs protégés
	$filename = null
	$currentPartNumber = -1
	$currentPartOffset = 0
	$flagRestorePermissions = false
	$postProcEngine = null
	$addPath = ''
	$removePath = ''
	$chunkSize = 524288
	$fp = null
	$runState = null
	$fileHeader = null
	$dataReadLength = 0
	$ignoreDirectories = array()
Attributs protégés hérités de AKAbstractPart
	$isPrepared = false
	$isRunning = false
	$isFinished = false
	$hasRan = false
	$active_domain = ""
	$active_step = ""
	$active_substep = ""
	$_parametersArray = array()
	$databaseRoot = array()
	$observers = array()
Attributs protégés hérités de AKAbstractObject
	$_errors_queue_size = 0
	$_warnings_queue_size = 0

Fonctions membres privées
	scanArchives ()
	getBaseExtension ()

Description détaillée

The base class of unarchiver classes

Documentation des fonctions membres

__wakeup()

__wakeup

(

)

Wakeup function, called whenever the class is unserialized

_finalize()

_finalize ( )

protected

Références AKAbstractPart\setState().

_prepare()

_prepare ( )

finalprotected

Implements the abstract _prepare() method

Références $key, $value, AK_STATE_NOFILE, AKAbstractObject\getError(), AKFactory\getPostProc(), readArchiveHeader(), removePath(), scanArchives(), et AKAbstractPart\setState().

_run()

_run ( )

protected

Références $message, AK_STATE_DATA, AK_STATE_DATAREAD, AK_STATE_DONE, AK_STATE_HEADER, AK_STATE_NOFILE, AK_STATE_POSTPROC, debugMsg(), elseif, AKAbstractObject\getError(), AKAbstractPart\getState(), AKFactory\getTimer(), AKAbstractPart\notify(), processFileData(), AKAbstractObject\propagateFromObject(), readFileHeader(), et AKAbstractPart\setState().

fread()

fread (   $fp,   $length = null  )

protected

Reads data from the archive and notifies the observer with the 'reading' message

Paramètres

$fp
$length

Références $data, $fp, $message, et AKAbstractPart\notify().

Référencé par AKUnarchiverJPA\readArchiveHeader(), AKUnarchiverZIP\readArchiveHeader(), et AKUnarchiverZIP\readFileHeader().

getBaseExtension()

getBaseExtension ( )

private

Returns the base extension of the file, e.g. '.jpa'

Renvoie

string

Référencé par scanArchives().

isEOF()

isEOF (   $local = false )

protected

Returns true if we have reached the end of file

Paramètres

$local

bool True to return EOF of the local file, false (default) to return if we have reached the end of the archive set

Renvoie

bool True if we have reached End Of File

Références $filesize, $position, et elseif.

Référencé par AKUnarchiverZIP\readFileHeader().

isIgnoredDirectory()

isIgnoredDirectory

(

$shortFilename

)

Is this file or directory contained in a directory we've decided to ignore write errors for? This is useful to let the extraction work despite write errors in the log, logs and tmp directories which MIGHT be used by the system on some low quality hosts and Plesk-powered hosts.

Paramètres

string

$shortFilename

The relative path of the file/directory in the package

Renvoie

boolean True if it belongs in an ignored directory

Références $check.

nextFile()

nextFile ( )

protected

Opens the next part file for reading

Références $currentPartNumber, debugMsg(), AKAbstractObject\setError(), AKAbstractPart\setState(), et AKText\sprintf().

Référencé par AKUnarchiverJPA\readArchiveHeader(), AKUnarchiverZIP\readArchiveHeader(), et AKUnarchiverZIP\readFileHeader().

processFileData()

processFileData ( )

abstractprotected

Concrete classes must use this method to process file data. It must set $runState to AK_STATE_DATAREAD when it's finished processing the file data.

Renvoie

bool True if processing the file data was successful, false if an error occurred

Référencé par _run().

readArchiveHeader()

readArchiveHeader ( )

abstractprotected

Concrete classes are supposed to use this method in order to read the archive's header and prepare themselves to the point of being ready to extract the first file.

Référencé par _prepare().

readFileHeader()

readFileHeader ( )

abstractprotected

Concrete classes must use this method to read the file header

Renvoie

bool True if reading the file was successful, false if an error occurred or we reached end of archive

Référencé par _run().

removePath()

removePath (   $path )

protected

Removes the configured $removePath from the path $path

Paramètres

string

$path

The path to reduce

Renvoie

string The reduced path

Références $path.

Référencé par _prepare(), et AKUnarchiverZIP\readFileHeader().

scanArchives()

scanArchives ( )

private

Scans for archive parts

Références $count, $extension, $filename, $filesize, $message, $totalSize, AK_STATE_NOFILE, debugMsg(), DIRECTORY_SEPARATOR, getBaseExtension(), et AKAbstractPart\notify().

Référencé par _prepare().

setCorrectPermissions()

setCorrectPermissions (   $path )

protected

Tries to make a directory user-writable so that we can write a file to it

Paramètres

$path

string A path to a file

Références $path, AKFactory\get(), et null.

shutdown()

shutdown

(

)

Sleep function, called whenever the class is serialized

Documentation des champs

$addPath

$addPath = ''

protected

$archiveList

$archiveList = array()

$chunkSize

$chunkSize = 524288

protected

$currentPartNumber

$currentPartNumber = -1

protected

Référencé par nextFile().

$currentPartOffset

$currentPartOffset = 0

protected

$dataReadLength

$dataReadLength = 0

protected

$fileHeader

$fileHeader = null

protected

$filename

$filename = null

protected

Référencé par scanArchives().

$flagRestorePermissions

$flagRestorePermissions = false

protected

$fp

$fp = null

protected

Référencé par fread().

$ignoreDirectories

$ignoreDirectories = array()

protected

$postProcEngine

$postProcEngine = null

protected

$removePath

$removePath = ''

protected

$renameDirs

$renameDirs = array()

$renameFiles

$renameFiles = array()

$runState

$runState = null

protected

$skipFiles

$skipFiles = array()

$totalSize

$totalSize = array()

Référencé par scanArchives().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• restore.php