[akeebabackup] element index

Package indexes

All elements

top

$_errors_queue_size: AKAbstractObject::$_errors_queue_size in restore.php
$_parametersArray: AKAbstractPart::$_parametersArray in restore.php

Any configuration variables, in the form of an array.
$_warnings_queue_size: AKAbstractObject::$_warnings_queue_size in restore.php
_: AKText::_() in restore.php
_AKEEBA_IS_WINDOWS: _AKEEBA_IS_WINDOWS in restore.php
_AKEEBA_RESTORATION: _AKEEBA_RESTORATION in restore.php
_finalize: AKAbstractUnarchiver::_finalize() in restore.php
_finalize: AKAbstractPart::_finalize() in restore.php

Runs the finalisation process for this part. Should set _isFinished to true.
_makeReturnTable: AKAbstractPart::_makeReturnTable() in restore.php

Constructs a Response Array based on the engine part's state.
_prepare: AKAbstractUnarchiver::_prepare() in restore.php

Implements the abstract _prepare() method
_prepare: AKAbstractPart::_prepare() in restore.php

Runs the preparation for this part. Should set _isPrepared
_run: AKAbstractUnarchiver::_run() in restore.php
_run: AKAbstractPart::_run() in restore.php

Runs the main functionality loop for this part. Upon calling, should set the _isRunning to true. When it finished, should set the _hasRan to true. If an error is encountered, setError should be used.
__construct: AKUnarchiverJPS::__construct() in restore.php
__construct: AKText::__construct() in restore.php
__construct: AKPostprocFTP::__construct() in restore.php
__construct: AKCoreTimer::__construct() in restore.php

Public constructor, creates the timer object and calculates the execution time limits
__construct: AKAbstractObject::__construct() in restore.php

Public constructor, makes sure we are instanciated only by the factory class
__construct: AKAbstractUnarchiver::__construct() in restore.php

Public constructor
__toString: RestorationObserver::__toString() in restore.php
__wakeup: AKAbstractUnarchiver::__wakeup() in restore.php

Wakeup function, called whenever the class is unserialized
__wakeup: AKCoreTimer::__wakeup() in restore.php

Wake-up function to reset internal timer when we get unserialized
__wakeup: AKPostprocFTP::__wakeup() in restore.php

top

$active_domain

AKAbstractPart::$active_domain in restore.php

The name of the engine part (a.k.a. Domain), used in return table generation.

$active_step

AKAbstractPart::$active_step in restore.php

The step this engine part is in. Used verbatim in return table and should be set by the code in the _run() method.

$active_substep

AKAbstractPart::$active_substep in restore.php

A more detailed description of the step this engine part is in. Used verbatim in return table and should be set by the code in the _run() method.

$addPath

AKAbstractUnarchiver::$addPath in restore.php

$archiveList

AKAbstractUnarchiver::$archiveList in restore.php

AddRoundKey

AKEncryptionAES::AddRoundKey() in restore.php

AESDecryptCBC

AKEncryptionAES::AESDecryptCBC() in restore.php

