\AKAbstractPostproc

File post processor engines base class

Synopsis

class AKAbstractPostproc extends AKAbstractObject {

• // members
• protected  $filename;
• protected  $perms;
• protected  $tempFilename;
• public  $timestamp;
• // Inherited members from AKAbstractObject
• protected  $_errors_queue_size;
• protected  $_warnings_queue_size;
• // methods
• public abstract void process()
• public abstract string processFilename()
• public abstract void createDirRecursive()
• public abstract void chmod()
• public abstract void unlink()
• public abstract void rmdir()
• public abstract void rename()
• // Inherited methods from AKAbstractObject
• public void __construct()
• public string getError()
• public array getErrors()
• public void setError()
• public void resetErrors()
• public string getWarning()
• public array getWarnings()
• public void setWarning()
• public void resetWarnings()
• public void propagateToObject()
• public void propagateFromObject()
• protected void setErrorsQueueSize()
• protected void setWarningsQueueSize()
}


Hierarchy

Extends

• AKAbstractObject

Extended by

• AKPostprocDirect
• AKPostprocFTP

Members

protected

• $_errors_queue_size — array
• $_warnings_queue_size — array
• $filename — string
• $perms — int
• $tempFilename — string

public

• $timestamp — int

Methods

public

• chmod()
• createDirRecursive() — Recursively creates a directory if it doesn't exist
• process() — Processes the current file, e.g. moves it from temp to final location by FTP
• processFilename() — The unarchiver tells us the path to the filename it wants to extract and we give it a different path instead.
• rename()
• rmdir()
• unlink()

Inherited from AKAbstractObject

protected

• setErrorsQueueSize() — Sets the size of the error queue (acts like a LIFO buffer)
• setWarningsQueueSize() — Sets the size of the warnings queue (acts like a LIFO buffer)

public

• getError() — Get the most recent error message
• getErrors() — Return all errors, if any
• getWarning() — Get the most recent warning message
• getWarnings() — Return all warnings, if any
• 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.
• resetErrors() — Resets all error messages
• resetWarnings() — Resets all warning messages
• setError() — Add an error message
• setWarning() — Add an error message