47d70dbfba
Updates for the removal of the Revision class itself and the various methods/hooks/variables removed in the process, including: - Update some documentation removing most references to the Revision class and updating the MCR migration notes to reflect the past tense for Revision methods. - Change some capitalization from "Revision" to "revision" to make it clear comments are about revisions in general, not the Revision class in particular. - Minor code tweaks including removing unused variables that were around for the old hooks that were removed, and removing the use of DeprecatablePropertyArray where no longer needed for anything. - Fix incorrect documentation for PageUpdater::getStatus(), the status value changed a while ago to have revision-record in addition to revision, and recently to only have the revision-record, but ironically PageUpdater was never updated. - Removed Parser::$mRevisionObject, used to be a Revision object and was deprecated in 1.35, missed earlier because it was no longer being set to Revision objects, always null. - Add RevisionRecord typehints in DummyLinker to match those in the corresponding Linker methods This should be a no-op in terms of functionality. Bug: T247143 Change-Id: I03bbb94fc29085855448780b1a5ad9063911ecc4
67 lines
2 KiB
PHP
67 lines
2 KiB
PHP
<?php
|
|
/**
|
|
* Efficient concatenated text storage.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* Base class for general text storage via the "object" flag in old_flags, or
|
|
* two-part external storage URLs. Used for represent efficient concatenated
|
|
* storage, and migration-related pointer objects.
|
|
*/
|
|
interface HistoryBlob {
|
|
/**
|
|
* Adds an item of text, returns a stub object which points to the item.
|
|
* You must call setLocation() on the stub object before storing it to the
|
|
* database
|
|
*
|
|
* @param string $text
|
|
*
|
|
* @return string The key for getItem()
|
|
*/
|
|
public function addItem( $text );
|
|
|
|
/**
|
|
* Get item by key, or false if the key is not present
|
|
*
|
|
* @param string $key
|
|
*
|
|
* @return string|bool
|
|
*/
|
|
public function getItem( $key );
|
|
|
|
/**
|
|
* Set the "default text"
|
|
* This concept is an odd property of the current DB schema, whereby each text item has a revision
|
|
* associated with it. The default text is the text of the associated revision. There may, however,
|
|
* be other revisions in the same object.
|
|
*
|
|
* Default text is not required for two-part external storage URLs.
|
|
*
|
|
* @param string $text
|
|
*/
|
|
public function setText( $text );
|
|
|
|
/**
|
|
* Get default text.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getText();
|
|
}
|