Skip to content

Commit 575151b

Browse files
fapdashandrewnicols
authored andcommitted
[docs] Provide full example for Forms API
- provide full example including `<?php` tag when providing an example file. If an example references a filename the code block should contain a complete example of this file. - specify namespace according to the automatic class loading rules - add backslash to `moodleform` for namespaced reference (`use moodleform` would also be fine)
1 parent 0e98be8 commit 575151b

File tree

5 files changed

+25
-5
lines changed
  • docs/apis/subsystems/form
  • versioned_docs
    • version-4.1/apis/subsystems/form
    • version-4.4/apis/subsystems/form
    • version-4.5/apis/subsystems/form
    • version-5.0/apis/subsystems/form

5 files changed

+25
-5
lines changed

docs/apis/subsystems/form/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,14 @@ To create a form in Moodle, you create a class that defines the form, including
3434
<summary>An example of a form definition</summary>
3535

3636
```php title="[path/to/plugin]/classes/form/myform.php"
37+
<?php
38+
39+
namespace [plugintype]_[pluginname]\form;
40+
3741
// moodleform is defined in formslib.php
3842
require_once("$CFG->libdir/formslib.php");
3943

40-
class simplehtml_form extends moodleform {
44+
class simplehtml_form extends \moodleform {
4145
// Add elements to form.
4246
public function definition() {
4347
// A reference to the form is stored in $this->form.

versioned_docs/version-4.1/apis/subsystems/form/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,14 @@ To create a form in Moodle, you create a class that defines the form, including
3434
<summary>An example of a form definition</summary>
3535

3636
```php title="[path/to/plugin]/classes/form/myform.php"
37+
<?php
38+
39+
namespace [plugintype]_[pluginname]\form;
40+
3741
// moodleform is defined in formslib.php
3842
require_once("$CFG->libdir/formslib.php");
3943

40-
class simplehtml_form extends moodleform {
44+
class simplehtml_form extends \moodleform {
4145
// Add elements to form.
4246
public function definition() {
4347
// A reference to the form is stored in $this->form.

versioned_docs/version-4.4/apis/subsystems/form/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,14 @@ To create a form in Moodle, you create a class that defines the form, including
3434
<summary>An example of a form definition</summary>
3535

3636
```php title="[path/to/plugin]/classes/form/myform.php"
37+
<?php
38+
39+
namespace [plugintype]_[pluginname]\form;
40+
3741
// moodleform is defined in formslib.php
3842
require_once("$CFG->libdir/formslib.php");
3943

40-
class simplehtml_form extends moodleform {
44+
class simplehtml_form extends \moodleform {
4145
// Add elements to form.
4246
public function definition() {
4347
// A reference to the form is stored in $this->form.

versioned_docs/version-4.5/apis/subsystems/form/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,14 @@ To create a form in Moodle, you create a class that defines the form, including
3434
<summary>An example of a form definition</summary>
3535

3636
```php title="[path/to/plugin]/classes/form/myform.php"
37+
<?php
38+
39+
namespace [plugintype]_[pluginname]\form;
40+
3741
// moodleform is defined in formslib.php
3842
require_once("$CFG->libdir/formslib.php");
3943

40-
class simplehtml_form extends moodleform {
44+
class simplehtml_form extends \moodleform {
4145
// Add elements to form.
4246
public function definition() {
4347
// A reference to the form is stored in $this->form.

versioned_docs/version-5.0/apis/subsystems/form/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,14 @@ To create a form in Moodle, you create a class that defines the form, including
3434
<summary>An example of a form definition</summary>
3535

3636
```php title="[path/to/plugin]/classes/form/myform.php"
37+
<?php
38+
39+
namespace [plugintype]_[pluginname]\form;
40+
3741
// moodleform is defined in formslib.php
3842
require_once("$CFG->libdir/formslib.php");
3943

40-
class simplehtml_form extends moodleform {
44+
class simplehtml_form extends \moodleform {
4145
// Add elements to form.
4246
public function definition() {
4347
// A reference to the form is stored in $this->form.

0 commit comments

Comments
 (0)