MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
27 class CreateFileOp extends FileOp {
28  protected function allowedParams() {
29  return [
30  [ 'content', 'dst' ],
31  [ 'overwrite', 'overwriteSame', 'headers' ],
32  [ 'dst' ]
33  ];
34  }
36  protected function doPrecheck( array &$predicates ) {
38  // Check if the source data is too big
39  if ( strlen( $this->getParam( 'content' ) ) > $this->backend->maxFileSizeInternal() ) {
40  $status->fatal( 'backend-fail-maxsize',
41  $this->params['dst'], $this->backend->maxFileSizeInternal() );
42  $status->fatal( 'backend-fail-create', $this->params['dst'] );
44  return $status;
45  // Check if a file can be placed/changed at the destination
46  } elseif ( !$this->backend->isPathUsableInternal( $this->params['dst'] ) ) {
47  $status->fatal( 'backend-fail-usable', $this->params['dst'] );
48  $status->fatal( 'backend-fail-create', $this->params['dst'] );
50  return $status;
51  }
52  // Check if destination file exists
53  $status->merge( $this->precheckDestExistence( $predicates ) );
54  $this->params['dstExists'] = $this->destExists; // see FileBackendStore::setFileCache()
55  if ( $status->isOK() ) {
56  // Update file existence predicates
57  $predicates['exists'][$this->params['dst']] = true;
58  $predicates['sha1'][$this->params['dst']] = $this->sourceSha1;
59  }
61  return $status; // safe to call attempt()
62  }
64  protected function doAttempt() {
65  if ( !$this->overwriteSameCase ) {
66  // Create the file at the destination
67  return $this->backend->createInternal( $this->setFlags( $this->params ) );
68  }
70  return StatusValue::newGood();
71  }
73  protected function getSourceSha1Base36() {
74  return Wikimedia\base_convert( sha1( $this->params['content'] ), 16, 36, 31 );
75  }
77  public function storagePathsChanged() {
78  return [ $this->params['dst'] ];
79  }
80 }
string $sourceSha1
Definition: FileOp.php:62
Definition: CreateFileOp.php:64
FileBackend helper class for representing operations.
Definition: FileOp.php:37
bool $destExists
Definition: FileOp.php:68
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
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
setFlags(array $params)
Adjust params to FileBackendStore internal file calls.
Definition: FileOp.php:335
precheckDestExistence() helper function to get the source file SHA-1.
Definition: CreateFileOp.php:73
getParam( $name)
Get the value of the parameter with the given name.
Definition: FileOp.php:140
doPrecheck(array &$predicates)
Definition: CreateFileOp.php:36
Get the file operation parameters.
Definition: CreateFileOp.php:28
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
Get a list of storage paths written to for this operation.
Definition: CreateFileOp.php:77
precheckDestExistence(array $predicates)
Check for errors with regards to the destination file already existing.
Definition: FileOp.php:365
Create a file in the backend with the given content.
Definition: CreateFileOp.php:27
the array() calling protocol came about after MediaWiki 1.4rc1.