includes/logging/PatrolLog.php

   1 <?php
   2 /**
   3  * Specific methods for the patrol log.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author Rob Church <robchur@gmail.com>
  22  * @author Niklas Laxström
  23  */
  24
  25 /**
  26  * Class containing static functions for working with
  27  * logs of patrol events
  28  */
  29 class PatrolLog {
  30
  31         /**
  32          * Record a log event for a change being patrolled
  33          *
  34          * @param $rc Mixed: change identifier or RecentChange object
  35          * @param $auto Boolean: was this patrol event automatic?
  36          * @param $user User: user performing the action or null to use $wgUser
  37          *
  38          * @return bool
  39          */
  40         public static function record( $rc, $auto = false, User $user = null ) {
  41                 if ( !$rc instanceof RecentChange ) {
  42                         $rc = RecentChange::newFromId( $rc );
  43                         if ( !is_object( $rc ) ) {
  44                                 return false;
  45                         }
  46                 }
  47
  48                 if ( !$user ) {
  49                         global $wgUser;
  50                         $user = $wgUser;
  51                 }
  52
  53                 $entry = new ManualLogEntry( 'patrol', 'patrol' );
  54                 $entry->setTarget( $rc->getTitle() );
  55                 $entry->setParameters( self::buildParams( $rc, $auto ) );
  56                 $entry->setPerformer( $user );
  57                 $logid = $entry->insert();
  58                 if ( !$auto ) {
  59                         $entry->publish( $logid, 'udp' );
  60                 }
  61                 return true;
  62         }
  63
  64         /**
  65          * Prepare log parameters for a patrolled change
  66          *
  67          * @param $change RecentChange to represent
  68          * @param $auto Boolean: whether the patrol event was automatic
  69          * @return Array
  70          */
  71         private static function buildParams( $change, $auto ) {
  72                 return array(
  73                         '4::curid' => $change->getAttribute( 'rc_this_oldid' ),
  74                         '5::previd' => $change->getAttribute( 'rc_last_oldid' ),
  75                         '6::auto' => (int)$auto
  76                 );
  77         }
  78
  79 }