MediaWiki  1.28.0
ScopedLock.php
Go to the documentation of this file.
1 <?php
34 class ScopedLock {
36  protected $manager;
37 
39  protected $status;
40 
42  protected $pathsByType;
43 
49  protected function __construct(
51  ) {
52  $this->manager = $manager;
53  $this->pathsByType = $pathsByType;
54  $this->status = $status;
55  }
56 
71  public static function factory(
72  LockManager $manager, array $paths, $type, StatusValue $status, $timeout = 0
73  ) {
74  $pathsByType = is_integer( $type ) ? [ $type => $paths ] : $paths;
75  $lockStatus = $manager->lockByType( $pathsByType, $timeout );
76  $status->merge( $lockStatus );
77  if ( $lockStatus->isOK() ) {
78  return new self( $manager, $pathsByType, $status );
79  }
80 
81  return null;
82  }
83 
92  public static function release( ScopedLock &$lock = null ) {
93  $lock = null;
94  }
95 
99  function __destruct() {
100  $wasOk = $this->status->isOK();
101  $this->status->merge( $this->manager->unlockByType( $this->pathsByType ) );
102  if ( $wasOk ) {
103  // Make sure StatusValue is OK, despite any unlockFiles() fatals
104  $this->status->setResult( true, $this->status->value );
105  }
106  }
107 }
the array() calling protocol came about after MediaWiki 1.4rc1.
array $pathsByType
Map of lock types to resource paths.
Definition: ScopedLock.php:42
static factory(LockManager $manager, array $paths, $type, StatusValue $status, $timeout=0)
Get a ScopedLock object representing a lock on resource paths.
Definition: ScopedLock.php:71
LockManager $manager
Definition: ScopedLock.php:36
__construct(LockManager $manager, array $pathsByType, StatusValue $status)
Definition: ScopedLock.php:49
merge($other, $overwriteValue=false)
Merge another status object into this one.
Self-releasing locks.
Definition: ScopedLock.php:34
lockByType(array $pathsByType, $timeout=0)
Lock the resources at the given abstract paths.
StatusValue $status
Definition: ScopedLock.php:39
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
__destruct()
Release the locks when this goes out of scope.
Definition: ScopedLock.php:99
Class for handling resource locking.
Definition: LockManager.php:47
static release(ScopedLock &$lock=null)
Release a scoped lock and set any errors in the attatched StatusValue object.
Definition: ScopedLock.php:92
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491