Revision as of 20:06, 6 December 2018

Usage

Moodle has a class called html_writer which allows you to output basic HTML tags. This is typically used within renderer functions, for example question/type/pluginname/renderer.php.

There is no documentation for most of this class. Please look at the source code in moodle/lib/outputcomponents.php.

To allow shorter code when outputting the div and span tags with classes, div and span methods were added in Moodle 2.5.

Methods

the div method

Moodle 2.5

html_writer::div(content, class="", attributes="");

Attributes is a key-value array.

Example usage:

$out .= html_writer::div('anonymous');  // <div>anonymous</div>
$out .= html_writer::div('kermit', 'frog'); // <div class="frog">kermit</div>
$out .= html_writer::div('Mr', 'toad', array('id' => 'tophat')); // <div class="toad" id="tophat">Mr</div>

spans

$out .= html_writer::start_span('zombie') . 'BRAINS' . html_writer::end_span(); // <span class="zombie">BRAINS</span>

generic tags

html_writer::tag(tag_name, contents, attributes=null); html_writer::start_tag(tag_name, attributes=null;); html_writer::end_tag(tag_name); html_writer::empty_tag(tag_name, attributes=null); html_writer::nonempty_tag(tag_name, content, attributes=null); html_writer::attribute(name, value); html_writer;:attributes(attributes_array);

References

phpcrossref.com/xref/moodle/lib/outputcomponents.php.html

@@ Line 1: / Line 1: @@
-Moodle has a class called html_writer which allows you to output basic HTML tags. This is typically used within renderer functions (or by naughty people in scripts which are outputting content without using a renderer).
+= Usage =
+Moodle has a class called html_writer which allows you to output basic HTML tags. This is typically used within renderer functions, for example question/type/''pluginname''/renderer.php.
-There is no documentation for most of this class. Please look at the source code in moodle/lib/outputcomponents.php
+There is no documentation for most of this class. Please look at the source code in moodle/lib/outputcomponents.php.
-== div, span methods ==
+To allow shorter code when outputting the div and span tags with classes, <code>div</code> and <code>span</code> methods were added in Moodle 2.5.
+= Methods =
+== the div method ==
 {{Moodle 2.5}}
-To allow shorter code when outputting the div and span tags with classes, <code>div</code> and <code>span</code> methods were added in Moodle 2.5.
+<code>html_writer::div(content, class="", attributes="");</code>
+Attributes is a key-value array.
 Example usage:
-  $out .= html_writer::div('anonymous');
+  $out .= html_writer::div('anonymous');  // &lt;div>anonymous&lt;/div>
-  $out .= html_writer::div('kermit', 'frog');
+  $out .= html_writer::div('kermit', 'frog'); // &lt;div class="frog">kermit&lt;/div>
-  $out .= html_writer::start_span('zombie') . 'BRAINS' . html_writer::end_span();
+  $out .= html_writer::div('Mr', 'toad', array('id' => 'tophat')); // &lt;div class="toad" id="tophat">Mr&lt;/div>
-  $out .= html_writer::div('Mr', 'toad', array('id' => 'tophat'));
+== spans ==
+  $out .= html_writer::start_span('zombie') . 'BRAINS' . html_writer::end_span(); // &lt;span class="zombie">BRAINS&lt;/span>
-This will result in the following HTML from each line:
+== generic tags ==
+<code>
+html_writer::tag(tag_name, contents, attributes=null);
+html_writer::start_tag(tag_name, attributes=null;);
+html_writer::end_tag(tag_name);
+html_writer::empty_tag(tag_name, attributes=null);
+html_writer::nonempty_tag(tag_name, content, attributes=null);
+html_writer::attribute(name, value);
+html_writer;:attributes(attributes_array);
+</code>
- &lt;div>anonymous&lt;/div>
+= References =
- &lt;div class="frog">kermit&lt;/div>
+[[phpcrossref.com/xref/moodle/lib/outputcomponents.php.html]]
- &lt;span class="zombie">BRAINS&lt;/span>
- &lt;div class="toad" id="tophat">Mr&lt;/div>
-For detailed usage information, see the source code.
+[[Category: Development]]

Documentation

html writer: Difference between revisions