AES decryption in CBC mode. This is the standard mode (the CTR methods actually use Rijndael-128 in CTR mode, which - technically - isn't AES).

AESDecryptCtr

AKEncryptionAES::AESDecryptCtr() in restore.php

Decrypt a text encrypted by AES in counter mode of operation

AESEncryptCtr

AKEncryptionAES::AESEncryptCtr() in restore.php

Encrypt a text using AES encryption in Counter mode of operation

see http://csrc.nist.gov/publications/nistpubs/800-38a/sp800-38a.pdf

AKAbstractObject

AKAbstractObject in restore.php

The base class of Akeeba Engine objects. Allows for error and warnings logging and propagation. Largely based on the Joomla! 1.5 JObject class.

AKAbstractPart

AKAbstractPart in restore.php

The superclass of all Akeeba Kickstart parts. The "parts" are intelligent stateful

AKAbstractPartObserver

AKAbstractPartObserver in restore.php

Descendants of this class can be used in the unarchiver's observer methods (attach, detach and notify)

AKAbstractPostproc

AKAbstractPostproc in restore.php

File post processor engines base class

AKAbstractUnarchiver

AKAbstractUnarchiver in restore.php

The base class of unarchiver classes

AKCoreTimer

AKCoreTimer in restore.php

Timer class

Akeeba_Services_JSON

Akeeba_Services_JSON in restore.php

Converts to and from JSON format.

Akeeba_Services_JSON

Akeeba_Services_JSON::Akeeba_Services_JSON() in restore.php

constructs a new JSON instance

Akeeba_Services_JSON_Error

Akeeba_Services_JSON_Error in restore.php

Akeeba_Services_JSON_Error

Akeeba_Services_JSON_Error::Akeeba_Services_JSON_Error() in restore.php

AKEncryptionAES

AKEncryptionAES in restore.php

AES implementation in PHP (c) Chris Veness 2005-2011

AKFactory

AKFactory in restore.php

The Akeeba Kickstart Factory class

AKPostprocDirect

AKPostprocDirect in restore.php

Direct file writer

AKPostprocFTP

AKPostprocFTP in restore.php

FTP file writer

akstringlen

akstringlen() in restore.php

AKText

AKText in restore.php

A simple INI-based i18n engine

AKUnarchiverJPA

AKUnarchiverJPA in restore.php

JPA archive extraction class

AKUnarchiverJPS

AKUnarchiverJPS in restore.php

JPS archive extraction class

AKUnarchiverZIP

AKUnarchiverZIP in restore.php

ZIP archive extraction class

AKUtilsLister

AKUtilsLister in restore.php

A filesystem scanner which uses opendir()

AK_STATE_DATA

AK_STATE_DATA in restore.php

AK_STATE_DATAREAD

AK_STATE_DATAREAD in restore.php

AK_STATE_DONE

AK_STATE_DONE in restore.php

AK_STATE_HEADER

AK_STATE_HEADER in restore.php

AK_STATE_NOFILE

AK_STATE_NOFILE in restore.php

AK_STATE_POSTPROC

AK_STATE_POSTPROC in restore.php

asJavascript

AKText::asJavascript() in restore.php

attach

AKAbstractPart::attach() in restore.php

Attaches an observer object

top

$chunkSize: AKAbstractUnarchiver::$chunkSize in restore.php
$compressedTotal: RestorationObserver::$compressedTotal in restore.php
$currentPartNumber: AKAbstractUnarchiver::$currentPartNumber in restore.php
$currentPartOffset: AKAbstractUnarchiver::$currentPartOffset in restore.php
chmod: AKPostprocDirect::chmod() in restore.php
chmod: AKPostprocFTP::chmod() in restore.php
chmod: AKAbstractPostproc::chmod() in restore.php
Cipher: AKEncryptionAES::Cipher() in restore.php

AES Cipher function: encrypt 'input' with Rijndael algorithm
close: AKPostprocFTP::close() in restore.php
connect: AKPostprocFTP::connect() in restore.php
createDirectory: AKUnarchiverJPS::createDirectory() in restore.php

Creates the directory this file points to
createDirectory: AKUnarchiverJPA::createDirectory() in restore.php

Creates the directory this file points to
createDirRecursive: AKPostprocDirect::createDirRecursive() in restore.php
createDirRecursive: AKAbstractPostproc::createDirRecursive() in restore.php

Recursively creates a directory if it doesn't exist
createDirRecursive: AKPostprocFTP::createDirRecursive() in restore.php

top

$databaseRoot: AKAbstractPart::$databaseRoot in restore.php
$dataReadLength: AKAbstractUnarchiver::$dataReadLength in restore.php
$dir: AKPostprocFTP::$dir in restore.php
decode: Akeeba_Services_JSON::decode() in restore.php

decodes a JSON string into appropriate variable
detach: AKAbstractPart::detach() in restore.php

Dettaches an observer object
DS: DS in restore.php
dumpLanguage: AKText::dumpLanguage() in restore.php

top

$expectDataDescriptor: AKUnarchiverZIP::$expectDataDescriptor in restore.php
encode: Akeeba_Services_JSON::encode() in restore.php

encodes an arbitrary variable into JSON format
enforce_min_exec_time: AKCoreTimer::enforce_min_exec_time() in restore.php

Enforce the minimum execution time

top

$fileHeader: AKAbstractUnarchiver::$fileHeader in restore.php
$filename: AKAbstractUnarchiver::$filename in restore.php
$filename: AKAbstractPostproc::$filename in restore.php
$filesProcessed: RestorationObserver::$filesProcessed in restore.php
$flagRestorePermissions: AKAbstractUnarchiver::$flagRestorePermissions in restore.php
$fp: AKAbstractUnarchiver::$fp in restore.php
fnmatch: fnmatch() in restore.php
fread: AKAbstractUnarchiver::fread() in restore.php

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

top

get: AKFactory::get() in restore.php
getBrowserLanguage: AKText::getBrowserLanguage() in restore.php
getClassInstance: AKFactory::getClassInstance() in restore.php

Internal function which instanciates a class named $class_name.
getDomain: AKAbstractPart::getDomain() in restore.php
getError: AKAbstractObject::getError() in restore.php

Get the most recent error message
getErrors: AKAbstractObject::getErrors() in restore.php

Return all errors, if any
getFiles: AKUtilsLister::getFiles() in restore.php
getFolders: AKUtilsLister::getFolders() in restore.php
getInstance: AKFactory::getInstance() in restore.php

Gets a single, internally used instance of the Factory
getInstance: AKText::getInstance() in restore.php

Singleton pattern for Language
getPostProc: AKFactory::getPostProc() in restore.php

Gets the post processing engine
getQueryParam: getQueryParam() in restore.php

Gets a query parameter from GET or POST data
getRunningTime: AKCoreTimer::getRunningTime() in restore.php

Gets the time elapsed since object creation/unserialization, effectively how
getState: AKAbstractPart::getState() in restore.php

Returns the state of this engine part.
getStatusArray: AKAbstractPart::getStatusArray() in restore.php

Returns a copy of the class's status array
getStep: AKAbstractPart::getStep() in restore.php
getSubstep: AKAbstractPart::getSubstep() in restore.php
getTimeLeft: AKCoreTimer::getTimeLeft() in restore.php

Gets the number of seconds left, before we hit the "must break" threshold
getTimer: AKFactory::getTimer() in restore.php

Get the a reference to the Akeeba Engine's timer
getUnarchiver: AKFactory::getUnarchiver() in restore.php

Gets the unarchiver engine
getWarning: AKAbstractObject::getWarning() in restore.php

Get the most recent warning message
getWarnings: AKAbstractObject::getWarnings() in restore.php

Return all warnings, if any

top

$hasRan: AKAbstractPart::$hasRan in restore.php

Indicates whether this part has finished its run cycle
$host: AKPostprocFTP::$host in restore.php

top

$isFinished: AKAbstractPart::$isFinished in restore.php

Indicates whether this part has finished its finalization cycle
$isPrepared: AKAbstractPart::$isPrepared in restore.php

Indicates whether this part has finished its initialisation cycle
$isRunning: AKAbstractPart::$isRunning in restore.php

Indicates whether this part has more work to do (it's in running state)
isEOF: AKAbstractUnarchiver::isEOF() in restore.php

Returns true if we have reached the end of file
isError: Akeeba_Services_JSON::isError() in restore.php

top

json_decode: json_decode() in restore.php
json_encode: json_encode() in restore.php
JSON_FORCE_OBJECT: JSON_FORCE_OBJECT in restore.php

Converts to and from JSON format.

top

KeyExpansion: AKEncryptionAES::KeyExpansion() in restore.php

Key expansion for Rijndael Cipher(): performs key expansion on cipher key to generate a key schedule

top

masterSetup: masterSetup() in restore.php

The Master Setup will read the configuration parameters from restoration.php, abiautomation.ini, or the JSON-encoded "configuration" input variable and return the status.
MixColumns: AKEncryptionAES::MixColumns() in restore.php

top

nextFile: AKAbstractUnarchiver::nextFile() in restore.php

Opens the next part file for reading
notify: AKAbstractPart::notify() in restore.php

Notifies observers each time something interesting happened to the part
nuke: AKFactory::nuke() in restore.php

Reset the internal factory state, freeing all previously created objects

top

$observers: AKAbstractPart::$observers in restore.php

top

$pass: AKPostprocFTP::$pass in restore.php
$passive: AKPostprocFTP::$passive in restore.php
$passwords: AKEncryptionAES::$passwords in restore.php
$perms: AKAbstractPostproc::$perms in restore.php
$port: AKPostprocFTP::$port in restore.php
$postProcEngine: AKAbstractUnarchiver::$postProcEngine in restore.php
parse_ini_file: AKText::parse_ini_file() in restore.php

A PHP based INI file parser.
process: AKPostprocFTP::process() in restore.php
process: AKPostprocDirect::process() in restore.php
process: AKAbstractPostproc::process() in restore.php

Processes the current file, e.g. moves it from temp to final location by FTP
processFileData: AKUnarchiverJPA::processFileData() in restore.php

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.
processFileData: AKUnarchiverJPS::processFileData() in restore.php

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.
processFileData: AKAbstractUnarchiver::processFileData() in restore.php

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.
processFilename: AKPostprocFTP::processFilename() in restore.php
processFilename: AKPostprocDirect::processFilename() in restore.php
processFilename: AKAbstractPostproc::processFilename() in restore.php

The unarchiver tells us the path to the filename it wants to extract and we give it a different path instead.
propagateFromObject: AKAbstractObject::propagateFromObject() in restore.php

Propagates errors and warnings from a foreign object. Each propagated list is then cleared on the foreign object, as long as it implements resetErrors() and/or resetWarnings() methods.
propagateToObject: AKAbstractObject::propagateToObject() in restore.php

Propagates errors and warnings to a foreign object. The foreign object SHOULD implement the setError() and/or setWarning() methods but DOESN'T HAVE TO be of AKAbstractObject type. For example, this can even be used to propagate to a JObject instance in Joomla!. Propagated items will be removed from ourself.

top

$Rcon: AKEncryptionAES::$Rcon in restore.php
$renameDirs: AKAbstractUnarchiver::$renameDirs in restore.php
$renameFiles: AKAbstractUnarchiver::$renameFiles in restore.php
$runState: AKAbstractUnarchiver::$runState in restore.php
restore.php: restore.php in restore.php
readArchiveHeader: AKUnarchiverJPA::readArchiveHeader() in restore.php
readArchiveHeader: AKUnarchiverJPS::readArchiveHeader() in restore.php
readArchiveHeader: AKAbstractUnarchiver::readArchiveHeader() in restore.php

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.
readArchiveHeader: AKUnarchiverZIP::readArchiveHeader() in restore.php
readFileHeader: AKUnarchiverZIP::readFileHeader() in restore.php

Concrete classes must use this method to read the file header
readFileHeader: AKUnarchiverJPA::readFileHeader() in restore.php

Concrete classes must use this method to read the file header
readFileHeader: AKUnarchiverJPS::readFileHeader() in restore.php

Concrete classes must use this method to read the file header
readFileHeader: AKAbstractUnarchiver::readFileHeader() in restore.php

Concrete classes must use this method to read the file header
recursive_remove_directory: recursive_remove_directory() in restore.php
rename: AKPostprocFTP::rename() in restore.php
rename: AKPostprocDirect::rename() in restore.php
rename: AKAbstractPostproc::rename() in restore.php
resetErrors: AKAbstractObject::resetErrors() in restore.php

Resets all error messages
resetTime: AKCoreTimer::resetTime() in restore.php

Reset the timer. It should only be used in CLI mode!
resetTranslation: AKText::resetTranslation() in restore.php
resetWarnings: AKAbstractObject::resetWarnings() in restore.php

Resets all warning messages
RestorationObserver: RestorationObserver in restore.php

Descendants of this class can be used in the unarchiver's observer methods (attach, detach and notify)
rmdir: AKPostprocFTP::rmdir() in restore.php
rmdir: AKAbstractPostproc::rmdir() in restore.php
rmdir: AKPostprocDirect::rmdir() in restore.php
RotWord: AKEncryptionAES::RotWord() in restore.php

top

$Sbox: AKEncryptionAES::$Sbox in restore.php
$skipFiles: AKAbstractUnarchiver::$skipFiles in restore.php
serialize: AKFactory::serialize() in restore.php

Gets a serialized snapshot of the Factory for safekeeping (hibernate)
SERVICES_JSON_IN_ARR: SERVICES_JSON_IN_ARR in restore.php

Marker constant for Services_JSON::decode(), used to flag stack state
SERVICES_JSON_IN_CMT: SERVICES_JSON_IN_CMT in restore.php

Marker constant for Services_JSON::decode(), used to flag stack state
SERVICES_JSON_IN_OBJ: SERVICES_JSON_IN_OBJ in restore.php

Marker constant for Services_JSON::decode(), used to flag stack state
SERVICES_JSON_IN_STR: SERVICES_JSON_IN_STR in restore.php

Marker constant for Services_JSON::decode(), used to flag stack state
SERVICES_JSON_LOOSE_TYPE: SERVICES_JSON_LOOSE_TYPE in restore.php

Behavior switch for Services_JSON::decode()
SERVICES_JSON_SLICE: SERVICES_JSON_SLICE in restore.php

Marker constant for Services_JSON::decode(), used to flag stack state
SERVICES_JSON_SUPPRESS_ERRORS: SERVICES_JSON_SUPPRESS_ERRORS in restore.php

Behavior switch for Services_JSON::decode()
set: AKFactory::set() in restore.php
setBreakFlag: AKAbstractPart::setBreakFlag() in restore.php

Sets the BREAKFLAG, which instructs this engine part that the current step must break immediately, in fear of timing out.
setCorrectPermissions: AKAbstractUnarchiver::setCorrectPermissions() in restore.php

Tries to make a directory user-writable so that we can write a file to it
setDomain: AKAbstractPart::setDomain() in restore.php
setError: AKAbstractObject::setError() in restore.php

Add an error message
setErrorsQueueSize: AKAbstractObject::setErrorsQueueSize() in restore.php

Sets the size of the error queue (acts like a LIFO buffer)
setState: AKAbstractPart::setState() in restore.php

Sets the engine part's internal state, in an easy to use manner
setStep: AKAbstractPart::setStep() in restore.php
setSubstep: AKAbstractPart::setSubstep() in restore.php
setup: AKAbstractPart::setup() in restore.php

Sends any kind of setup information to the engine part. Using this,
setWarning: AKAbstractObject::setWarning() in restore.php

Add an error message
setWarningsQueueSize: AKAbstractObject::setWarningsQueueSize() in restore.php

Sets the size of the warnings queue (acts like a LIFO buffer)
ShiftRows: AKEncryptionAES::ShiftRows() in restore.php
shutdown: AKAbstractUnarchiver::shutdown() in restore.php

Sleep function, called whenever the class is serialized
sprintf: AKText::sprintf() in restore.php
SubBytes: AKEncryptionAES::SubBytes() in restore.php
SubWord: AKEncryptionAES::SubWord() in restore.php

top

$tempFilename: AKAbstractPostproc::$tempFilename in restore.php
$timestamp: AKAbstractPostproc::$timestamp in restore.php
$totalSize: AKAbstractUnarchiver::$totalSize in restore.php
tick: AKAbstractPart::tick() in restore.php

The public interface to an engine part. This method takes care for calling the correct method in order to perform the initialisation - run - finalisation cycle of operation and return a proper reponse array.

top

$uncompressedTotal: RestorationObserver::$uncompressedTotal in restore.php
$user: AKPostprocFTP::$user in restore.php
$useSSL: AKPostprocFTP::$useSSL in restore.php
unlink: AKPostprocFTP::unlink() in restore.php
unlink: AKPostprocDirect::unlink() in restore.php
unlink: AKAbstractPostproc::unlink() in restore.php
unserialize: AKFactory::unserialize() in restore.php

Regenerates the full Factory state from a serialized snapshot (resume)
update: RestorationObserver::update() in restore.php
update: AKAbstractPartObserver::update() in restore.php
urs: AKEncryptionAES::urs() in restore.php