MediaWiki  master
ImportableUploadRevisionImporter Class Reference
Inheritance diagram for ImportableUploadRevisionImporter:
Collaboration diagram for ImportableUploadRevisionImporter:

Public Member Functions

 __construct ( $enableUploads, LoggerInterface $logger)
 
 downloadSource (ImportableUploadRevision $wikiRevision)
 
 import (ImportableUploadRevision $importableRevision)
 
 setNullRevisionCreation ( $shouldCreateNullRevision)
 Setting this to false will deactivate the creation of a null revision as part of the upload process logging in LocalFile::recordUpload2, see T193621. More...
 

Private Member Functions

 newNotOkStatus ()
 

Private Attributes

bool $enableUploads
 
LoggerInterface $logger
 
bool $shouldCreateNullRevision = true
 

Detailed Description

Since
1.31

Definition at line 9 of file ImportableUploadRevisionImporter.php.

Constructor & Destructor Documentation

◆ __construct()

ImportableUploadRevisionImporter::__construct (   $enableUploads,
LoggerInterface  $logger 
)
Parameters
bool$enableUploads
LoggerInterface$logger

Definition at line 30 of file ImportableUploadRevisionImporter.php.

References $enableUploads, and $logger.

Member Function Documentation

◆ downloadSource()

ImportableUploadRevisionImporter::downloadSource ( ImportableUploadRevision  $wikiRevision)
Deprecated:
DO NOT CALL ME.

This method was introduced when factoring (Importable)UploadRevisionImporter out of WikiRevision. It only has 1 use by the deprecated downloadSource method in WikiRevision. Do not use this in new code, it will be made private soon.

Parameters
ImportableUploadRevision$wikiRevision
Returns
bool|string

Definition at line 150 of file ImportableUploadRevisionImporter.php.

References ImportableUploadRevision\getSrc(), and wfTempDir().

Referenced by WikiRevision\downloadSource(), and import().

◆ import()

ImportableUploadRevisionImporter::import ( ImportableUploadRevision  $importableUploadRevision)
Since
1.31
Parameters
ImportableUploadRevision$importableUploadRevision
Returns
StatusValue On success, the value member contains the archive name, or an empty string if it was a new file.

Implements UploadRevisionImporter.

Definition at line 57 of file ImportableUploadRevisionImporter.php.

References $file, $shouldCreateNullRevision, $source, downloadSource(), OldLocalFile\newFromArchiveName(), User\newFromName(), newNotOkStatus(), and RepoGroup\singleton().

◆ newNotOkStatus()

ImportableUploadRevisionImporter::newNotOkStatus ( )
private
Returns
StatusValue

Definition at line 51 of file ImportableUploadRevisionImporter.php.

Referenced by import().

◆ setNullRevisionCreation()

ImportableUploadRevisionImporter::setNullRevisionCreation (   $shouldCreateNullRevision)

Setting this to false will deactivate the creation of a null revision as part of the upload process logging in LocalFile::recordUpload2, see T193621.

Parameters
bool$shouldCreateNullRevision

Definition at line 44 of file ImportableUploadRevisionImporter.php.

References $shouldCreateNullRevision.

Member Data Documentation

◆ $enableUploads

bool ImportableUploadRevisionImporter::$enableUploads
private

Definition at line 19 of file ImportableUploadRevisionImporter.php.

Referenced by __construct().

◆ $logger

LoggerInterface ImportableUploadRevisionImporter::$logger
private

Definition at line 14 of file ImportableUploadRevisionImporter.php.

Referenced by __construct().

◆ $shouldCreateNullRevision

bool ImportableUploadRevisionImporter::$shouldCreateNullRevision = true
private

Definition at line 24 of file ImportableUploadRevisionImporter.php.

Referenced by import(), and setNullRevisionCreation().


The documentation for this class was generated from the following file: