mediawiki-extensions-Descri.../includes/DescriptionProvider.php

<?php

namespace MediaWiki\Extension\Description2;

interface DescriptionProvider {
	/**
	 * Extracts description from the HTML representation of a page.
	 *
	 * @param string $text HTML to extract the description from.
	 * @return ?string Plain text, or null if no description could have been generated
	 */
	public function derive( string $text ): ?string;
}
Extract description algorithm into a new class Separating the extract algorithm from integration code. This results in a slightly cleaner code structure (at least in my opinion) and enables adding alternate algorithms without devolving into spaghetti. The DescriptionProvider (name of the new base interface) is exposed as a service through dependency injection to avoid factories. The implementation can be swapped at service instantiation time. Depends-On: I73c61ce045dcf31ac1ca5888f1548de8fd8b56ff Change-Id: I97fd065c9554837747021ba9fff26005e33270f4 2023-12-04 19:54:13 +00:00			`<?php`

			`namespace MediaWiki\Extension\Description2;`

			`interface DescriptionProvider {`
			`/**`
			`* Extracts description from the HTML representation of a page.`
			`*`
			`* @param string $text HTML to extract the description from.`
Truncate descriptions to a certain length With this change, generated descriptions are cut at 300 characters, without breaking words when possible, and with an ellipsis added in case the cut happened mid-sentence. The `Description2::getFirstChars` function was borrowed from TextExtracts with minor alterations (added comment for their regex, and removed `>` from word healing given it's unclear why it's been included). New configuration variable `$wgDescriptionMaxChars` (proposed default: 300, which seems like a sensible amount) controls this behaviour. This has been in testing on ark.wiki.gg (with the platform's approval, which I'm glad for) since early September. Without this change, we had a few pages with little sections having a huge part of their body text thrown into the `description` meta tag... Depends-On: I585f2c0046571310aad67f3ba148c4f22aaae49f Change-Id: I04b00f99085f07f773212ee3eca8470eece34e9e 2023-12-04 20:02:52 +00:00			`* @return ?string Plain text, or null if no description could have been generated`
Extract description algorithm into a new class Separating the extract algorithm from integration code. This results in a slightly cleaner code structure (at least in my opinion) and enables adding alternate algorithms without devolving into spaghetti. The DescriptionProvider (name of the new base interface) is exposed as a service through dependency injection to avoid factories. The implementation can be swapped at service instantiation time. Depends-On: I73c61ce045dcf31ac1ca5888f1548de8fd8b56ff Change-Id: I97fd065c9554837747021ba9fff26005e33270f4 2023-12-04 19:54:13 +00:00			`*/`
			`public function derive( string $text ): ?string;`
			`}`