MediaWiki  master
MediaWiki\Edit\ParsoidOutputStash Interface Reference

Interface for saving and retrieval of Parsoid HTML and Parsoid metadata from storage. More...

Inheritance diagram for MediaWiki\Edit\ParsoidOutputStash:

Public Member Functions

 get (ParsoidRenderID $renderId)
 Retrieve a page bundle (that was previously put in the stash using the ->set() method) from the stash using a unique render ID. More...
 
 set (ParsoidRenderID $renderId, PageBundle $bundle)
 Stash a PageBundle representing a rendering of a revision at a given point in time. More...
 

Detailed Description

Interface for saving and retrieval of Parsoid HTML and Parsoid metadata from storage.

Since
1.39

Definition at line 14 of file ParsoidOutputStash.php.

Member Function Documentation

◆ get()

MediaWiki\Edit\ParsoidOutputStash::get ( ParsoidRenderID  $renderId)

Retrieve a page bundle (that was previously put in the stash using the ->set() method) from the stash using a unique render ID.

The page bundle stays in the stash for some time and not guaranteed to be persistent across requests.

Parameters
ParsoidRenderID$renderId
Returns
?PageBundle

◆ set()

MediaWiki\Edit\ParsoidOutputStash::set ( ParsoidRenderID  $renderId,
PageBundle  $bundle 
)

Stash a PageBundle representing a rendering of a revision at a given point in time.

The given PageBundle can for some time later be retrieved by calling get( $renderId ).

Parameters
ParsoidRenderID$renderIdCombination of revision ID and revision's time ID
PageBundle$bundle
Returns
bool True on success

The documentation for this interface was generated from the following file: