Référence de la classe SiteStatus

Graphe d'héritage de SiteStatus:

Fonctions membres publiques
	__construct (DispatcherInterface $dispatcher, array $config, array $oldConfig, string $configFile)
	alterSiteStatus (ExecuteTaskEvent $event)
Fonctions membres publiques hérités de CMSPlugin
	__construct (&$subject, $config=array())
	loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
	setApplication (CMSApplicationInterface $application)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de PluginInterface
	registerListeners ()

Fonctions membres publiques statiques
static	getSubscribedEvents ()

Attributs protégés
const	TASKS_MAP
	$autoloadLanguage = true
Attributs protégés hérités de CMSPlugin
	$_name = null
	$_type = null
	$autoloadLanguage = false
	$allowLegacyListeners = true

Fonctions membres privées
	writeConfigFile (Registry $config)

Attributs privés
	$oldConfig
	$configFile

Membres hérités additionnels
Champs de données hérités de CMSPlugin
	$params = null
Fonctions membres protégées hérités de CMSPlugin
	registerLegacyListener (string $methodName)
	registerListener (string $methodName)
	getApplication ()

Description détaillée

Task plugin with routines to change the offline status of the site. These routines can be used to control planned maintenance periods and related operations.

Depuis

4.1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	DispatcherInterface	$dispatcher,
		array	$config,
		array	$oldConfig,
		string	$configFile
	)

Constructor.

Paramètres

DispatcherInterface	$dispatcher	The dispatcher
array	$config	An optional associative array of configuration settings
array	$oldConfig	The old config
string	$configFile	The config

Depuis

4.2.0

Références $config, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

alterSiteStatus()

alterSiteStatus

(

ExecuteTaskEvent

$event

)

Paramètres

ExecuteTaskEvent

$event

The onExecuteTask event

Renvoie

void

Depuis

4.1.0

Exceptions

Exception

Références $config, Joomla\Component\Scheduler\Administrator\Traits\endRoutine(), ExecuteTaskEvent\getRoutineId(), Joomla\Component\Scheduler\Administrator\Traits\logTask(), et Joomla\Component\Scheduler\Administrator\Traits\startRoutine().

getSubscribedEvents()

static getSubscribedEvents ( )

static

Renvoie

string[]

Depuis

4.1.0

Implémente SubscriberInterface.

writeConfigFile()

writeConfigFile ( Registry  $config )

private

Method to write the configuration to a file.

Paramètres

Registry

$config

A Registry object containing all global config data.

Renvoie

integer The task exit code

Depuis

4.1.0

Exceptions

Exception

Références $config, $configuration, Path\isOwner(), Status\KNOCKOUT, Joomla\Component\Scheduler\Administrator\Traits\logTask(), Status\OK, Path\setPermissions(), et File\write().

Documentation des champs

$autoloadLanguage

$autoloadLanguage = true

protected

$configFile

$configFile

private

$oldConfig

$oldConfig

private

TASKS_MAP

const TASKS_MAP

protected

Valeur initiale :

= [
        'plg_task_toggle_offline'             => [
            'langConstPrefix' => 'PLG_TASK_SITE_STATUS'

---

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

• SiteStatus.php