Go to the documentation of this file.
15 'wgExtraNamespaces' => [
17 12313 =>
'Dummy_talk',
21 'wgNamespaceContentModels' => [
24 'wgContentHandlers' => [
30 'testing' =>
'DummyContentHandlerForTesting',
31 'testing-callbacks' =>
function( $modelId ) {
41 MediaWikiServices::getInstance()->resetServiceForTesting(
'LinkCache' );
51 MediaWikiServices::getInstance()->resetServiceForTesting(
'LinkCache' );
57 $this->
insertPage(
'Not_Main_Page',
'This is not a main page' );
58 $this->
insertPage(
'Smithee',
'A smithee is one who smiths. See also [[Alan Smithee]]' );
106 $this->assertEquals( $expectedContentModel,
$handler->getModelID() );
127 $this->assertNotNull(
$name,
"no name found for content model $id" );
128 $this->assertTrue( preg_match( $expected,
$name ) > 0,
129 "content model name for #$id did not match pattern $expected"
132 $this->assertEquals( $id,
$name,
"localization of unknown model $id should have "
133 .
"fallen back to use the model id directly."
144 [
"MediaWiki:common.js",
'en' ],
145 [
"User:Foo/common.js",
'en' ],
146 [
"MediaWiki:common.css",
'en' ],
147 [
"User:Foo/common.css",
'en' ],
159 if ( is_string(
$title ) ) {
169 $this->assertEquals( $expected->getCode(),
$lang->getCode() );
185 $this->
setMwGlobals(
'wgContentHandlerTextFallback', $contentHandlerTextFallback );
190 $this->assertEquals(
'', $text );
206 $this->
setMwGlobals(
'wgContentHandlerTextFallback', $contentHandlerTextFallback );
211 $this->assertEquals(
$content->getNativeData(), $text );
220 $this->
setMwGlobals(
'wgContentHandlerTextFallback',
'fail' );
231 $this->
setMwGlobals(
'wgContentHandlerTextFallback',
'serialize' );
236 $this->assertEquals(
$content->serialize(), $text );
243 $this->
setMwGlobals(
'wgContentHandlerTextFallback',
'ignore' );
248 $this->assertNull( $text );
259 [
serialize(
'hallo' ),
'Dummy:Test',
null,
null,
"testing",
'hallo',
false ],
279 [
serialize(
'hallo' ),
'Dummy:Test',
null,
"testing",
"testing",
'hallo',
false ],
312 $expectedModelId, $expectedNativeData, $shouldFail
320 $this->fail(
"ContentHandler::makeContent should have failed!" );
323 $this->assertEquals( $expectedModelId,
$content->getModel(),
'bad model id' );
324 $this->assertEquals( $expectedNativeData,
$content->getNativeData(),
'bads native data' );
326 if ( !$shouldFail ) {
327 $this->fail(
"ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
330 $this->assertTrue(
true );
347 $autoSummary =
$content->getAutosummary(
null, $newContent, 97 );
348 $this->assertEquals( $autoSummary,
'Created blank page' );
350 $autoSummary =
$content->getAutosummary(
null, $newContent, 92 );
351 $this->assertEquals( $autoSummary,
'' );
362 $this->assertTrue(
$handler->supportsCategories(),
'content model supports categories' );
367 $this->assertFalse(
$handler->supportsDirectEditing(),
'direct editing is not supported' );
371 if ( $text ===
null || $text ===
false ) {
375 $text = strtoupper( $text );
387 [
'testing',
'DummyContentHandlerForTesting' ],
388 [
'testing-callbacks',
'DummyContentHandlerForTesting' ],
398 $this->assertInstanceOf( $handlerClass,
$handler );
406 $fields =
$handler->getFieldsForSearchIndex( $searchEngine );
408 $this->assertArrayHasKey(
'category', $fields );
409 $this->assertArrayHasKey(
'external_link', $fields );
410 $this->assertArrayHasKey(
'outgoing_link', $fields );
411 $this->assertArrayHasKey(
'template', $fields );
412 $this->assertArrayHasKey(
'content_model', $fields );
416 $searchEngine = $this->getMockBuilder(
'SearchEngine' )
419 $searchEngine->expects( $this->
any() )
420 ->method(
'makeSearchFieldMapping' )
421 ->will( $this->returnCallback(
function(
$name,
$type ) {
425 return $searchEngine;
432 $mockEngine = $this->createMock(
'SearchEngine' );
444 $fields[
'testDataField'] =
'test content';
448 $data =
$page->getContentHandler()->getDataForSearchIndex(
$page,
$output, $mockEngine );
449 $this->assertArrayHasKey(
'text', $data );
450 $this->assertArrayHasKey(
'text_bytes', $data );
451 $this->assertArrayHasKey(
'language', $data );
452 $this->assertArrayHasKey(
'testDataField', $data );
453 $this->assertEquals(
'test content', $data[
'testDataField'] );
454 $this->assertEquals(
'wikitext', $data[
'content_model'] );
464 $out =
$page->getContentHandler()->getParserOutputForIndexing(
$page );
466 $this->assertContains(
'one who smiths',
$out->getRawText() );
474 $models[] =
'Ferrari';
A content handler knows how do deal with a specific type of content on a wiki page.
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
processing should stop and the error should be shown to the user * false
testSupportsDirectEditing()
if(!isset( $args[0])) $lang
testGetPageLanguage( $title, $expected)
dataGetPageLanguage ContentHandler::getPageLanguage
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
testGetFieldsForSearchIndex()
Class representing a MediaWiki article and history.
static dataGetDefaultModelFor()
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
Allows to change the fields on the form that will be generated $name
const CONTENT_MODEL_WIKITEXT
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
static dataGetPageLanguage()
static dataGetContentText_Null()
static getDefaultModelFor(Title $title)
Returns the name of the default content model to be used for the page with the given title.
namespace and then decline to actually register it file or subcat img or subcat $title
static getContentModels()
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
testGetContentText_NonTextContent_ignore()
ContentHandler::getContentText.
testGetDefaultModelFor( $title, $expectedModelId)
dataGetDefaultModelFor ContentHandler::getDefaultModelFor
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
the value to return A Title object or null for latest all implement SearchIndexField $engine
when a variable name is used in a it is silently declared as a new masking the global
Content object for wiki text pages.
const CONTENT_FORMAT_WIKITEXT
testGetContentText_NonTextContent_fail()
ContentHandler::getContentText should have thrown an exception for non-text Content object MWExceptio...
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
testGetLocalizedName( $id, $expected)
dataGetLocalizedName ContentHandler::getLocalizedName
testGetModelForID( $modelId, $handlerClass)
provideGetModelForID
they could even be mouse clicks or menu items whatever suits your program You should also get your if any
static getLocalizedName( $name, Language $lang=null)
Returns the localized name for a given content model.
$wgLanguageCode
Site language code.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Contain a class for special pages.
Dummy implementation of SearchIndexFieldDefinition for testing purposes.
static getContentText(Content $content=null)
Convenience function for getting flat text from a Content object.
testParserOutputForIndexing()
ContentHandler::getParserOutputForIndexing.
static singleton()
Get an instance of this class.
testGetContentText_Null( $contentHandlerTextFallback)
dataGetContentText_Null ContentHandler::getContentText
static dataGetLocalizedName()
static getCanonicalNamespaces( $rebuild=false)
Returns array of all defined namespaces with their canonical (English) names.
testDataIndexFields()
ContentHandler::getDataForSearchIndex.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
static dataGetContentText_TextContent()
static factory( $code)
Get a cached or new language object for a given language code.
testGetContentText_TextContent( $contentHandlerTextFallback)
dataGetContentText_TextContent ContentHandler::getContentText
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
const CONTENT_MODEL_JAVASCRIPT
const CONTENT_FORMAT_JAVASCRIPT
testGetForTitle( $title, $expectedContentModel)
dataGetDefaultModelFor ContentHandler::getForTitle
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
testGetContentText_NonTextContent_serialize()
ContentHandler::getContentText.
static dummyHookHandler( $foo, &$text, $bar)
testGetContentModelsHook()
ContentHandler::getContentModels.
testMakeContent( $data, $title, $modelId, $format, $expectedModelId, $expectedNativeData, $shouldFail)
dataMakeContent ContentHandler::makeContent
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out