MediaWiki  master
SlotDiffRenderer.php
Go to the documentation of this file.
1 <?php
24 
39 abstract class SlotDiffRenderer {
40 
49  abstract public function getDiff( Content $oldContent = null, Content $newContent = null );
50 
55  public function addModules( OutputPage $output ) {
56  }
57 
62  public function getExtraCacheKeys() {
63  return [];
64  }
65 
75  protected function normalizeContents(
76  Content &$oldContent = null, Content &$newContent = null, $allowedClasses = null
77  ) {
78  if ( !$oldContent && !$newContent ) {
79  throw new InvalidArgumentException( '$oldContent and $newContent cannot both be null' );
80  }
81 
82  if ( $allowedClasses ) {
83  if ( is_array( $allowedClasses ) ) {
84  $allowedClasses = implode( '|', $allowedClasses );
85  }
86  Assert::parameterType( $allowedClasses . '|null', $oldContent, '$oldContent' );
87  Assert::parameterType( $allowedClasses . '|null', $newContent, '$newContent' );
88  }
89 
90  if ( !$oldContent ) {
91  $oldContent = $newContent->getContentHandler()->makeEmptyContent();
92  } elseif ( !$newContent ) {
93  $newContent = $oldContent->getContentHandler()->makeEmptyContent();
94  }
95  }
96 
97 }
addModules(OutputPage $output)
Add modules needed for correct styling/behavior of the diff.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getExtraCacheKeys()
Return any extra keys to split the diff cache by.
normalizeContents(Content &$oldContent=null, Content &$newContent=null, $allowedClasses=null)
Helper method to normalize the input of getDiff().
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2217
getDiff(Content $oldContent=null, Content $newContent=null)
Get a diff between two content objects.
Renders a diff for a single slot (that is, a diff between two content objects).
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
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