[akeebabackup] element index

Package indexes

All elements
a c d e f g h i j k l m n o p r s t u v w _
_
top
$_errors
$_errors_queue_size
$_parametersArray
Any configuration variables, in the form of an array.
$_warnings
$_warnings_queue_size
_
AKText::_() in restore.php
_AKEEBA_IS_WINDOWS
_AKEEBA_IS_WINDOWS in restore.php
_AKEEBA_RESTORATION
_AKEEBA_RESTORATION in restore.php
Akeeba Restore A JSON-powered JPA, JPS and ZIP archive extraction library
_finalize
_finalize
Runs the finalisation process for this part. Should set _isFinished to true.
_makeReturnTable
Constructs a Response Array based on the engine part's state.
_prepare
Runs the preparation for this part. Should set _isPrepared
_prepare
Implements the abstract _prepare() method
_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.
_run
__construct
__construct
AKText::__construct() in restore.php
__construct
__construct
Private constructor makes sure we can't directly instanciate the class
__construct
Public constructor
__construct
Public constructor, makes sure we are instanciated only by the factory class
__construct
Public constructor, creates the timer object and calculates the execution time limits
__toString
__wakeup
__wakeup
Wakeup function, called whenever the class is unserialized
__wakeup
Wake-up function to reset internal timer when we get unserialized
a
top
$active_domain
The name of the engine part (a.k.a. Domain), used in return table generation.
$active_step
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
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
$archiveHeaderData
$archiveHeaderData
$archiveList
AddRoundKey
AESDecryptCBC
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
Decrypt a text encrypted by AES in counter mode of operation
AESEncryptCtr
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
constructs a new JSON instance
Akeeba_Services_JSON
Akeeba_Services_JSON in restore.php
Converts to and from JSON format.
Akeeba_Services_JSON_Error
Akeeba_Services_JSON_Error
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
Attaches an observer object
c
top
$chunkSize
$compressedTotal
$currentPartNumber
$currentPartOffset
chmod
chmod
AKPostprocFTP::chmod() in restore.php
chmod
Cipher
AES Cipher function: encrypt 'input' with Rijndael algorithm
close
AKPostprocFTP::close() in restore.php
connect
createDirectory
Creates the directory this file points to
createDirectory
Creates the directory this file points to
createDirRecursive
createDirRecursive
Recursively creates a directory if it doesn't exist
createDirRecursive
d
top
$databaseRoot
$dataReadLength
$default_translation
The default (en_GB) translation used when no other translation is available
$dir
AKPostprocFTP::$dir in restore.php
decode
decodes a JSON string into appropriate variable
detach
Dettaches an observer object
DS
DS in restore.php
dumpLanguage
AKText::dumpLanguage() in restore.php
e
top
$expectDataDescriptor
encode
encodes an arbitrary variable into JSON format
enforce_min_exec_time
Enforce the minimum execution time
f
top
$fileHeader
$filename
$filename
$filesProcessed
$flagRestorePermissions
$fp
fixPermissions
fnmatch
fnmatch() in restore.php
fread
Reads data from the archive and notifies the observer with the 'reading' message
g
top
get
AKFactory::get() in restore.php
getBaseExtension
Returns the base extension of the file, e.g. '.jpa'
getBrowserLanguage
getClassInstance
Internal function which instanciates a class named $class_name.
getDomain
getError
Get the most recent error message
getErrors
Return all errors, if any
getFiles
getFolders
getInstance
Gets a single, internally used instance of the Factory
getInstance
AKText::getInstance() in restore.php
Singleton pattern for Language
getItemFromArray
Returns the last item of a LIFO string message queue, or a specific item if so specified.
getPostProc
Gets the post processing engine
getQueryParam
getQueryParam() in restore.php
Gets a query parameter from GET or POST data
getRunningTime
Gets the time elapsed since object creation/unserialization, effectively how
getState
Returns the state of this engine part.
getStatusArray
Returns a copy of the class's status array
getStep
getSubstep
getTimeLeft
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
Gets the unarchiver engine
getWarning
Get the most recent warning message
getWarnings
Return all warnings, if any
h
top
$handle
AKPostprocFTP::$handle in restore.php
$hasRan
Indicates whether this part has finished its run cycle
$host
AKPostprocFTP::$host in restore.php
i
top
$isFinished
Indicates whether this part has finished its finalization cycle
$isPrepared
Indicates whether this part has finished its initialisation cycle
$isRunning
Indicates whether this part has more work to do (it's in running state)
isDirWritable
isEOF
Returns true if we have reached the end of file
isError
is_dir
j
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.
k
top
KeyExpansion
Key expansion for Rijndael Cipher(): performs key expansion on cipher key to generate a key schedule
l
top
$language
AKText::$language in restore.php
The currently detected language (ISO code)
loadTranslation
m
top
$max_exec_time
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.
microtime_float
Returns the current timestampt in decimal seconds
MixColumns
n
top
name_value
array-walking function for use in generating JSON-formatted name-value pairs
nextFile
Opens the next part file for reading
notify
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
o
top
$objectlist
AKFactory::$objectlist in restore.php
$observers
p
top
$pass
AKPostprocFTP::$pass in restore.php
$passive
$password
$passwords
$perms
$port
AKPostprocFTP::$port in restore.php
$postProcEngine
parse_ini_file
A PHP based INI file parser.
process
process
Processes the current file, e.g. moves it from temp to final location by FTP
process
processFileData
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
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
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
The unarchiver tells us the path to the filename it wants to extract and we give it a different path instead.
processFilename
processFilename
processTypeDir
Process the file data of a directory entry
processTypeDir
Process the file data of a directory entry
processTypeFileCompressedSimple
processTypeFileCompressedSimple
processTypeFileUncompressed
processTypeFileUncompressed
processTypeLink
Process the file data of a link entry
processTypeLink
Process the file data of a link entry
propagateFromObject
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
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.
r
top
$Rcon
AKEncryptionAES::$Rcon in restore.php
$renameDirs
$renameFiles
$runState
restore.php
restore.php in restore.php
readArchiveHeader
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
readArchiveHeader
readArchiveHeader
readFileHeader
Concrete classes must use this method to read the file header
readFileHeader
Concrete classes must use this method to read the file header
readFileHeader
Concrete classes must use this method to read the file header
readFileHeader
Concrete classes must use this method to read the file header
recursive_remove_directory
reduce_string
reduce a string by removing leading and trailing comments and whitespace
rename
rename
rename
resetErrors
Resets all error messages
resetTime
Reset the timer. It should only be used in CLI mode!
resetTranslation
resetWarnings
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
rmdir
AKPostprocFTP::rmdir() in restore.php
rmdir
RotWord
s
top
$Sbox
AKEncryptionAES::$Sbox in restore.php
$skipFiles
$start_time
$strings
AKText::$strings in restore.php
The array holding the translation keys
scanArchives
Scans for archive parts
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
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
Behavior switch for Services_JSON::decode()
set
AKFactory::set() in restore.php
setBreakFlag
Sets the BREAKFLAG, which instructs this engine part that the current step must break immediately, in fear of timing out.
setCorrectPermissions
Tries to make a directory user-writable so that we can write a file to it
setDomain
setError
Add an error message
setErrorsQueueSize
Sets the size of the error queue (acts like a LIFO buffer)
setState
Sets the engine part's internal state, in an easy to use manner
setStep
setSubstep
setup
Sends any kind of setup information to the engine part. Using this,
setWarning
Add an error message
setWarningsQueueSize
Sets the size of the warnings queue (acts like a LIFO buffer)
ShiftRows
shutdown
Sleep function, called whenever the class is serialized
sprintf
AKText::sprintf() in restore.php
SubBytes
SubWord
t
top
$tempDir
$tempFilename
$timestamp
$totalSize
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.
u
top
$uncompressedTotal
$user
AKPostprocFTP::$user in restore.php
$useSSL
AKPostprocFTP::$useSSL in restore.php
unlink
unlink
unlink
unserialize
Regenerates the full Factory state from a serialized snapshot (resume)
update
update
urs
AKEncryptionAES::urs() in restore.php
utf82utf16
convert a string from one UTF-8 char to one UTF-16 char
utf162utf8
convert a string from one UTF-16 char to one UTF-8 char
v
top
$varlist
AKFactory::$varlist in restore.php
w
top
$warnings_pointer
a c d e f g h i j k l m n o p r s t u v w _