MediaWiki
REL1_35
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
98
public
function
getBlob
( $blobAddress, $queryFlags = 0 );
99
111
public
function
getBlobBatch
( $blobAddresses, $queryFlags = 0 );
112
126
public
function
storeBlob
( $data, $hints = [] );
127
133
public
function
isReadOnly
();
134
}
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition
StatusValue.php:43
MediaWiki\Storage\BlobStore
Service for loading and storing data blobs.
Definition
BlobStore.php:35
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:66
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:42
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:48
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:54
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:84
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:60
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:72
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:78
MediaWiki\Storage
Definition
BlobAccessException.php:23
includes
Storage
BlobStore.php
Generated on Sat Apr 6 2024 00:08:01 for MediaWiki by
1.9.8