MediaWiki master
MediaWiki\EditPage\IntroMessageList Class Reference

Encapsulates a list of edit form intro messages (as HTML) with their identifiers. More...

Public Member Functions

 __construct (int $frames, array $skip=[])
 add (Message $msg, string $wrap=' $1')
 addWithKey (string $key, string $html, string $wrap=' $1')
 getList ()

Public Attributes

array array< string, string > $list = []

Detailed Description

Encapsulates a list of edit form intro messages (as HTML) with their identifiers.

Access: internal

Definition at line 13 of file IntroMessageList.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\EditPage\IntroMessageList::__construct ( int $frames,
array $skip = [] )
int$framesSome intro messages come with optional wrapper frames. Pass IntroMessageBuilder::MORE_FRAMES to include the frames whenever possible, or IntroMessageBuilder::LESS_FRAMES to omit them whenever possible.
string[]$skipIdentifiers of messages not to generate

Definition at line 27 of file IntroMessageList.php.

References MediaWiki\EditPage\IntroMessageBuilder\LESS_FRAMES, and MediaWiki\EditPage\IntroMessageBuilder\MORE_FRAMES.

Member Function Documentation

◆ add()

MediaWiki\EditPage\IntroMessageList::add ( Message $msg,
string $wrap = '$1' )

◆ addWithKey()

MediaWiki\EditPage\IntroMessageList::addWithKey ( string $key,
string $html,
string $wrap = '$1' )

Definition at line 48 of file IntroMessageList.php.

◆ getList()

MediaWiki\EditPage\IntroMessageList::getList ( )

Definition at line 58 of file IntroMessageList.php.

Member Data Documentation

◆ $list

array array<string,string> MediaWiki\EditPage\IntroMessageList::$list = []

Definition at line 15 of file IntroMessageList.php.

The documentation for this class was generated from the following file: