6806400129
Reasons for touching this are:
* "@param type $var" were mixed in a lot of places. Both works but the
MediaWiki coding conventions suggest that specific order.
* Things like String and Bool aren't objects and shouldn't be uppercase.
* Tried to fill missing types in "@param $var".
* Tried to fill missing descriptions in "@return type" when I could.
* Removed duplicate descriptions if a @see is sufficend.
* Removed useless descriptions ("isUsefull returns true if usefull").
* Removed useless @return void.
* Replaces mixed[] with array (does have the exact same meaning).
* Tried to find better replacements for "varargs", phpDocumentor
suggest $var,...
* Order should be @since, @param, @throws, @return, @see. This is the
order Doxygen renders this.
There is always more to do but I think this is already much better
than before. Please feel free to put more change sets on top of mine
or request more changes by adding comments.
Change-Id: I05262ce06caabf79f68772302524ac91bbead1c6
122 lines
3.4 KiB
PHP
122 lines
3.4 KiB
PHP
<?php
|
|
/**
|
|
* Base content handler class for flat text contents.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @file
|
|
* @ingroup Content
|
|
*/
|
|
|
|
/**
|
|
* Base content handler implementation for flat text contents.
|
|
*
|
|
* @ingroup Content
|
|
*/
|
|
class TextContentHandler extends ContentHandler {
|
|
|
|
// @codingStandardsIgnoreStart bug 57585
|
|
public function __construct( $modelId = CONTENT_MODEL_TEXT,
|
|
$formats = array( CONTENT_FORMAT_TEXT ) ) {
|
|
parent::__construct( $modelId, $formats );
|
|
}
|
|
// @codingStandardsIgnoreEnd
|
|
|
|
/**
|
|
* Returns the content's text as-is.
|
|
*
|
|
* @param Content $content
|
|
* @param string $format The serialization format to check
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function serializeContent( Content $content, $format = null ) {
|
|
$this->checkFormat( $format );
|
|
|
|
return $content->getNativeData();
|
|
}
|
|
|
|
/**
|
|
* Attempts to merge differences between three versions. Returns a new
|
|
* Content object for a clean merge and false for failure or a conflict.
|
|
*
|
|
* All three Content objects passed as parameters must have the same
|
|
* content model.
|
|
*
|
|
* This text-based implementation uses wfMerge().
|
|
*
|
|
* @param Content|string $oldContent The page's previous content.
|
|
* @param Content|string $myContent One of the page's conflicting contents.
|
|
* @param Content|string $yourContent One of the page's conflicting contents.
|
|
*
|
|
* @return Content|bool
|
|
*/
|
|
public function merge3( Content $oldContent, Content $myContent, Content $yourContent ) {
|
|
$this->checkModelID( $oldContent->getModel() );
|
|
$this->checkModelID( $myContent->getModel() );
|
|
$this->checkModelID( $yourContent->getModel() );
|
|
|
|
$format = $this->getDefaultFormat();
|
|
|
|
$old = $this->serializeContent( $oldContent, $format );
|
|
$mine = $this->serializeContent( $myContent, $format );
|
|
$yours = $this->serializeContent( $yourContent, $format );
|
|
|
|
$ok = wfMerge( $old, $mine, $yours, $result );
|
|
|
|
if ( !$ok ) {
|
|
return false;
|
|
}
|
|
|
|
if ( !$result ) {
|
|
return $this->makeEmptyContent();
|
|
}
|
|
|
|
$mergedContent = $this->unserializeContent( $result, $format );
|
|
|
|
return $mergedContent;
|
|
}
|
|
|
|
/**
|
|
* Unserializes a Content object of the type supported by this ContentHandler.
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $text Serialized form of the content
|
|
* @param string $format The format used for serialization
|
|
*
|
|
* @return Content The TextContent object wrapping $text
|
|
*/
|
|
public function unserializeContent( $text, $format = null ) {
|
|
$this->checkFormat( $format );
|
|
|
|
return new TextContent( $text );
|
|
}
|
|
|
|
/**
|
|
* Creates an empty TextContent object.
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return Content A new TextContent object with empty text.
|
|
*/
|
|
public function makeEmptyContent() {
|
|
return new TextContent( '' );
|
|
}
|
|
|
|
}
|