MediaWiki  1.28.0
DescribeFileOp.php
Go to the documentation of this file.
1 <?php
29 class DescribeFileOp extends FileOp {
30  protected function allowedParams() {
31  return [ [ 'src' ], [ 'headers' ], [ 'src' ] ];
32  }
33 
34  protected function doPrecheck( array &$predicates ) {
36  // Check if the source file exists
37  if ( !$this->fileExists( $this->params['src'], $predicates ) ) {
38  $status->fatal( 'backend-fail-notexists', $this->params['src'] );
39 
40  return $status;
41  // Check if a file can be placed/changed at the source
42  } elseif ( !$this->backend->isPathUsableInternal( $this->params['src'] ) ) {
43  $status->fatal( 'backend-fail-usable', $this->params['src'] );
44  $status->fatal( 'backend-fail-describe', $this->params['src'] );
45 
46  return $status;
47  }
48  // Update file existence predicates
49  $predicates['exists'][$this->params['src']] =
50  $this->fileExists( $this->params['src'], $predicates );
51  $predicates['sha1'][$this->params['src']] =
52  $this->fileSha1( $this->params['src'], $predicates );
53 
54  return $status; // safe to call attempt()
55  }
56 
57  protected function doAttempt() {
58  // Update the source file's metadata
59  return $this->backend->describeInternal( $this->setFlags( $this->params ) );
60  }
61 
62  public function storagePathsChanged() {
63  return [ $this->params['src'] ];
64  }
65 }
the array() calling protocol came about after MediaWiki 1.4rc1.
FileBackend helper class for representing operations.
Definition: FileOp.php:37
fileSha1($source, array $predicates)
Get the SHA-1 of a file in storage when this operation is attempted.
Definition: FileOp.php:434
setFlags(array $params)
Adjust params to FileBackendStore internal file calls.
Definition: FileOp.php:335
doPrecheck(array &$predicates)
Change metadata for a file at the given storage path in the backend.
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
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
fileExists($source, array $predicates)
Check if a file will exist in storage when this operation is attempted.
Definition: FileOp.php:417
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 $status
Definition: hooks.txt:1046