diff options
Diffstat (limited to 'includes')
| -rw-r--r-- | includes/block/AbstractBlock.php | 1 | ||||
| -rw-r--r-- | includes/changes/ChannelFeed.php | 4 | ||||
| -rw-r--r-- | includes/collation/Collation.php | 1 | ||||
| -rw-r--r-- | includes/gallery/ImageGalleryBase.php | 4 | ||||
| -rw-r--r-- | includes/jobqueue/JobQueue.php | 18 | ||||
| -rw-r--r-- | includes/user/CentralIdLookup.php | 3 |
6 files changed, 30 insertions, 1 deletions
diff --git a/includes/block/AbstractBlock.php b/includes/block/AbstractBlock.php index 7af51e842a1f..cc853649540c 100644 --- a/includes/block/AbstractBlock.php +++ b/includes/block/AbstractBlock.php @@ -32,6 +32,7 @@ use User; use Wikimedia\IPUtils; /** + * @note Extensions should not subclass this, as MediaWiki currently does not support custom block types. * @since 1.34 Factored out from DatabaseBlock (previously Block). */ abstract class AbstractBlock { diff --git a/includes/changes/ChannelFeed.php b/includes/changes/ChannelFeed.php index 80d2db75bbd3..10fd90dda3bb 100644 --- a/includes/changes/ChannelFeed.php +++ b/includes/changes/ChannelFeed.php @@ -24,6 +24,7 @@ /** * Class to support the outputting of syndication feeds in Atom and RSS format. * + * @stable for subclassing * @ingroup Feed */ abstract class ChannelFeed extends FeedItem { @@ -32,12 +33,15 @@ abstract class ChannelFeed extends FeedItem { protected $templateParser; /** + * @stable for calling + * * @param string|Title $title Feed's title * @param string $description * @param string $url URL uniquely designating the feed. * @param string $date Feed's date * @param string $author Author's user name * @param string $comments + * */ public function __construct( $title, $description, $url, $date = '', $author = '', $comments = '' diff --git a/includes/collation/Collation.php b/includes/collation/Collation.php index 80b4f64d77bc..cc4817b6dee5 100644 --- a/includes/collation/Collation.php +++ b/includes/collation/Collation.php @@ -25,6 +25,7 @@ use MediaWiki\MediaWikiServices; /** * @since 1.16.3 * @author Tim Starling + * @stable for subclassing */ abstract class Collation { private static $instance; diff --git a/includes/gallery/ImageGalleryBase.php b/includes/gallery/ImageGalleryBase.php index 2df5818c07dd..9aae713ef7d1 100644 --- a/includes/gallery/ImageGalleryBase.php +++ b/includes/gallery/ImageGalleryBase.php @@ -26,7 +26,7 @@ use MediaWiki\MediaWikiServices; * Image gallery * * Add images to the gallery using add(), then render that list to HTML using toHTML(). - * + * @stable for subclassing * @ingroup Media */ abstract class ImageGalleryBase extends ContextSource { @@ -258,6 +258,8 @@ abstract class ImageGalleryBase extends ContextSource { * to allow extensions to add additional parameters to * <gallery> parser tag. * + * @stable for overriding + * * @param array $options Attributes of gallery tag */ public function setAdditionalOptions( $options ) { diff --git a/includes/jobqueue/JobQueue.php b/includes/jobqueue/JobQueue.php index 8fa670b7c018..449f63e27ad4 100644 --- a/includes/jobqueue/JobQueue.php +++ b/includes/jobqueue/JobQueue.php @@ -30,6 +30,7 @@ use Wikimedia\UUID\GlobalIdGenerator; * * @ingroup JobQueue * @since 1.21 + * @stable for subclassing */ abstract class JobQueue { /** @var string DB domain ID */ @@ -57,6 +58,8 @@ abstract class JobQueue { protected const ROOTJOB_TTL = 2419200; // integer; seconds to remember root jobs (28 days) /** + * @stable for calling + * * @param array $params * - type : A job type * - domain : A DB domain ID @@ -68,6 +71,7 @@ abstract class JobQueue { * - order : Queue order, one of ("fifo", "timestamp", "random") [default: variable] * - readOnlyReason : Mark the queue as read-only with this reason [default: false] * @throws JobQueueError + * */ protected function __construct( array $params ) { $this->domain = $params['domain'] ?? $params['wiki']; // b/c @@ -187,6 +191,7 @@ abstract class JobQueue { /** * Find out if delayed jobs are supported for configuration validation * + * @stable for overriding * @return bool Whether delayed jobs are supported */ protected function supportsDelayedJobs() { @@ -292,6 +297,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::getDelayedCount() * @return int */ @@ -315,6 +321,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::getAbandonedCount() * @return int */ @@ -478,6 +485,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::deduplicateRootJob() * @param IJobSpecification $job * @throws JobQueueError @@ -519,6 +527,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::isRootJobOldDuplicate() * @param IJobSpecification $job * @return bool @@ -569,6 +578,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::delete() * @throws JobQueueError */ @@ -589,6 +599,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::waitForBackups() * @return void */ @@ -605,6 +616,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::flushCaches() * @return void */ @@ -625,6 +637,7 @@ abstract class JobQueue { * Get an iterator to traverse over all delayed jobs in this queue. * Note: results may be stale if the queue is concurrently modified. * + * @stable for overriding * @return Iterator * @throws JobQueueError * @since 1.22 @@ -639,6 +652,7 @@ abstract class JobQueue { * Callers should be quick to iterator over it or few results * will be returned due to jobs being acknowledged and deleted * + * @stable for overriding * @return Iterator * @throws JobQueueError * @since 1.26 @@ -650,6 +664,7 @@ abstract class JobQueue { /** * Get an iterator to traverse over all abandoned jobs in this queue * + * @stable for overriding * @return Iterator * @throws JobQueueError * @since 1.25 @@ -661,6 +676,7 @@ abstract class JobQueue { /** * Do not use this function outside of JobQueue/JobQueueGroup * + * @stable for overriding * @return string * @since 1.22 */ @@ -682,6 +698,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::getSiblingQueuesWithJobs() * @param array $types List of queues types * @return array|null (list of queue types) or null if unsupported @@ -705,6 +722,7 @@ abstract class JobQueue { } /** + * @stable for overriding * @see JobQueue::getSiblingQueuesSize() * @param array $types List of queues types * @return array|null (list of queue types) or null if unsupported diff --git a/includes/user/CentralIdLookup.php b/includes/user/CentralIdLookup.php index e7f26b6451c9..711e2dc41327 100644 --- a/includes/user/CentralIdLookup.php +++ b/includes/user/CentralIdLookup.php @@ -26,6 +26,7 @@ use Wikimedia\ObjectFactory; * cluster-wide IDs. * * @since 1.27 + * @stable for subclassing */ abstract class CentralIdLookup implements IDBAccessObject { // Audience options for accessors @@ -222,6 +223,7 @@ abstract class CentralIdLookup implements IDBAccessObject { * Given a central user ID, return a local User object * @note Unlike nameFromCentralId(), this does guarantee that the local * user exists and is attached to the central account. + * @stable for overriding * @param int $id Central user ID * @param int|User $audience One of the audience constants, or a specific user * @param int $flags IDBAccessObject read flags @@ -244,6 +246,7 @@ abstract class CentralIdLookup implements IDBAccessObject { /** * Given a local User object, return the central ID + * @stable for overriding * @note Unlike centralIdFromName(), this does guarantee that the local * user is attached to the central account. * @param User $user Local user |