MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
38 abstract class FileJournal {
40  protected $backend;
43  protected $ttlDays;
51  protected function __construct( array $config ) {
52  $this->ttlDays = isset( $config['ttlDays'] ) ? $config['ttlDays'] : false;
53  }
63  final public static function factory( array $config, $backend ) {
64  $class = $config['class'];
65  $jrn = new $class( $config );
66  if ( !$jrn instanceof self ) {
67  throw new InvalidArgumentException( "Class given is not an instance of FileJournal." );
68  }
69  $jrn->backend = $backend;
71  return $jrn;
72  }
79  final public function getTimestampedUUID() {
80  $s = '';
81  for ( $i = 0; $i < 5; $i++ ) {
82  $s .= mt_rand( 0, 2147483647 );
83  }
84  $s = Wikimedia\base_convert( sha1( $s ), 16, 36, 31 );
86  return substr( Wikimedia\base_convert( wfTimestamp( TS_MW ), 10, 36, 9 ) . $s, 0, 31 );
87  }
100  final public function logChangeBatch( array $entries, $batchId ) {
101  if ( !count( $entries ) ) {
102  return StatusValue::newGood();
103  }
105  return $this->doLogChangeBatch( $entries, $batchId );
106  }
115  abstract protected function doLogChangeBatch( array $entries, $batchId );
122  final public function getCurrentPosition() {
123  return $this->doGetCurrentPosition();
124  }
130  abstract protected function doGetCurrentPosition();
138  final public function getPositionAtTime( $time ) {
139  return $this->doGetPositionAtTime( $time );
140  }
147  abstract protected function doGetPositionAtTime( $time );
166  final public function getChangeEntries( $start = null, $limit = 0, &$next = null ) {
167  $entries = $this->doGetChangeEntries( $start, $limit ? $limit + 1 : 0 );
168  if ( $limit && count( $entries ) > $limit ) {
169  $last = array_pop( $entries ); // remove the extra entry
170  $next = $last['id']; // update for next call
171  } else {
172  $next = null; // end of list
173  }
175  return $entries;
176  }
184  abstract protected function doGetChangeEntries( $start, $limit );
191  final public function purgeOldLogs() {
192  return $this->doPurgeOldLogs();
193  }
199  abstract protected function doPurgeOldLogs();
200 }
string $backend
Definition: FileJournal.php:40
the array() calling protocol came about after MediaWiki 1.4rc1.
doGetChangeEntries($start, $limit)
__construct(array $config)
Construct a new instance from configuration.
Definition: FileJournal.php:51
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Get the position ID of the latest journal entry.
getChangeEntries($start=null, $limit=0, &$next=null)
Get an array of file change log entries.
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Definition: defines.php:11
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
logChangeBatch(array $entries, $batchId)
Log changes made by a batch file operation.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
doLogChangeBatch(array $entries, $batchId)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1046
Get a statistically unique ID string.
Definition: FileJournal.php:79
Get the position ID of the latest journal entry at some point in time.
Purge any old log entries.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1749
static factory(array $config, $backend)
Create an appropriate FileJournal object from config.
Definition: FileJournal.php:63
Class for handling file operation journaling.
Definition: FileJournal.php:38