ScopedLock.php

Go to the documentation of this file.

<?php
namespace Wikimedia\LockManager;
 
use StatusValue;
 
class ScopedLock {
    protected $manager;
    protected $status;
    protected $pathsByType;
 
    protected function __construct(
        LockManager $manager, array $pathsByType, StatusValue $status
    ) {
        $this->manager = $manager;
        $this->pathsByType = $pathsByType;
        $this->status = $status;
    }
 
    public static function factory(
        LockManager $manager, array $paths, $type, StatusValue $status, $timeout = 0
    ) {
        $pathsByType = is_int( $type ) ? [ $type => $paths ] : $paths;
        $lockStatus = $manager->lockByType( $pathsByType, $timeout );
        $status->merge( $lockStatus );
        if ( $lockStatus->isOK() ) {
            return new self( $manager, $pathsByType, $status );
        }
 
        return null;
    }
 
    public static function release( ?ScopedLock &$lock = null ) {
        $lock = null;
    }
 
    public function __destruct() {
        $wasOk = $this->status->isOK();
        $this->status->merge( $this->manager->unlockByType( $this->pathsByType ) );
        if ( $wasOk ) {
            // Make sure StatusValue is OK, despite any unlockFiles() fatals
            $this->status->setResult( true, $this->status->value );
        }
    }
}
class_alias( ScopedLock::class, 'ScopedLock' );