View source for Manual:HTMLForm Tutorial/ja

<languages />
<span lang="en" dir="ltr" class="mw-content-ltr">{{ll|HTMLForm}} is a powerful and easy helper to build forms within MediaWiki.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This tutorial will help {{ll|Manual:Special pages}} developers to get started with HTMLForm.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
(HTMLForm being a front-end helper, it's assumed that you are developing a front-end extension. ie: a special page)
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">The rest of this page is about the basics of creating a generic special page extension called MyForm.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This is not directly related to this tutorial, but it won't hurt to show how the extension should look like.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">At the bottom of the page the Special:MyForm displays "Hello World".</span>

{{ll|Manual:HTMLForm Tutorial 2|2=<span lang="en" dir="ltr" class="mw-content-ltr">Skip the newbie part and directly go to the HTMLForm stuff</span>}}

<div lang="en" dir="ltr" class="mw-content-ltr">
Otherwise, let's get started...
</div>

<span id="Files_and_environment"></span>
== ファイルと環境 ==
:''<span lang="en" dir="ltr" class="mw-content-ltr">This explanation applies to MediaWiki version 1.23 and later.</span>''

<span lang="en" dir="ltr" class="mw-content-ltr">HTMLForm classes are located at <code>/mediawiki/includes/HTMLForm.php</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The code is pretty clean and well-documented enough, that should make MW Hackers happy.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Your SpecialPage is in an extension called MyForm. You'll find it by accessing Special:MyForm.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Your SpecialPage's front-end code can be at:
</div>
<code>/mediawiki/extensions/MyForm/MyForm_body.php</code>
<div lang="en" dir="ltr" class="mw-content-ltr">
This previous file enclosing both View/Controller, the Model (main file of your extension) can be at:
</div>
<code>/mediawiki/extensions/MyForm/MyForm.php</code>
<div lang="en" dir="ltr" class="mw-content-ltr">
The {{ll|i18n}} files can be found in the folder:
</div>
<code>/mediawiki/extensions/MyForm/i18n</code>
<div lang="en" dir="ltr" class="mw-content-ltr">
Then .hooks, .alias... etc.
</div>

== MyForm.php ==
{{Note|1=<span lang="en" dir="ltr" class="mw-content-ltr">New extensions should use [[Special:MyLanguage/Manual:Extension registration|Extension registration]] instead.</span>}}
<syntaxhighlight lang="php">
<?php
/**
 * Necessary description of @file, @authors and license
 * @FILLME!
 * Always good to remind that important part
 */
 
// Avoid illegal processing, doesn't cost much, but unnecessary on a correct installation
if ( !defined( 'MEDIAWIKI' ) ) { 
	die( -1 ); 
} 

// Extension Declaration
$wgExtensionCredits['specialpage'][] = [
	'path' => __FILE__,
	'name' => 'MyForm',
	'author' => 'My Name',
	'version' => '0.1.0',
	'url' => 'https://www.mediawiki.org/',
	'descriptionmsg' => 'myf-desc',
];

// A var to ease the referencing of files
$dir = __DIR__ . '/';

// i18n file referencing
$wgExtensionMessagesFiles['MyForm'] = $dir . 'MyForm.i18n.php';
// View file referencing
$wgAutoloadClasses['SpecialMyForm'] = $dir . 'MyForm_body.php';
// SpecialPage referencing
$wgSpecialPages['MyForm'] = 'SpecialMyForm';

// The Logic for your extension should be somewhere around here.

// NO PHP Closing bracket "? >". This is pure code.
</syntaxhighlight>

== LocalSettings.php ==
<span lang="en" dir="ltr" class="mw-content-ltr">Do not forget to install your extension by adding: <code>require_once( "$IP/extensions/MyForm/MyForm.php" );</code>.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">When using [[Special:MyLanguage/Manual:Extension registration|extension registration]], use <code>wfLoadExtension( 'MyForm' );</code> instead.</span>

== MyForm.i18n.php ==
{{outdated}}
<div lang="en" dir="ltr" class="mw-content-ltr">
This file will hold all the messages used within your form. Be careful with the messages' IDs, they will be specified later in this tutorial.
</div>

<syntaxhighlight lang="php">
<?php
// Internationalisation for MyForm extension
// @FILLME!

$messages = [];

// English
$messages['en'] = [
    'myf-desc' => 'A generic extension used by the HTMLForm tutorial'
];

// Message documentation (Message documentation)
$messages['qqq'] = [
	'myf-desc' => '{{desc}}'
];

// French
$messages['fr'] = [
    'myf-desc' => 'Une extension générique utilisée par le tutoriel d\'HTMLForm'
];

// More langages…

// NO PHP Closing bracket "? >". This is pure code.
</syntaxhighlight>

== MyForm_body.php ==
<div lang="en" dir="ltr" class="mw-content-ltr">
Finally, the file that interests us the most.
</div>

<syntaxhighlight lang="php">
<?php
/**
 * Necessary description of @file, @authors and license
 * @FILLME!
 * Always good to remind that important part
 */
 
// Avoid illegal processing, doesn't cost much, but unnecessary on a correct installation
if ( !defined( 'MEDIAWIKI' ) ) { 
	die( -1 ); 
}  

// Our SpecialPage
class SpecialMyForm extends SpecialPage {
    public function __construct() {
        // The first argument must be the name of your special page
        // A second argument "right" can be added to restrict access to the SpecialPage
        parent::__construct( 'MyForm' );
    }

    /**
     * Special page entry point
     * @param string|null $par
     */
    public function execute( $par ) {
        $this->setHeaders();
        $this->getOutput()->addHTML( 'Hello World' );
    }

    protected function getGroupName() {
        return 'other';
    }
}

// NO PHP Closing bracket "? >". This is pure code.
</syntaxhighlight>

{{ll|Manual:HTMLForm Tutorial 2}}

[[Category:Tutorials{{#translation:}}]]