During development a lot of classes were placed in MediaWiki\Storage\. The precedent set would mean that every class relating to something stored in a database table, plus all related value classes and such, would go into that namespace. Let's put them into MediaWiki\Revision\ instead. Then future classes related to the 'page' table can go into MediaWiki\Page\, future classes related to the 'user' table can go into MediaWiki\User\, and so on. Note I didn't move DerivedPageDataUpdater, PageUpdateException, PageUpdater, or RevisionSlotsUpdate in this patch. If these are kept long-term, they probably belong in MediaWiki\Page\ or MediaWiki\Edit\ instead. Bug: T204158 Change-Id: I16bea8927566a3c73c07e4f4afb3537e05aa04a5
116 lines
3 KiB
PHP
116 lines
3 KiB
PHP
<?php
|
|
/**
|
|
* Mutable version of RevisionSlots, for constructing a new revision.
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
namespace MediaWiki\Revision;
|
|
|
|
use Content;
|
|
|
|
/**
|
|
* Mutable version of RevisionSlots, for constructing a new revision.
|
|
*
|
|
* @since 1.31
|
|
* @since 1.32 Renamed from MediaWiki\Storage\MutableRevisionSlots
|
|
*/
|
|
class MutableRevisionSlots extends RevisionSlots {
|
|
|
|
/**
|
|
* Constructs a MutableRevisionSlots that inherits from the given
|
|
* list of slots.
|
|
*
|
|
* @param SlotRecord[] $slots
|
|
*
|
|
* @return MutableRevisionSlots
|
|
*/
|
|
public static function newFromParentRevisionSlots( array $slots ) {
|
|
$inherited = [];
|
|
foreach ( $slots as $slot ) {
|
|
$role = $slot->getRole();
|
|
$inherited[$role] = SlotRecord::newInherited( $slot );
|
|
}
|
|
|
|
return new MutableRevisionSlots( $inherited );
|
|
}
|
|
|
|
/**
|
|
* @param SlotRecord[] $slots An array of SlotRecords.
|
|
*/
|
|
public function __construct( array $slots = [] ) {
|
|
parent::__construct( $slots );
|
|
}
|
|
|
|
/**
|
|
* Sets the given slot.
|
|
* If a slot with the same role is already present, it is replaced.
|
|
*
|
|
* @param SlotRecord $slot
|
|
*/
|
|
public function setSlot( SlotRecord $slot ) {
|
|
if ( !is_array( $this->slots ) ) {
|
|
$this->getSlots(); // initialize $this->slots
|
|
}
|
|
|
|
$role = $slot->getRole();
|
|
$this->slots[$role] = $slot;
|
|
}
|
|
|
|
/**
|
|
* Sets the given slot to an inherited version of $slot.
|
|
* If a slot with the same role is already present, it is replaced.
|
|
*
|
|
* @param SlotRecord $slot
|
|
*/
|
|
public function inheritSlot( SlotRecord $slot ) {
|
|
$this->setSlot( SlotRecord::newInherited( $slot ) );
|
|
}
|
|
|
|
/**
|
|
* Sets the content for the slot with the given role.
|
|
* If a slot with the same role is already present, it is replaced.
|
|
*
|
|
* @param string $role
|
|
* @param Content $content
|
|
*/
|
|
public function setContent( $role, Content $content ) {
|
|
$slot = SlotRecord::newUnsaved( $role, $content );
|
|
$this->setSlot( $slot );
|
|
}
|
|
|
|
/**
|
|
* Remove the slot for the given role, discontinue the corresponding stream.
|
|
*
|
|
* @param string $role
|
|
*/
|
|
public function removeSlot( $role ) {
|
|
if ( !is_array( $this->slots ) ) {
|
|
$this->getSlots(); // initialize $this->slots
|
|
}
|
|
|
|
unset( $this->slots[$role] );
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Retain the old class name for backwards compatibility.
|
|
* @deprecated since 1.32
|
|
*/
|
|
class_alias( MutableRevisionSlots::class, 'MediaWiki\Storage\MutableRevisionSlots' );
|