mediawiki-extensions-Echo/includes/Bundleable.php
Thiemo Kreuz 75a55b80ee Remove some non-helpful lines of documentation
Explaining that a variable named "$username" contains a "username" is
not helpful. One have to read this comment first to understand that it
does not add anything to what's already obvious from the variable name
and the type.

Change-Id: I9a43866498d0c94422caf16233f502320a8e36c9
2018-07-06 15:14:44 +00:00

28 lines
593 B
PHP

<?php
/**
* Indicates that an object can be bundled.
*/
interface Bundleable {
/**
* @return bool Whether this object can be bundled.
*/
public function canBeBundled();
/**
* @return string objects with the same bundling key can be bundled together
*/
public function getBundlingKey();
/**
* @param Bundleable[] $bundleables other object that have been bundled with this one
*/
public function setBundledElements( $bundleables );
/**
* @return mixed the key by which this object should be sorted during the bundling process
*/
public function getSortingKey();
}