Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe MessagesCollector
+ Graphe d'héritage de MessagesCollector:

Fonctions membres publiques

 __construct ($name='messages')
 
 setDataFormatter (DataFormatterInterface $formater)
 
 getDataFormatter ()
 
 setVarDumper (DebugBarVarDumper $varDumper)
 
 getVarDumper ()
 
 useHtmlVarDumper ($value=true)
 
 isHtmlVarDumperUsed ()
 
 addMessage ($message, $label='info', $isString=true)
 
 aggregate (MessagesAggregateInterface $messages)
 
 getMessages ()
 
 log ($level, $message, array $context=array())
 
 interpolate ($message, array $context=array())
 
 clear ()
 
 collect ()
 
 getName ()
 
 getAssets ()
 
 getWidgets ()
 
- Fonctions membres publiques hérités de AbstractLogger
 emergency ($message, array $context=array())
 
 alert ($message, array $context=array())
 
 critical ($message, array $context=array())
 
 error ($message, array $context=array())
 
 warning ($message, array $context=array())
 
 notice ($message, array $context=array())
 
 info ($message, array $context=array())
 
 debug ($message, array $context=array())
 

Attributs protégés

 $name
 
 $messages = array()
 
 $aggregates = array()
 
 $dataFormater
 
 $varDumper
 
 $useHtmlVarDumper = false
 

Description détaillée

Provides a way to log messages

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $name = 'messages')
Paramètres
string$name

Références MessagesCollector\$name, et name.

Documentation des fonctions membres

◆ addMessage()

addMessage (   $message,
  $label = 'info',
  $isString = true 
)

Adds a message

A message can be anything from an object to a string

Paramètres
mixed$message
string$label

Références $label, $message, MessagesCollector\getDataFormatter(), MessagesCollector\getVarDumper(), MessagesCollector\isHtmlVarDumperUsed(), et null.

Référencé par SwiftLogCollector\add(), MessagesCollector\log(), et SlimCollector\write().

◆ aggregate()

aggregate ( MessagesAggregateInterface  $messages)

Aggregates messages from other collectors

Paramètres
MessagesAggregateInterface$messages

Références MessagesCollector\$messages.

◆ clear()

clear ( )

Deletes all messages

◆ collect()

collect ( )

◆ getAssets()

getAssets ( )

◆ getDataFormatter()

getDataFormatter ( )
Renvoie
DataFormatterInterface

Références MessagesCollector\$dataFormater, DataCollector\getDefaultDataFormatter(), et null.

Référencé par MessagesCollector\addMessage().

◆ getMessages()

getMessages ( )
Renvoie
array

Implémente MessagesAggregateInterface.

Références $b, et MessagesCollector\$messages.

Référencé par MessagesCollector\collect().

◆ getName()

getName ( )
Renvoie
string

Implémente DataCollectorInterface.

Références MessagesCollector\$name.

Référencé par MessagesCollector\getWidgets().

◆ getVarDumper()

getVarDumper ( )

Gets the variable dumper instance used by this collector

Renvoie
DebugBarVarDumper

Références MessagesCollector\$varDumper, DataCollector\getDefaultVarDumper(), et null.

Référencé par MessagesCollector\addMessage(), et MessagesCollector\getAssets().

◆ getWidgets()

getWidgets ( )
Renvoie
array

Implémente Renderable.

Références MessagesCollector\$name, et MessagesCollector\getName().

◆ interpolate()

interpolate (   $message,
array  $context = array() 
)

Interpolates context values into the message placeholders.

Paramètres
$message
array$context
Renvoie
string

Références $context, $key, $message, et $val.

Référencé par MessagesCollector\log().

◆ isHtmlVarDumperUsed()

isHtmlVarDumperUsed ( )

Indicates whether the Symfony HtmlDumper will be used to dump variables for rich variable rendering.

Renvoie
mixed

Références MessagesCollector\$useHtmlVarDumper.

Référencé par MessagesCollector\addMessage(), et MessagesCollector\getAssets().

◆ log()

log (   $level,
  $message,
array  $context = array() 
)
Paramètres
$level
$message
array$context

Implémente LoggerInterface.

Références $context, $message, MessagesCollector\addMessage(), et MessagesCollector\interpolate().

◆ setDataFormatter()

setDataFormatter ( DataFormatterInterface  $formater)

Sets the data formater instance used by this collector

Paramètres
DataFormatterInterface$formater
Renvoie
$this

Références $this.

◆ setVarDumper()

setVarDumper ( DebugBarVarDumper  $varDumper)

Sets the variable dumper instance used by this collector

Paramètres
DebugBarVarDumper$varDumper
Renvoie
$this

Références $this, et MessagesCollector\$varDumper.

◆ useHtmlVarDumper()

useHtmlVarDumper (   $value = true)

Sets a flag indicating whether the Symfony HtmlDumper will be used to dump variables for rich variable rendering. Be sure to set this flag before logging any messages for the first time.

Paramètres
bool$value
Renvoie
$this

Références $this, et $value.

Documentation des champs

◆ $aggregates

$aggregates = array()
protected

◆ $dataFormater

$dataFormater
protected

◆ $messages

◆ $name

◆ $useHtmlVarDumper

◆ $varDumper

$varDumper
protected

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