includes/logging/TagLogFormatter.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  */
  18
  19 /**
  20  * This class formats tag log entries.
  21  *
  22  * Parameters (one-based indexes):
  23  * 4::revid
  24  * 5::logid
  25  * 6:list:tagsAdded
  26  * 7:number:tagsAddedCount
  27  * 8:list:tagsRemoved
  28  * 9:number:tagsRemovedCount
  29  *
  30  * @since 1.25
  31  */
  32 class TagLogFormatter extends LogFormatter {
  33         protected function getMessageKey() {
  34                 $key = parent::getMessageKey();
  35                 $params = $this->getMessageParameters();
  36
  37                 $add = ( isset( $params[6] ) && isset( $params[6]['num'] ) && $params[6]['num'] );
  38                 $remove = ( isset( $params[8] ) && isset( $params[8]['num'] ) && $params[8]['num'] );
  39                 $key .= ( $remove ? ( $add ? '' : '-remove' ) : '-add' );
  40
  41                 if ( isset( $params[3] ) && $params[3] ) {
  42                         // Messages: logentry-tag-update-add-revision, logentry-tag-update-remove-revision,
  43                         // logentry-tag-update-revision
  44                         $key .= '-revision';
  45                 } else {
  46                         // Messages: logentry-tag-update-add-logentry, logentry-tag-update-remove-logentry,
  47                         // logentry-tag-update-logentry
  48                         $key .= '-logentry';
  49                 }
  50
  51                 return $key;
  52         }
  53 }