aboutsummaryrefslogtreecommitdiffstats
path: root/includes
diff options
context:
space:
mode:
Diffstat (limited to 'includes')
-rw-r--r--includes/EditPage.php8
-rw-r--r--includes/content/AbstractContent.php11
-rw-r--r--includes/content/Content.php3
-rw-r--r--includes/content/ContentHandler.php123
-rw-r--r--includes/content/CssContentHandler.php13
-rw-r--r--includes/content/JavaScriptContentHandler.php13
-rw-r--r--includes/content/JsonContentHandler.php13
-rw-r--r--includes/content/TextContentHandler.php13
-rw-r--r--includes/content/Transform/ContentTransformer.php23
-rw-r--r--includes/content/Transform/PreloadTransformParams.php27
-rw-r--r--includes/content/Transform/PreloadTransformParamsValue.php50
-rw-r--r--includes/content/WikitextContent.php18
-rw-r--r--includes/content/WikitextContentHandler.php53
13 files changed, 309 insertions, 59 deletions
diff --git a/includes/EditPage.php b/includes/EditPage.php
index dc26f7db9bc2..b442c664eb1d 100644
--- a/includes/EditPage.php
+++ b/includes/EditPage.php
@@ -1602,7 +1602,13 @@ class EditPage implements IEditObject {
$content = $converted;
}
- return $content->preloadTransform( $title, $parserOptions, $params );
+ $contentTransformer = MediaWikiServices::getInstance()->getContentTransformer();
+ return $contentTransformer->preloadTransform(
+ $content,
+ $title,
+ $parserOptions,
+ $params
+ );
}
/**
diff --git a/includes/content/AbstractContent.php b/includes/content/AbstractContent.php
index 09412f652c04..45b62fb0f52b 100644
--- a/includes/content/AbstractContent.php
+++ b/includes/content/AbstractContent.php
@@ -27,6 +27,7 @@
*/
use MediaWiki\Content\IContentHandlerFactory;
+use MediaWiki\Content\Transform\PreloadTransformParamsValue;
use MediaWiki\Content\Transform\PreSaveTransformParamsValue;
use MediaWiki\MediaWikiServices;
@@ -420,9 +421,9 @@ abstract class AbstractContent implements Content {
}
/**
- * @stable to override
* @since 1.21
- *
+ * @deprecated since 1.37. Use ContentTransformer::preloadTransform instead.
+ * Extensions defining a content model should override ContentHandler::preloadTransform.
* @param Title $title
* @param ParserOptions $popts
* @param array $params
@@ -431,7 +432,11 @@ abstract class AbstractContent implements Content {
* @see Content::preloadTransform
*/
public function preloadTransform( Title $title, ParserOptions $popts, $params = [] ) {
- return $this;
+ $pltParams = new PreloadTransformParamsValue( $title, $popts, $params );
+ return $this->getContentHandler()->preloadTransform(
+ $this,
+ $pltParams
+ );
}
/**
diff --git a/includes/content/Content.php b/includes/content/Content.php
index def770585b87..df89b3cf916d 100644
--- a/includes/content/Content.php
+++ b/includes/content/Content.php
@@ -415,7 +415,8 @@ interface Content {
* object if no transformations apply).
*
* @since 1.21
- *
+ * @deprecated since 1.37 Use ContentTransformer::preloadTransform
+ * and override ContentHandler::preloadTransform.
* @param Title $title
* @param ParserOptions $parserOptions
* @param array $params
diff --git a/includes/content/ContentHandler.php b/includes/content/ContentHandler.php
index fbf75edb9542..c12912a021d6 100644
--- a/includes/content/ContentHandler.php
+++ b/includes/content/ContentHandler.php
@@ -26,6 +26,7 @@
* @author Daniel Kinzler
*/
+use MediaWiki\Content\Transform\PreloadTransformParams;
use MediaWiki\Content\Transform\PreSaveTransformParams;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Logger\LoggerFactory;
@@ -1546,37 +1547,117 @@ abstract class ContentHandler {
Content $content,
PreSaveTransformParams $pstParams
): Content {
- $deprecatedContent = $this->maybeCallDeprecatedContentPST( $content, $pstParams );
- if ( $deprecatedContent ) {
- return $deprecatedContent;
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
+ $content,
+ $pstParams
+ );
+
+ if ( !$shouldCallDeprecatedMethod ) {
+ return $content;
}
- return $content;
+
+ return $this->callDeprecatedContentPST(
+ $content,
+ $pstParams
+ );
}
/**
- * If provided content overrides deprecated Content::preSaveTransform,
- * call it and return. Otherwise return null.
- * @internal only core ContentHandler implementations need to call this.
+ * Returns a $content object with preload transformations applied (or the same
+ * object if no transformations apply).
+ *
+ * @note Not stable to call other then from ContentHandler hierarchy.
+ * Callers need to use ContentTransformer::preLoadTransform.
+ * @stable to override
+ * @since 1.37
*
* @param Content $content
- * @param PreSaveTransformParams $pstParams
- * @return ?Content
+ * @param PreloadTransformParams $pltParams
+ *
+ * @return Content
*/
- protected function maybeCallDeprecatedContentPST(
+ public function preloadTransform(
Content $content,
- PreSaveTransformParams $pstParams
- ): ?Content {
- $contentOverridesTransform = MWDebug::detectDeprecatedOverride(
+ PreloadTransformParams $pltParams
+ ): Content {
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
$content,
- AbstractContent::class,
- 'preSaveTransform'
+ $pltParams
);
- if ( $contentOverridesTransform ) {
- $services = MediaWikiServices::getInstance();
- $legacyUser = $services->getUserFactory()->newFromUserIdentity( $pstParams->getUser() );
- $legacyTitle = $services->getTitleFactory()->castFromPageReference( $pstParams->getPage() );
- return $content->preSaveTransform( $legacyTitle, $legacyUser, $pstParams->getParserOptions() );
+
+ if ( !$shouldCallDeprecatedMethod ) {
+ return $content;
}
- return null;
+
+ return $this->callDeprecatedContentPLT(
+ $content,
+ $pltParams
+ );
+ }
+
+ /**
+ * Check if we need to provide content overrides deprecated Content method.
+ *
+ * @internal only core ContentHandler implementations need to call this.
+ * @param Content $content
+ * @param PreSaveTransformParams|PreloadTransformParams $params
+ * @return bool
+ */
+ protected function shouldCallDeprecatedContentTransformMethod(
+ Content $content,
+ $params
+ ): bool {
+ $method = $params instanceof PreSaveTransformParams
+ ? "preSaveTransform"
+ : "preloadTransform";
+ return MWDebug::detectDeprecatedOverride(
+ $content,
+ AbstractContent::class,
+ $method
+ );
+ }
+
+ /**
+ * Provided content overrides deprecated Content::preSaveTransform,
+ * call it and return.
+ * @internal only core ContentHandler implementations need to call this.
+ * @param Content $content
+ * @param PreSaveTransformParams $params
+ * @return Content
+ */
+ protected function callDeprecatedContentPST(
+ Content $content,
+ PreSaveTransformParams $params
+ ): Content {
+ $services = MediaWikiServices::getInstance();
+ $legacyUser = $services->getUserFactory()->newFromUserIdentity( $params->getUser() );
+ $legacyTitle = $services->getTitleFactory()->castFromPageReference( $params->getPage() );
+
+ return $content->preSaveTransform(
+ $legacyTitle,
+ $legacyUser,
+ $params->getParserOptions()
+ );
+ }
+
+ /**
+ * If provided content overrides deprecated Content::preloadTransform,
+ * call it and return.
+ * @internal only core ContentHandler implementations need to call this.
+ * @param Content $content
+ * @param PreloadTransformParams $params
+ * @return Content
+ */
+ protected function callDeprecatedContentPLT(
+ Content $content,
+ PreloadTransformParams $params
+ ): Content {
+ $services = MediaWikiServices::getInstance();
+ $legacyTitle = $services->getTitleFactory()->castFromPageReference( $params->getPage() );
+ return $content->preloadTransform(
+ $legacyTitle,
+ $params->getParserOptions(),
+ $params->getParams()
+ );
}
}
diff --git a/includes/content/CssContentHandler.php b/includes/content/CssContentHandler.php
index 092d36d6cd54..06bc41c609f8 100644
--- a/includes/content/CssContentHandler.php
+++ b/includes/content/CssContentHandler.php
@@ -66,9 +66,16 @@ class CssContentHandler extends CodeContentHandler {
Content $content,
PreSaveTransformParams $pstParams
): Content {
- $deprecatedContent = $this->maybeCallDeprecatedContentPST( $content, $pstParams );
- if ( $deprecatedContent ) {
- return $deprecatedContent;
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
+ $content,
+ $pstParams
+ );
+
+ if ( $shouldCallDeprecatedMethod ) {
+ return $this->callDeprecatedContentPST(
+ $content,
+ $pstParams
+ );
}
'@phan-var CssContent $content';
diff --git a/includes/content/JavaScriptContentHandler.php b/includes/content/JavaScriptContentHandler.php
index 3c30bca5160b..c236d5b54504 100644
--- a/includes/content/JavaScriptContentHandler.php
+++ b/includes/content/JavaScriptContentHandler.php
@@ -67,9 +67,16 @@ class JavaScriptContentHandler extends CodeContentHandler {
Content $content,
PreSaveTransformParams $pstParams
): Content {
- $deprecatedContent = $this->maybeCallDeprecatedContentPST( $content, $pstParams );
- if ( $deprecatedContent ) {
- return $deprecatedContent;
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
+ $content,
+ $pstParams
+ );
+
+ if ( $shouldCallDeprecatedMethod ) {
+ return $this->callDeprecatedContentPST(
+ $content,
+ $pstParams
+ );
}
'@phan-var JavascriptContent $content';
diff --git a/includes/content/JsonContentHandler.php b/includes/content/JsonContentHandler.php
index 52007fd4901d..962c838a3138 100644
--- a/includes/content/JsonContentHandler.php
+++ b/includes/content/JsonContentHandler.php
@@ -51,9 +51,16 @@ class JsonContentHandler extends CodeContentHandler {
Content $content,
PreSaveTransformParams $pstParams
): Content {
- $deprecatedContent = $this->maybeCallDeprecatedContentPST( $content, $pstParams );
- if ( $deprecatedContent ) {
- return $deprecatedContent;
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
+ $content,
+ $pstParams
+ );
+
+ if ( $shouldCallDeprecatedMethod ) {
+ return $this->callDeprecatedContentPST(
+ $content,
+ $pstParams
+ );
}
'@phan-var JsonContent $content';
diff --git a/includes/content/TextContentHandler.php b/includes/content/TextContentHandler.php
index 3729b75ea31c..9c6c7f8a187d 100644
--- a/includes/content/TextContentHandler.php
+++ b/includes/content/TextContentHandler.php
@@ -166,9 +166,16 @@ class TextContentHandler extends ContentHandler {
Content $content,
PreSaveTransformParams $pstParams
): Content {
- $deprecatedContent = $this->maybeCallDeprecatedContentPST( $content, $pstParams );
- if ( $deprecatedContent ) {
- return $deprecatedContent;
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
+ $content,
+ $pstParams
+ );
+
+ if ( $shouldCallDeprecatedMethod ) {
+ return $this->callDeprecatedContentPST(
+ $content,
+ $pstParams
+ );
}
'@phan-var TextContent $content';
diff --git a/includes/content/Transform/ContentTransformer.php b/includes/content/Transform/ContentTransformer.php
index 2229f4b86ba0..01288b887021 100644
--- a/includes/content/Transform/ContentTransformer.php
+++ b/includes/content/Transform/ContentTransformer.php
@@ -45,4 +45,27 @@ class ContentTransformer {
return $contentHandler->preSaveTransform( $content, $pstParams );
}
+
+ /**
+ * Returns a Content object with preload transformations applied (or $content
+ * if no transformations apply).
+ *
+ * @param Content $content
+ * @param PageReference $page
+ * @param ParserOptions $parserOptions
+ * @param array $params
+ *
+ * @return Content
+ */
+ public function preloadTransform(
+ Content $content,
+ PageReference $page,
+ ParserOptions $parserOptions,
+ array $params = []
+ ): Content {
+ $contentHandler = $this->contentHandlerFactory->getContentHandler( $content->getModel() );
+ $pltParams = new PreloadTransformParamsValue( $page, $parserOptions, $params );
+
+ return $contentHandler->preloadTransform( $content, $pltParams );
+ }
}
diff --git a/includes/content/Transform/PreloadTransformParams.php b/includes/content/Transform/PreloadTransformParams.php
new file mode 100644
index 000000000000..92277904c663
--- /dev/null
+++ b/includes/content/Transform/PreloadTransformParams.php
@@ -0,0 +1,27 @@
+<?php
+namespace MediaWiki\Content\Transform;
+
+use MediaWiki\Page\PageReference;
+use ParserOptions;
+
+/**
+ * @since 1.37
+ * An interface to hold pre-load transform params.
+ */
+interface PreloadTransformParams {
+
+ /**
+ * @return PageReference
+ */
+ public function getPage(): PageReference;
+
+ /**
+ * @return array
+ */
+ public function getParams(): array;
+
+ /**
+ * @return ParserOptions
+ */
+ public function getParserOptions(): ParserOptions;
+}
diff --git a/includes/content/Transform/PreloadTransformParamsValue.php b/includes/content/Transform/PreloadTransformParamsValue.php
new file mode 100644
index 000000000000..f1f1fbeb2be2
--- /dev/null
+++ b/includes/content/Transform/PreloadTransformParamsValue.php
@@ -0,0 +1,50 @@
+<?php
+namespace MediaWiki\Content\Transform;
+
+use MediaWiki\Page\PageReference;
+use ParserOptions;
+
+/**
+ * @internal
+ * An object to hold preload transform params.
+ */
+class PreloadTransformParamsValue implements PreloadTransformParams {
+ /** @var PageReference */
+ private $page;
+
+ /** @var array */
+ private $params;
+
+ /** @var ParserOptions */
+ private $parserOptions;
+
+ public function __construct( PageReference $page, ParserOptions $parserOptions, array $params = [] ) {
+ $this->page = $page;
+ $this->parserOptions = $parserOptions;
+ $this->params = $params;
+ }
+
+ /**
+ *
+ * @return PageReference
+ */
+ public function getPage(): PageReference {
+ return $this->page;
+ }
+
+ /**
+ *
+ * @return array
+ */
+ public function getParams(): array {
+ return $this->params;
+ }
+
+ /**
+ *
+ * @return ParserOptions
+ */
+ public function getParserOptions(): ParserOptions {
+ return $this->parserOptions;
+ }
+}
diff --git a/includes/content/WikitextContent.php b/includes/content/WikitextContent.php
index df4222f0a6bb..cf5db6750981 100644
--- a/includes/content/WikitextContent.php
+++ b/includes/content/WikitextContent.php
@@ -142,24 +142,6 @@ class WikitextContent extends TextContent {
}
/**
- * Returns a Content object with preload transformations applied (or this
- * object if no transformations apply).
- *
- * @param Title $title
- * @param ParserOptions $popts
- * @param array $params
- *
- * @return Content
- */
- public function preloadTransform( Title $title, ParserOptions $popts, $params = [] ) {
- $text = $this->getText();
- $plt = MediaWikiServices::getInstance()->getParser()
- ->getPreloadText( $text, $title, $popts, $params );
-
- return new static( $plt );
- }
-
- /**
* Extract the redirect target and the remaining text on the page.
*
* @note migrated here from Title::newFromRedirectInternal()
diff --git a/includes/content/WikitextContentHandler.php b/includes/content/WikitextContentHandler.php
index d1f543406d27..66d94a80b786 100644
--- a/includes/content/WikitextContentHandler.php
+++ b/includes/content/WikitextContentHandler.php
@@ -23,6 +23,7 @@
* @ingroup Content
*/
+use MediaWiki\Content\Transform\PreloadTransformParams;
use MediaWiki\Content\Transform\PreSaveTransformParams;
use MediaWiki\Languages\LanguageNameUtils;
use MediaWiki\MediaWikiServices;
@@ -193,9 +194,16 @@ class WikitextContentHandler extends TextContentHandler {
Content $content,
PreSaveTransformParams $pstParams
): Content {
- $deprecatedContent = $this->maybeCallDeprecatedContentPST( $content, $pstParams );
- if ( $deprecatedContent ) {
- return $deprecatedContent;
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
+ $content,
+ $pstParams
+ );
+
+ if ( $shouldCallDeprecatedMethod ) {
+ return $this->callDeprecatedContentPST(
+ $content,
+ $pstParams
+ );
}
'@phan-var WikitextContent $content';
@@ -219,4 +227,43 @@ class WikitextContentHandler extends TextContentHandler {
$ret->setPreSaveTransformFlags( $parser->getOutput()->getAllFlags() );
return $ret;
}
+
+ /**
+ * Returns a Content object with preload transformations applied (or this
+ * object if no transformations apply).
+ *
+ * @param Content $content
+ * @param PreloadTransformParams $pltParams
+ *
+ * @return Content
+ */
+ public function preloadTransform(
+ Content $content,
+ PreloadTransformParams $pltParams
+ ): Content {
+ $shouldCallDeprecatedMethod = $this->shouldCallDeprecatedContentTransformMethod(
+ $content,
+ $pltParams
+ );
+
+ if ( $shouldCallDeprecatedMethod ) {
+ return $this->callDeprecatedContentPLT(
+ $content,
+ $pltParams
+ );
+ }
+
+ '@phan-var WikitextContent $content';
+
+ $text = $content->getText();
+ $plt = MediaWikiServices::getInstance()->getParser()->getPreloadText(
+ $text,
+ $pltParams->getPage(),
+ $pltParams->getParserOptions(),
+ $pltParams->getParams()
+ );
+
+ $contentClass = $this->getContentClass();
+ return new $contentClass( $plt );
+ }
}
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-25 22:33:59 +0000