Docs For Class AKAbstractObject

Description

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

abstract:

Located in /administrator/components/com_joomlaupdate/restore.php (line 907)

Direct descendents

Class	Description
AKAbstractPostproc	File post processor engines base class
AKAbstractPart	The superclass of all Akeeba Kickstart parts. The "parts" are intelligent stateful
AKCoreTimer	Timer class
AKUtilsLister	A filesystem scanner which uses opendir()
AKText	A simple INI-based i18n engine

Variable Summary

array $_errors_queue_size

array $_warnings_queue_size

Method Summary

AKAbstractObject __construct ()

string getError ([integer $i = null])

array getErrors ()

string getWarning ([integer $i = null])

array getWarnings ()

void propagateFromObject ( &$object, object $object)

void propagateToObject ( &$object, object $object)

void resetErrors ()

void resetWarnings ()

void setError (string $error)

void setErrorsQueueSize ([int $newSize = 0])

void setWarning ( $warning, string $error)

void setWarningsQueueSize ([int $newSize = 0])

Variables

array $_errors_queue_size = 0 (line 913)

var: The queue size of the $_errors array. Set to 0 for infinite size.
access: protected

array $_warnings_queue_size = 0 (line 919)

var: The queue size of the $_warnings array. Set to 0 for infinite size.
access: protected

Methods

Constructor __construct (line 924)

Public constructor, makes sure we are instanciated only by the factory class

access: public

AKAbstractObject __construct ()

Redefined in descendants as:

AKPostprocFTP::__construct()
AKAbstractUnarchiver::__construct() : Public constructor
AKUnarchiverJPS::__construct()
AKCoreTimer::__construct() : Public constructor, creates the timer object and calculates the execution time limits
AKText::__construct()

getError (line 949)

Get the most recent error message

return: Error message
access: public

string getError ([integer $i = null])

integer $i: Optional error index

getErrors (line 958)

Return all errors, if any

return: Array of error messages
access: public

array getErrors ()

getWarning (line 992)

Get the most recent warning message

return: Error message
access: public

string getWarning ([integer $i = null])

integer $i: Optional warning index

getWarnings (line 1001)

Return all warnings, if any

return: Array of error messages
access: public

array getWarnings ()

propagateFromObject (line 1074)

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.

access: public

void propagateFromObject ( &$object, object $object)

object $object: The object to propagate errors and warnings from
&$object

propagateToObject (line 1038)

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.

access: public

void propagateToObject ( &$object, object $object)

object $object: The object to propagate errors and warnings to.
&$object

resetErrors (line 982)

Resets all error messages

access: public

void resetErrors ()

resetWarnings (line 1026)

Resets all warning messages

access: public

void resetWarnings ()

setError (line 967)

Add an error message

access: public

void setError (string $error)

string $error: Error message

setErrorsQueueSize (line 1113)

Sets the size of the error queue (acts like a LIFO buffer)

access: protected

void setErrorsQueueSize ([int $newSize = 0])

int $newSize: The new queue size. Set to 0 for infinite length.

setWarning (line 1010)

Add an error message

access: public

void setWarning ( $warning, string $error)

string $error: Error message
$warning

setWarningsQueueSize (line 1122)

Sets the size of the warnings queue (acts like a LIFO buffer)

access: protected

void setWarningsQueueSize ([int $newSize = 0])

int $newSize: The new queue size. Set to 0 for infinite length.