MediaWiki\Revision\RevisionSlots Class Reference

Value object representing the set of slots belonging to a revision. More...

Inheritance diagram for MediaWiki\Revision\RevisionSlots:

Collaboration diagram for MediaWiki\Revision\RevisionSlots:

Public Member Functions
	__construct ( $slots)
	Stable to call.
	__sleep ()
	Implemented to defy serialization.
	computeSha1 ()
	Computes the combined hash of the revisions's slots.
	computeSize ()
	Computes the total nominal size of the revision's slots, in bogo-bytes.
	getContent ( $role)
	Returns the Content of the given slot.
	getInheritedSlots ()
	Return all slots that are not not originate in the revision they belong to (that is, they are inherited from some other revision).
	getOriginalSlots ()
	Return all slots that belong to the revision they originate from (that is, they are not inherited from some other revision).
	getRolesWithDifferentContent (RevisionSlots $other)
	Find roles for which the $other RevisionSlots object has different content as this RevisionSlots object, including any roles that are present in one but not the other.
	getSlot ( $role)
	Returns the SlotRecord of the given slot.
	getSlotRoles ()
	Returns the slot names (roles) of all slots present in this revision.
	getSlots ()
	Returns an associative array that maps role names to SlotRecords.
	hasSameContent (RevisionSlots $other)
	Checks whether the other RevisionSlots instance has the same content as this instance.
	hasSlot ( $role)
	Returns whether the given slot is set.

Protected Attributes
SlotRecord[] callable	$slots

Private Member Functions
	setSlotsInternal (array $slots)

Detailed Description

Value object representing the set of slots belonging to a revision.

Note

RevisionSlots provides "raw" access to the slots and does not apply audience checks. If audience checks are desired, use RevisionRecord::getSlot() or RevisionRecord::getContent() instead.

@newable

Since

1.31

1.32 Renamed from MediaWiki\Storage\RevisionSlots

Definition at line 41 of file RevisionSlots.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Revision\RevisionSlots::__construct

(

$slots

)

Stable to call.

Parameters

SlotRecord[] | callable

$slots

SlotRecords, or a callback that returns such a structure.

Definition at line 52 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\$slots, and MediaWiki\Revision\RevisionSlots\setSlotsInternal().

Member Function Documentation

__sleep()

MediaWiki\Revision\RevisionSlots::__sleep

(

)

Implemented to defy serialization.

Exceptions

LogicException

always

Definition at line 82 of file RevisionSlots.php.

computeSha1()

MediaWiki\Revision\RevisionSlots::computeSha1

(

)

Computes the combined hash of the revisions's slots.

Note

For backwards compatibility, the combined hash of a single slot is that slot's hash. For consistency, the combined hash of an empty set of slots is the hash of the empty string.

Warning

This is potentially expensive! It may cause all slot's content to be loaded and deserialized, then re-serialized and hashed.

Returns

string

Definition at line 200 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\$slots, MediaWiki\Revision\SlotRecord\base36Sha1(), MediaWiki\Revision\SlotRecord\getSha1(), and MediaWiki\Revision\RevisionSlots\getSlots().

computeSize()

MediaWiki\Revision\RevisionSlots::computeSize

(

)

Computes the total nominal size of the revision's slots, in bogo-bytes.

Warning

This is potentially expensive! It may cause all slot's content to be loaded and deserialized.

Returns

int

Definition at line 158 of file RevisionSlots.php.

References MediaWiki\Revision\SlotRecord\getSize(), and MediaWiki\Revision\RevisionSlots\getSlots().

getContent()

MediaWiki\Revision\RevisionSlots::getContent

(

$role

)

Returns the Content of the given slot.

Call getSlotNames() to get a list of available slots.

Note that for mutable Content objects, each call to this method will return a fresh clone.

See also

SlotRecord::getContent()

Parameters

string

$role

The role name of the desired slot

Exceptions

RevisionAccessException

if the slot does not exist or slot data could not be lazy-loaded. See SlotRecord::getContent() for details.

Returns

Content

Definition at line 101 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\getSlot().

getInheritedSlots()

MediaWiki\Revision\RevisionSlots::getInheritedSlots

(

)

Return all slots that are not not originate in the revision they belong to (that is, they are inherited from some other revision).

Note

This may cause the slot meta-data for the revision to be lazy-loaded.

Returns

SlotRecord[]

Definition at line 240 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\getSlots(), and MediaWiki\Revision\SlotRecord\isInherited().

getOriginalSlots()

MediaWiki\Revision\RevisionSlots::getOriginalSlots

(

)

Return all slots that belong to the revision they originate from (that is, they are not inherited from some other revision).

Note

This may cause the slot meta-data for the revision to be lazy-loaded.

Returns

SlotRecord[]

Definition at line 223 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\getSlots(), and MediaWiki\Revision\SlotRecord\isInherited().

getRolesWithDifferentContent()

MediaWiki\Revision\RevisionSlots::getRolesWithDifferentContent

(

RevisionSlots

$other

)

Find roles for which the $other RevisionSlots object has different content as this RevisionSlots object, including any roles that are present in one but not the other.

Parameters

RevisionSlots

$other

Returns

string[] a list of slot roles that are different.

Definition at line 293 of file RevisionSlots.php.

References $s, $t, and MediaWiki\Revision\RevisionSlots\getSlots().

getSlot()

MediaWiki\Revision\RevisionSlots::getSlot

(

$role

)

Returns the SlotRecord of the given slot.

Call getSlotNames() to get a list of available slots.

Parameters

string

$role

The role name of the desired slot

Exceptions

RevisionAccessException

if the slot does not exist or slot data could not be lazy-loaded.

Returns

SlotRecord

Definition at line 116 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\$slots, and MediaWiki\Revision\RevisionSlots\getSlots().

Referenced by MediaWiki\Revision\RevisionSlots\getContent().

getSlotRoles()

MediaWiki\Revision\RevisionSlots::getSlotRoles

(

)

Returns the slot names (roles) of all slots present in this revision.

getContent() will succeed only for the names returned by this method.

Returns

string[]

Definition at line 145 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\$slots, and MediaWiki\Revision\RevisionSlots\getSlots().

getSlots()

MediaWiki\Revision\RevisionSlots::getSlots

(

)

Returns an associative array that maps role names to SlotRecords.

Each SlotRecord represents the content meta-data of a slot, together they define the content of a revision.

Note

This may cause the content meta-data for the revision to be lazy-loaded.

Returns

SlotRecord[] revision slot/content rows, keyed by slot role name.

Definition at line 173 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\$slots, and MediaWiki\Revision\RevisionSlots\setSlotsInternal().

Referenced by MediaWiki\Revision\RevisionSlots\computeSha1(), MediaWiki\Revision\RevisionSlots\computeSize(), MediaWiki\Revision\RevisionSlots\getInheritedSlots(), MediaWiki\Revision\RevisionSlots\getOriginalSlots(), MediaWiki\Revision\RevisionSlots\getRolesWithDifferentContent(), MediaWiki\Revision\RevisionSlots\getSlot(), MediaWiki\Revision\RevisionSlots\getSlotRoles(), MediaWiki\Revision\RevisionSlots\hasSameContent(), MediaWiki\Revision\RevisionSlots\hasSlot(), MediaWiki\Storage\RevisionSlotsUpdate\newFromRevisionSlots(), MediaWiki\Revision\MutableRevisionSlots\removeSlot(), and MediaWiki\Revision\MutableRevisionSlots\setSlot().

hasSameContent()

MediaWiki\Revision\RevisionSlots::hasSameContent

(

RevisionSlots

$other

)

Checks whether the other RevisionSlots instance has the same content as this instance.

Note that this does not mean that the slots have to be the same: they could for instance belong to different revisions.

Parameters

RevisionSlots

$other

Returns

bool

Definition at line 258 of file RevisionSlots.php.

References $s, $t, and MediaWiki\Revision\RevisionSlots\getSlots().

hasSlot()

MediaWiki\Revision\RevisionSlots::hasSlot

(

$role

)

Returns whether the given slot is set.

Parameters

string

$role

The role name of the desired slot

Returns

bool

Definition at line 133 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\$slots, and MediaWiki\Revision\RevisionSlots\getSlots().

setSlotsInternal()

MediaWiki\Revision\RevisionSlots::setSlotsInternal ( array  $slots )

private

Parameters

SlotRecord[]

$slots

Definition at line 65 of file RevisionSlots.php.

References MediaWiki\Revision\RevisionSlots\$slots.

Referenced by MediaWiki\Revision\RevisionSlots\__construct(), and MediaWiki\Revision\RevisionSlots\getSlots().

Member Data Documentation

$slots

SlotRecord [] callable MediaWiki\Revision\RevisionSlots::$slots

protected

Definition at line 44 of file RevisionSlots.php.

Referenced by MediaWiki\Revision\RevisionSlots\__construct(), MediaWiki\Revision\MutableRevisionSlots\__construct(), MediaWiki\Revision\RevisionSlots\computeSha1(), MediaWiki\Revision\RevisionSlots\getSlot(), MediaWiki\Revision\RevisionSlots\getSlotRoles(), MediaWiki\Revision\RevisionSlots\getSlots(), MediaWiki\Revision\RevisionSlots\hasSlot(), MediaWiki\Revision\MutableRevisionSlots\newFromParentRevisionSlots(), and MediaWiki\Revision\RevisionSlots\setSlotsInternal().

---

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

• includes/Revision/RevisionSlots.php