Fix doc for ManualLogEntry::setParameters()
authorBrad Jorsch <bjorsch@wikimedia.org>
Wed, 28 Jan 2015 19:15:13 +0000 (11:15 -0800)
committerBrad Jorsch <bjorsch@wikimedia.org>
Wed, 28 Jan 2015 19:18:41 +0000 (11:18 -0800)
Numbered-and-named parameters are "number:type:name" (where "type" is
often empty), not "number:name".

Change-Id: I417a3d6caf929a94ffed5e315692950295b3be0d

includes/logging/LogEntry.php

index 46c5515..85a3052 100644 (file)
@@ -385,13 +385,14 @@ class ManualLogEntry extends LogEntryBase {
 
        /**
         * Set extra log parameters.
-        * You can pass params to the log action message
-        * by prefixing the keys with a number and colon.
-        * The numbering should start with number 4, the
-        * first three parameters are hardcoded for every
-        * message. Example:
+        *
+        * You can pass params to the log action message by prefixing the keys with
+        * a number and optional type, using colons to separate the fields. The
+        * numbering should start with number 4, the first three parameters are
+        * hardcoded for every message. Example:
         * $entry->setParameters(
-        *   '4:color' => 'blue',
+        *   '4::color' => 'blue',
+        *   '5:number:count' => 3000,
         *   'animal' => 'dog'
         * );
         *