c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
27 lines
926 B
PHP
27 lines
926 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Content\Hook;
|
|
|
|
use Content;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface ConvertContentHook {
|
|
/**
|
|
* This hook is called by AbstractContent::convert when a conversion to another content model
|
|
* is requested. Handler functions that modify $result should generally return false to disable
|
|
* further attempts at conversion.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param Content $content Content object to be converted
|
|
* @param string $toModel ID of the content model to convert to
|
|
* @param bool $lossy Whether lossy conversion is allowed
|
|
* @param Content &$result Output parameter, in case the handler function wants to provide a
|
|
* converted Content object. Note that $result->getContentModel() must return $toModel.
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onConvertContent( $content, $toModel, $lossy, &$result );
|
|
}
|