DeleteFileOp.php

Go to the documentation of this file.

<?php
namespace Wikimedia\FileBackend\FileOps;
 
use StatusValue;
use Wikimedia\FileBackend\FileBackend;
 
class DeleteFileOp extends FileOp {
    protected function allowedParams() {
        return [ [ 'src' ], [ 'ignoreMissingSource' ], [ 'src' ] ];
    }
 
    protected function doPrecheck(
        FileStatePredicates $opPredicates,
        FileStatePredicates $batchPredicates
    ) {
        $status = StatusValue::newGood();
 
        if (
            !$this->getParam( 'ignoreMissingSource' ) &&
            !$this->backend->isPathUsableInternal( $this->params['src'] )
        ) {
            $status->fatal( 'backend-fail-usable', $this->params['src'] );
 
            return $status;
        }
 
        // Check source file existence
        $srcExists = $this->resolveFileExistence( $this->params['src'], $opPredicates );
        if ( $srcExists === false ) {
            if ( $this->getParam( 'ignoreMissingSource' ) ) {
                $this->noOp = true; // no-op
                // Update file existence predicates (cache 404s)
                $batchPredicates->assumeFileDoesNotExist( $this->params['src'] );
 
                return $status; // nothing to do
            } else {
                $status->fatal( 'backend-fail-notexists', $this->params['src'] );
 
                return $status;
            }
        } elseif ( $srcExists === FileBackend::EXISTENCE_ERROR ) {
            $status->fatal( 'backend-fail-stat', $this->params['src'] );
 
            return $status;
        }
 
        // Update file existence predicates since the operation is expected to be allowed to run
        $batchPredicates->assumeFileDoesNotExist( $this->params['src'] );
 
        return $status; // safe to call attempt()
    }
 
    protected function doAttempt() {
        // Delete the source file
        return $this->backend->deleteInternal( $this->setFlags( $this->params ) );
    }
 
    public function storagePathsChanged() {
        return [ $this->params['src'] ];
    }
}
 
class_alias( DeleteFileOp::class, 'DeleteFileOp' );