Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
WikiDiffFormatter Class Reference

A class to format WikiDiffs. More...

Inheritance diagram for WikiDiffFormatter:
TableWikiDiffFormatter TableWikiDiffFormatterOld

Public Member Functions

 _added ($lines)
 
 _block ($xbeg, $xlen, $ybeg, $ylen, &$edits)
 
 _block_header ($xbeg, $xlen, $ybeg, $ylen)
 
 _changed ($orig, $closing)
 
 _context ($lines)
 
 _deleted ($lines)
 
 _end_block ()
 
 _end_diff ()
 
 _lines ($lines, $prefix=' ')
 
 _start_block ($header)
 
 _start_diff ()
 
 format ($diff)
 Format a diff. More...
 

Public Attributes

 $leading_context_lines = 0
 Number of leading context "lines" to preserve. More...
 
 $trailing_context_lines = 0
 Number of trailing context "lines" to preserve. More...
 

Detailed Description

A class to format WikiDiffs.

This class formats the diff in classic diff format. It is intended that this class be customized via inheritance, to obtain fancier outputs.

Member Function Documentation

◆ format()

WikiDiffFormatter::format (   $diff)

Format a diff.

Parameters
$diffobject A WikiDiff object.
Return values
stringThe formatted output.

Member Data Documentation

◆ $leading_context_lines

WikiDiffFormatter::$leading_context_lines = 0

Number of leading context "lines" to preserve.

This should be left at zero for this class, but subclasses may want to set this to other values.

◆ $trailing_context_lines

WikiDiffFormatter::$trailing_context_lines = 0

Number of trailing context "lines" to preserve.

This should be left at zero for this class, but subclasses may want to set this to other values.


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