includes/logging/LogEntryBase.php

   1 <?php
   2 /**
   3  * Contains a class for dealing with individual log entries
   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 Niklas Laxström
  22  * @license GPL-2.0-or-later
  23  * @since 1.19
  24  */
  25
  26 /**
  27  * Extends the LogEntry Interface with some basic functionality
  28  *
  29  * @since 1.19
  30  */
  31 abstract class LogEntryBase implements LogEntry {
  32
  33         public function getFullType() {
  34                 return $this->getType() . '/' . $this->getSubtype();
  35         }
  36
  37         public function isDeleted( $field ) {
  38                 return ( $this->getDeleted() & $field ) === $field;
  39         }
  40
  41         /**
  42          * Whether the parameters for this log are stored in new or
  43          * old format.
  44          *
  45          * @return bool
  46          */
  47         public function isLegacy() {
  48                 return false;
  49         }
  50
  51         /**
  52          * Create a blob from a parameter array
  53          *
  54          * @since 1.26
  55          * @param array $params
  56          * @return string
  57          */
  58         public static function makeParamBlob( $params ) {
  59                 return serialize( (array)$params );
  60         }
  61
  62         /**
  63          * Extract a parameter array from a blob
  64          *
  65          * @since 1.26
  66          * @param string $blob
  67          * @return array|false
  68          */
  69         public static function extractParams( $blob ) {
  70                 return unserialize( $blob );
  71         }
  72 }