DescribeFileOp.php

Go to the documentation of this file.

<?php
class DescribeFileOp extends FileOp {
    protected function allowedParams() {
        return [ [ 'src' ], [ 'headers' ], [ 'src' ] ];
    }

    protected function doPrecheck( array &$predicates ) {
        $status = StatusValue::newGood();
        // Check if the source file exists
        if ( !$this->fileExists( $this->params['src'], $predicates ) ) {
            $status->fatal( 'backend-fail-notexists', $this->params['src'] );

            return $status;
            // Check if a file can be placed/changed at the source
        } elseif ( !$this->backend->isPathUsableInternal( $this->params['src'] ) ) {
            $status->fatal( 'backend-fail-usable', $this->params['src'] );
            $status->fatal( 'backend-fail-describe', $this->params['src'] );

            return $status;
        }
        // Update file existence predicates
        $predicates['exists'][$this->params['src']] =
            $this->fileExists( $this->params['src'], $predicates );
        $predicates['sha1'][$this->params['src']] =
            $this->fileSha1( $this->params['src'], $predicates );

        return $status; // safe to call attempt()
    }

    protected function doAttempt() {
        // Update the source file's metadata
        return $this->backend->describeInternal( $this->setFlags( $this->params ) );
    }

    public function storagePathsChanged() {
        return [ $this->params['src'] ];
    }
}