MediaWiki
master
BlobStore.php
Go to the documentation of this file.
1
<?php
7
namespace
MediaWiki\Storage
;
8
9
use
StatusValue
;
10
19
interface
BlobStore
{
20
26
public
const
DESIGNATION_HINT
=
'designation'
;
27
32
public
const
PAGE_HINT
=
'page_id'
;
33
38
public
const
ROLE_HINT
=
'role_name'
;
39
44
public
const
REVISION_HINT
=
'rev_id'
;
45
50
public
const
PARENT_HINT
=
'rev_parent_id'
;
51
56
public
const
SHA1_HINT
=
'cont_sha1'
;
57
62
public
const
MODEL_HINT
=
'cont_model'
;
63
68
public
const
FORMAT_HINT
=
'cont_format'
;
69
73
public
const
IMAGE_HINT
=
'img_name'
;
74
87
public
function
getBlob
( $blobAddress, $queryFlags = 0 );
88
100
public
function
getBlobBatch
( $blobAddresses, $queryFlags = 0 );
101
115
public
function
storeBlob
( $data, $hints = [] );
116
122
public
function
isReadOnly
();
123
}
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition
StatusValue.php:41
MediaWiki\Storage\BlobStore
Service for loading and storing data blobs.
Definition
BlobStore.php:19
MediaWiki\Storage\BlobStore\isReadOnly
isReadOnly()
Check if the blob metadata or backing blob data store is read-only.
MediaWiki\Storage\BlobStore\getBlobBatch
getBlobBatch( $blobAddresses, $queryFlags=0)
A batched version of BlobStore::getBlob.
MediaWiki\Storage\BlobStore\getBlob
getBlob( $blobAddress, $queryFlags=0)
Retrieve a blob, given an address.
MediaWiki\Storage\BlobStore\PARENT_HINT
const PARENT_HINT
Hint key for use with storeBlob, indicating the parent revision of the revision the blob is associate...
Definition
BlobStore.php:50
MediaWiki\Storage\BlobStore\DESIGNATION_HINT
const DESIGNATION_HINT
Hint key for use with storeBlob, indicating the general role the block takes in the application.
Definition
BlobStore.php:26
MediaWiki\Storage\BlobStore\PAGE_HINT
const PAGE_HINT
Hint key for use with storeBlob, indicating the page the blob is associated with.
Definition
BlobStore.php:32
MediaWiki\Storage\BlobStore\ROLE_HINT
const ROLE_HINT
Hint key for use with storeBlob, indicating the slot the blob is associated with.
Definition
BlobStore.php:38
MediaWiki\Storage\BlobStore\IMAGE_HINT
const IMAGE_HINT
Hint key for an image name.
Definition
BlobStore.php:73
MediaWiki\Storage\BlobStore\FORMAT_HINT
const FORMAT_HINT
Hint key for use with storeBlob, indicating the serialization format used to create the blob,...
Definition
BlobStore.php:68
MediaWiki\Storage\BlobStore\REVISION_HINT
const REVISION_HINT
Hint key for use with storeBlob, indicating the revision the blob is associated with.
Definition
BlobStore.php:44
MediaWiki\Storage\BlobStore\SHA1_HINT
const SHA1_HINT
Hint key for use with storeBlob, providing the SHA1 hash of the blob as passed to the method.
Definition
BlobStore.php:56
MediaWiki\Storage\BlobStore\storeBlob
storeBlob( $data, $hints=[])
Stores an arbitrary blob of data and returns an address that can be used with getBlob() to retrieve t...
MediaWiki\Storage\BlobStore\MODEL_HINT
const MODEL_HINT
Hint key for use with storeBlob, indicating the model of the content encoded in the given blob.
Definition
BlobStore.php:62
MediaWiki\Storage
Definition
BadBlobException.php:3
includes
Storage
BlobStore.php
Generated on Fri Jan 16 2026 23:28:31 for MediaWiki by
1.10.0