1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
|
<?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 MediaWiki\Content\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 {
/**
* @var callable|null
*/
private $resetCallback;
/**
* Constructs a MutableRevisionSlots that inherits from the given
* list of slots.
*
* @param SlotRecord[] $slots
* @param callable|null $resetCallback Callback to be triggered whenever slots change.
* Signature: function ( MutableRevisionSlots ): void.
*
* @return MutableRevisionSlots
*/
public static function newFromParentRevisionSlots(
array $slots,
?callable $resetCallback = null
) {
$inherited = [];
foreach ( $slots as $slot ) {
$role = $slot->getRole();
$inherited[$role] = SlotRecord::newInherited( $slot );
}
return new MutableRevisionSlots( $inherited, $resetCallback );
}
/**
* @param SlotRecord[] $slots An array of SlotRecords.
* @param callable|null $resetCallback Callback to be triggered whenever slots change.
* Signature: function ( MutableRevisionSlots ): void.
*/
public function __construct( array $slots = [], ?callable $resetCallback = null ) {
// @phan-suppress-next-line PhanTypeInvalidCallableArraySize
parent::__construct( $slots );
$this->resetCallback = $resetCallback;
}
/**
* 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;
$this->triggerResetCallback();
}
/**
* 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] );
$this->triggerResetCallback();
}
/**
* Trigger the reset callback supplied to the constructor, if any.
*/
private function triggerResetCallback() {
if ( $this->resetCallback ) {
( $this->resetCallback )( $this );
}
}
}
|