View source for Manual:Logging to Special:Log/pt

<languages/>
Esta página descreve como registar as ações para <code>[[Special:Log]]</code>.
(Registar para o registo da aplicação está descrito em {{ll|Manual:Structured logging}}.)

<span id="Example"></span>
== Exemplo ==
Isto ilustra como poderia codificar <code>Special:Log</code> entradas para as extensões.
As mensagens de registo aparecem na página <code>[[Special:Log]]</code> e podem ser filtradas por, por exemplo, o nome do registo, título ou intervalo de dada.

<span id="In_your_extension_setup_file"></span>
=== No seu ficheiro de configuração de extensão ===

O seguinte deveria funcionar em <code>{{ll|Manual:Extension registration|extension.json}}</code>:

<syntaxhighlight lang="json">
{
    "LogTypes": [ "foo" ],
    "LogNames": {
        "foo": "foo-name"
    },
    "LogHeaders": {
        "foo": "foo-header"
    },
    "LogActionsHandlers": {
        "foo/*": "LogFormatter"
    }
}
</syntaxhighlight>
{{outdated}}
Para os registos principais, a configuração está em <code>{{ll|Manual:DefaultSettings.php|DefaultSettings.php}}</code>.

<syntaxhighlight lang=php>
$wgLogTypes[] = 'foo';

// You can still set
// $wgLogNames['foo'] = 'foo-name';
// $wgLogHeaders['foo'] = 'foo-header';
// 
// But you don't need to, if you follow this naming convention for your i18n messages:
//
// log-name-foo
//   for the Special:Log log name that appears in the drop-down on the Special:Log page
//
// log-description-foo
//   for the Special:Log description that appears on the Special:Log page when you filter 
//   logs on this specific log name

$wgLogActionsHandlers['foo/bar'] = 'LogFormatter';

// Or if you want catch-all, do:
$wgLogActionsHandlers['foo/*'] = 'LogFormatter';

// Or if you need some extra logic, you can write your own formatter
// (subclassing LogFormatter) and do:
$wgLogActionsHandlers['foo/*'] = 'FooLogFormatter';
</syntaxhighlight>

<span id="In_i18n/en.json_file"></span>
=== No ficheiro i18n/en.json ===
<syntaxhighlight lang=json>
{
	"log-name-foo": "Foo log",
	"log-description-foo": "These events track when Foo events happen in the system.",
	"logentry-foo-bar": "$1 {{GENDER:$2|did bar}} to page $3"
}
</syntaxhighlight>

Documentação de mensagem (qqq.json):

<syntaxhighlight lang=json>
{
	"log-name-foo": "The Special:Log log name that appears in the drop-down on the Special:Log page",
	"log-description-foo": "The Special:Log description that appears on the Special:Log page when you filter logs on this specific log name",
	"logentry-foo-bar": "The template of the log entry message"
}
</syntaxhighlight>

<span id="In_the_extension_code"></span>
=== No código da extensão ===

<syntaxhighlight lang=php>
// Anywhere in your code where you want to generate a log entry

$logEntry = new ManualLogEntry( 'foo', 'bar' ); // Log action 'bar' in the Special:Log for 'foo'
$logEntry->setPerformer( $user ); // User object, the user who performed this action
$logEntry->setTarget( $this ); // The page that this log entry affects, a Title object
$logEntry->setComment( $reason ); // Optional, user provided comment

// Optionally, add additional parameters for use in the log entry’s i18n message.
// Numbering should start from 4 and can be used in the message as $4, $5 and so on.
//
// Indexes $1, $2, and $3 are reserved
// and provide the username and target page parameters for the messages.
// $1 is a reference to the user page and user talk page in the wiki
// $2 is used to determine the gender of the user for any gender specific messages
// $3 is a reference to the page on which the action took place
//
// If you want to store stuff that should not be available in messages, don’t
// prefix the array key with a number and don’t use the colons.
// 
// The format is index:formatspecifier:name.
// Format specifier is currently unused, but in future you could say for example
// that this param is a number, format it according to the user language.
// Name is just for giving identifier for the value, and helps to debug issues
// versus unindexed list of parameters.
$logEntry->setParameters( [
  '4::paramname' => 'customparam',
  'hiddenparam' => 'ugly stuff',
] );

// We're not done yet, we need to insert the log entry into the database.
// Insert adds it to the logging table and returns the id of that log entry.
$logid = $logEntry->insert();

// Optionally, publish the log entry in recent changes and the UDP feed of recent changes
// if we want. UDP feed is mainly used for echoing the recent change items into IRC.
// publish() takes second param with values 'rcandudp' (default), 'rc' and 'udp'.
$logEntry->publish( $logid );
</syntaxhighlight>

<span id="Adding_links"></span>
=== Adicionar hiperligações ===
Para adicionar uma hiperligação às entradas de registo, deveria passar o nome da página, etc..., nos parâmetros de registo, e formatar isso no seu LogFormatter utilizando <code>makePageLink()</code>.
Com outros métodos, saída não html (como fonte UDP para IRC) irá estar com problemas.

Consulte {{git file|project=mediawiki/extensions/Translate|branch=HEAD|file=utils/TranslateLogFormatter.php|text=TranslateLogFormatter}} para um exemplo LogFormatter com hiperligações.

<span id="See_also"></span>
== Ver também ==
* {{ll|Manual:$wgLogTypes}}
* {{ll|Manual:$wgLogActions}}
* {{ll|Manual:$wgLogNames}}
* {{ll|Manual:$wgLogHeaders}}
* {{ll|Manual:$wgLogActionsHandlers}}
* {{ll|Manual:$wgLogRestrictions}}
* {{ll|Manual:$wgFilterLogTypes}}
* {{ll|Manual:$wgActionFilteredLogs}}
* {{phab|T26620}} - As entradas de registo são difíceis de localizar; reescrever o sistema de registos

{{Log events}}

[[Category:Log{{#translation:}}]]
[[Category:Localisation{{#translation:}}]]
[[Category:Recent changes{{#translation:}}]]
[[Category:MediaWiki development{{#translation:}}]]
[[Category:Extension creation{{#translation:}}]]