MediaWiki  master
BlobStore.php
Go to the documentation of this file.
1 <?php
23 namespace MediaWiki\Storage;
24 
33 interface BlobStore {
34 
40  const DESIGNATION_HINT = 'designation';
41 
46  const PAGE_HINT = 'page_id';
47 
52  const ROLE_HINT = 'role_name';
53 
58  const REVISION_HINT = 'rev_id';
59 
64  const PARENT_HINT = 'rev_parent_id';
65 
70  const SHA1_HINT = 'cont_sha1';
71 
76  const MODEL_HINT = 'cont_model';
77 
82  const FORMAT_HINT = 'cont_format';
83 
96  public function getBlob( $blobAddress, $queryFlags = 0 );
97 
111  public function storeBlob( $data, $hints = [] );
112 
118  public function isReadOnly();
119 }
const MODEL_HINT
Hint key for use with storeBlob, indicating the model of the content encoded in the given blob...
Definition: BlobStore.php:76
storeBlob( $data, $hints=[])
Stores an arbitrary blob of data and returns an address that can be used with getBlob() to retrieve t...
const SHA1_HINT
Hint key for use with storeBlob, providing the SHA1 hash of the blob as passed to the method...
Definition: BlobStore.php:70
const PAGE_HINT
Hint key for use with storeBlob, indicating the page the blob is associated with. ...
Definition: BlobStore.php:46
const PARENT_HINT
Hint key for use with storeBlob, indicating the parent revision of the revision the blob is associate...
Definition: BlobStore.php:64
const ROLE_HINT
Hint key for use with storeBlob, indicating the slot the blob is associated with. ...
Definition: BlobStore.php:52
getBlob( $blobAddress, $queryFlags=0)
Retrieve a blob, given an address.
isReadOnly()
Check if the blob metadata or backing blob data store is read-only.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
const DESIGNATION_HINT
Hint key for use with storeBlob, indicating the general role the block takes in the application...
Definition: BlobStore.php:40
Service for loading and storing data blobs.
Definition: BlobStore.php:33
const REVISION_HINT
Hint key for use with storeBlob, indicating the revision the blob is associated with.
Definition: BlobStore.php:58
const FORMAT_HINT
Hint key for use with storeBlob, indicating the serialization format used to create the blob...
Definition: BlobStore.php:82