MediaWiki  master
BlobStore.php
Go to the documentation of this file.
1 <?php
23 namespace MediaWiki\Storage;
24 
25 use StatusValue;
26 
35 interface BlobStore {
36 
42  public const DESIGNATION_HINT = 'designation';
43 
48  public const PAGE_HINT = 'page_id';
49 
54  public const ROLE_HINT = 'role_name';
55 
60  public const REVISION_HINT = 'rev_id';
61 
66  public const PARENT_HINT = 'rev_parent_id';
67 
72  public const SHA1_HINT = 'cont_sha1';
73 
78  public const MODEL_HINT = 'cont_model';
79 
84  public const FORMAT_HINT = 'cont_format';
85 
89  public const IMAGE_HINT = 'img_name';
90 
103  public function getBlob( $blobAddress, $queryFlags = 0 );
104 
116  public function getBlobBatch( $blobAddresses, $queryFlags = 0 );
117 
131  public function storeBlob( $data, $hints = [] );
132 
138  public function isReadOnly();
139 }
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:43
Service for loading and storing data blobs.
Definition: BlobStore.php:35
isReadOnly()
Check if the blob metadata or backing blob data store is read-only.
getBlobBatch( $blobAddresses, $queryFlags=0)
A batched version of BlobStore::getBlob.
getBlob( $blobAddress, $queryFlags=0)
Retrieve a blob, given an address.
const PARENT_HINT
Hint key for use with storeBlob, indicating the parent revision of the revision the blob is associate...
Definition: BlobStore.php:66
const DESIGNATION_HINT
Hint key for use with storeBlob, indicating the general role the block takes in the application.
Definition: BlobStore.php:42
const PAGE_HINT
Hint key for use with storeBlob, indicating the page the blob is associated with.
Definition: BlobStore.php:48
const ROLE_HINT
Hint key for use with storeBlob, indicating the slot the blob is associated with.
Definition: BlobStore.php:54
const IMAGE_HINT
Hint key for an image name.
Definition: BlobStore.php:89
const FORMAT_HINT
Hint key for use with storeBlob, indicating the serialization format used to create the blob,...
Definition: BlobStore.php:84
const REVISION_HINT
Hint key for use with storeBlob, indicating the revision the blob is associated with.
Definition: BlobStore.php:60
const SHA1_HINT
Hint key for use with storeBlob, providing the SHA1 hash of the blob as passed to the method.
Definition: BlobStore.php:72
storeBlob( $data, $hints=[])
Stores an arbitrary blob of data and returns an address that can be used with getBlob() to retrieve t...
const MODEL_HINT
Hint key for use with storeBlob, indicating the model of the content encoded in the given blob.
Definition: BlobStore.php:78