Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe AKAbstractPart
+ Graphe d'héritage de AKAbstractPart:

Fonctions membres publiques

 tick ()
 
 getState ()
 
 getStatusArray ()
 
 setup ($parametersArray)
 
 getDomain ()
 
 getStep ()
 
 getSubstep ()
 
 attach (AKAbstractPartObserver $obs)
 
 detach (AKAbstractPartObserver $obs)
 
- Fonctions membres publiques hérités de AKAbstractObject
 __construct ()
 
 getError ($i=null)
 
 getErrors ()
 
 resetErrors ()
 
 getWarning ($i=null)
 
 getWarnings ()
 
 resetWarnings ()
 
 propagateToObject (&$object)
 
 propagateFromObject (&$object)
 
 setError ($error)
 
 setWarning ($warning)
 

Fonctions membres protégées

 _prepare ()
 
 _run ()
 
 _finalize ()
 
 _makeReturnTable ()
 
 setState ($state='init', $errorMessage='Invalid setState argument')
 
 setBreakFlag ()
 
 setDomain ($new_domain)
 
 setStep ($new_step)
 
 setSubstep ($new_substep)
 
 notify ($message)
 
- Fonctions membres protégées hérités de AKAbstractObject
 setErrorsQueueSize ($newSize=0)
 
 setWarningsQueueSize ($newSize=0)
 

Attributs protégés

 $isPrepared = false
 
 $isRunning = false
 
 $isFinished = false
 
 $hasRan = false
 
 $active_domain = ""
 
 $active_step = ""
 
 $active_substep = ""
 
 $_parametersArray = array()
 
 $databaseRoot = array()
 
 $observers = array()
 
- Attributs protégés hérités de AKAbstractObject
 $_errors_queue_size = 0
 
 $_warnings_queue_size = 0
 

Attributs privés

 $warnings_pointer = -1
 

Description détaillée

The superclass of all Akeeba Kickstart parts. The "parts" are intelligent stateful classes which perform a single procedure and have preparation, running and finalization phases. The transition between phases is handled automatically by this superclass' tick() final public method, which should be the ONLY public API exposed to the rest of the Akeeba Engine.

Documentation des fonctions membres

◆ _finalize()

_finalize ( )
abstractprotected

Runs the finalisation process for this part. Should set _isFinished to true.

Référencé par tick().

◆ _makeReturnTable()

_makeReturnTable ( )
finalprotected

Constructs a Response Array based on the engine part's state.

Renvoie
array The Response Array for the current state

Références AKAbstractObject\getError(), et AKAbstractObject\getWarnings().

Référencé par getStatusArray(), et tick().

◆ _prepare()

_prepare ( )
abstractprotected

Runs the preparation for this part. Should set _isPrepared to true

Référencé par tick().

◆ _run()

_run ( )
abstractprotected

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.

Référencé par tick().

◆ attach()

attach ( AKAbstractPartObserver  $obs)

Attaches an observer object

Paramètres
AKAbstractPartObserver$obs

◆ detach()

detach ( AKAbstractPartObserver  $obs)

Detaches an observer object

Paramètres
AKAbstractPartObserver$obs

◆ getDomain()

getDomain ( )
final

Références $active_domain.

◆ getState()

getState ( )
final

Returns the state of this engine part.

Renvoie
string The state of this engine part. It can be one of error, init, prepared, running, postrun, finished.

Références AKAbstractObject\getError().

Référencé par AKAbstractUnarchiver\_run(), et tick().

◆ getStatusArray()

getStatusArray ( )

Returns a copy of the class's status array

Renvoie
array

Références _makeReturnTable().

◆ getStep()

getStep ( )
final

Références $active_step.

◆ getSubstep()

getSubstep ( )
final

Références $active_substep.

◆ notify()

notify (   $message)
protected

Notifies observers each time something interesting happened to the part

Paramètres
mixed$messageThe event object

Références $message.

Référencé par AKAbstractUnarchiver\_run(), AKAbstractUnarchiver\fread(), et AKAbstractUnarchiver\scanArchives().

◆ setBreakFlag()

setBreakFlag ( )
protected

Sets the BREAKFLAG, which instructs this engine part that the current step must break immediately, in fear of timing out.

Références AKFactory\set().

◆ setDomain()

setDomain (   $new_domain)
finalprotected

◆ setState()

setState (   $state = 'init',
  $errorMessage = 'Invalid setState argument' 
)
protected

Sets the engine part's internal state, in an easy to use manner

Paramètres
string$stateOne of init, prepared, running, postrun, finished, error
string$errorMessageThe reported error message, should the state be set to error

Références $state, et AKAbstractObject\setError().

Référencé par AKAbstractUnarchiver\_finalize(), AKAbstractUnarchiver\_prepare(), AKAbstractUnarchiver\_run(), AKAbstractUnarchiver\nextFile(), et setup().

◆ setStep()

setStep (   $new_step)
finalprotected

◆ setSubstep()

setSubstep (   $new_substep)
finalprotected

◆ setup()

setup (   $parametersArray)
final

Sends any kind of setup information to the engine part. Using this, we avoid passing parameters to the constructor of the class. These parameters should be passed as an indexed array and should be taken into account during the preparation process only. This function will set the error flag if it's called after the engine part is prepared.

Paramètres
array$parametersArrayThe parameters to be passed to the engine part.

Références setState().

◆ tick()

tick ( )
final

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 response array.

Renvoie
array A Response Array

Références _finalize(), _makeReturnTable(), _prepare(), _run(), et getState().

Documentation des champs

◆ $_parametersArray

$_parametersArray = array()
protected

◆ $active_domain

$active_domain = ""
protected

Référencé par getDomain().

◆ $active_step

$active_step = ""
protected

Référencé par getStep().

◆ $active_substep

$active_substep = ""
protected

Référencé par getSubstep().

◆ $databaseRoot

$databaseRoot = array()
protected

◆ $hasRan

$hasRan = false
protected

◆ $isFinished

$isFinished = false
protected

◆ $isPrepared

$isPrepared = false
protected

◆ $isRunning

$isRunning = false
protected

◆ $observers

$observers = array()
protected

◆ $warnings_pointer

$warnings_pointer = -1
private

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