Référence de la classe AKAbstractObject

Graphe d'héritage de AKAbstractObject:

Fonctions membres publiques
	getError ($i=null)
	getErrors ()
	resetErrors ()
	getWarning ($i=null)
	getWarnings ()
	resetWarnings ()
	propagateToObject (&$object)
	propagateFromObject (&$object)
	setError ($error)
	setWarning ($warning)

Fonctions membres protégées
	setErrorsQueueSize ($newSize=0)
	setWarningsQueueSize ($newSize=0)

Attributs protégés
	$_errors_queue_size = 0
	$_warnings_queue_size = 0

Fonctions membres privées
	getItemFromArray ($array, $i=null)

Attributs privés
	$_errors = array()
	$_warnings = array()

Description détaillée

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

Documentation des fonctions membres

getError()

getError

(

$i = null

)

Get the most recent error message

Paramètres

integer

$i

Optional error index

Renvoie

string Error message

Références $i, et getItemFromArray().

Référencé par AKAbstractPart\_makeReturnTable(), AKAbstractUnarchiver\_prepare(), AKAbstractUnarchiver\_run(), et AKAbstractPart\getState().

getErrors()

getErrors

(

)

Return all errors, if any

Renvoie

array Array of error messages

Références $_errors.

getItemFromArray()

getItemFromArray (   $array,   $i = null  )

private

Returns the last item of a LIFO string message queue, or a specific item if so specified.

Paramètres

array	$array	An array of strings, holding messages
int	$i	Optional message index

Renvoie

mixed The message string, or false if the key doesn't exist

Références $i, $item, et null.

Référencé par getError(), et getWarning().

getWarning()

getWarning

(

$i = null

)

Get the most recent warning message

Paramètres

integer

$i

Optional warning index

Renvoie

string Error message

Références $i, et getItemFromArray().

getWarnings()

getWarnings

(

)

Return all warnings, if any

Renvoie

array Array of error messages

Références $_warnings.

Référencé par AKAbstractPart\_makeReturnTable().

propagateFromObject()

propagateFromObject

(

&

$object

)

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.

Paramètres

object

$object

The object to propagate errors and warnings from

Références setError(), et setWarning().

Référencé par AKAbstractUnarchiver\_run().

propagateToObject()

propagateToObject

(

&

$object

)

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 ourselves.

Paramètres

object

$object

The object to propagate errors and warnings to.

resetErrors()

resetErrors

(

)

Resets all error messages

resetWarnings()

resetWarnings

(

)

Resets all warning messages

setError()

setError

(

$error

)

Add an error message

Paramètres

string

$error

Error message

Référencé par AKPostprocDirect\createDirRecursive(), AKAbstractUnarchiver\nextFile(), propagateFromObject(), AKUnarchiverJPA\readArchiveHeader(), AKUnarchiverZIP\readArchiveHeader(), AKUnarchiverZIP\readFileHeader(), et AKAbstractPart\setState().

setErrorsQueueSize()

setErrorsQueueSize (   $newSize = 0 )

protected

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

Paramètres

int

$newSize

The new queue size. Set to 0 for infinite length.

setWarning()

setWarning

(

$warning

)

Add an error message

Paramètres

string

$error

Error message

Référencé par AKUtilsLister\getFiles(), AKUtilsLister\getFolders(), et propagateFromObject().

setWarningsQueueSize()

setWarningsQueueSize (   $newSize = 0 )

protected

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

Paramètres

int

$newSize

The new queue size. Set to 0 for infinite length.

Documentation des champs

$_errors

$_errors = array()

private

Référencé par getErrors().

$_errors_queue_size

$_errors_queue_size = 0

protected

$_warnings

$_warnings = array()

private

Référencé par getWarnings().

$_warnings_queue_size

$_warnings_queue_size = 0

protected

---

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

• restore.php