[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/filebackend/lockmanager/ -> LockManager.php (summary)

[Source view] [Print] [Project Stats]

(no description)

File Size: 263 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

NullLockManager:: (2 methods):
  doLock()
  doUnlock()

Defines 2 functions

  __construct()
  lock()
  lockByType()
  unlock()
  unlockByType()
  sha1Base36Absolute()
  sha1Base16Absolute()
  normalizePathsByType()
  doLockByType()
  doUnlockByType()

Class: NullLockManager  - X-Ref

Simple version of LockManager that does nothing

doLock( array $paths, $type )   X-Ref
No description

doUnlock( array $paths, $type )   X-Ref
No description

Functions
Functions that are not part of a class:

__construct( array $config )   X-Ref
Construct a new instance from configuration

param: array $config Paramaters include:

lock( array $paths, $type = self::LOCK_EX, $timeout = 0 )   X-Ref
Lock the resources at the given abstract paths

param: array $paths List of resource names
param: int $type LockManager::LOCK_* constant
param: int $timeout Timeout in seconds (0 means non-blocking) (since 1.21)
return: Status

lockByType( array $pathsByType, $timeout = 0 )   X-Ref
Lock the resources at the given abstract paths

param: array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
param: int $timeout Timeout in seconds (0 means non-blocking) (since 1.21)
return: Status

unlock( array $paths, $type = self::LOCK_EX )   X-Ref
Unlock the resources at the given abstract paths

param: array $paths List of paths
param: int $type LockManager::LOCK_* constant
return: Status

unlockByType( array $pathsByType )   X-Ref
Unlock the resources at the given abstract paths

param: array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
return: Status

sha1Base36Absolute( $path )   X-Ref
Get the base 36 SHA-1 of a string, padded to 31 digits.
Before hashing, the path will be prefixed with the domain ID.
This should be used interally for lock key or file names.

param: string $path
return: string

sha1Base16Absolute( $path )   X-Ref
Get the base 16 SHA-1 of a string, padded to 31 digits.
Before hashing, the path will be prefixed with the domain ID.
This should be used interally for lock key or file names.

param: string $path
return: string

normalizePathsByType( array $pathsByType )   X-Ref
Normalize the $paths array by converting LOCK_UW locks into the
appropriate type and removing any duplicated paths for each lock type.

param: array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
return: array

doLockByType( array $pathsByType )   X-Ref

param: array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
return: Status

doUnlockByType( array $pathsByType )   X-Ref

param: array $pathsByType Map of LockManager::LOCK_* constants to lists of paths
return: Status


Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1