The base class for all other DiffOp classes. More...

Inherited by Wikimedia\Diff\DiffOpAdd, Wikimedia\Diff\DiffOpChange, Wikimedia\Diff\DiffOpCopy, and Wikimedia\Diff\DiffOpDelete.

Public Member Functions
	getClosing ( $i=null)
	Without a line number this returns either all lines on the right ("new") side of the diff, or false when it's a delete operation.

	getOrig ()
	Returns either all lines on the left ("old") side of the diff, or false when it's an add operation.

	getType ()

	nclosing ()

	norig ()

	reverse ()

Public Attributes
string[] false	$closing
	The right ("new") side of the diff, or false when it's a "delete".

string[] false	$orig
	The left ("old") side of the diff, or false when it's an "add".

string	$type

Detailed Description

The base class for all other DiffOp classes.

The classes that extend DiffOp are: DiffOpCopy, DiffOpDelete, DiffOpAdd and DiffOpChange. FakeDiffOp also extends DiffOp, but it is not located in this file.

Definition at line 24 of file DiffOp.php.

Member Function Documentation

◆ getClosing()

Wikimedia\Diff\DiffOp::getClosing ( $i = null )

Without a line number this returns either all lines on the right ("new") side of the diff, or false when it's a delete operation.

With a line number this returns either the line or null if the line doesn't exist.

Parameters

int | null $i Line number, or null for all lines in the operation

Returns: string[]|false|string|null

Definition at line 70 of file DiffOp.php.

References Wikimedia\Diff\DiffOp\$closing.

◆ getOrig()

Wikimedia\Diff\DiffOp::getOrig ( )

Returns either all lines on the left ("old") side of the diff, or false when it's an add operation.

Returns: string[]|false

Definition at line 57 of file DiffOp.php.

References Wikimedia\Diff\DiffOp\$orig.

◆ getType()

Wikimedia\Diff\DiffOp::getType ( )

Returns: string Either "add", "change", "copy", or "delete"

Definition at line 47 of file DiffOp.php.

References Wikimedia\Diff\DiffOp\$type.

◆ nclosing()

Wikimedia\Diff\DiffOp::nclosing ( )

Returns: int Number of lines on the right ("new") side of the diff, see {

See also: getClosing}

Definition at line 95 of file DiffOp.php.

◆ norig()

Wikimedia\Diff\DiffOp::norig ( )

Returns: int Number of lines on the left ("old") side of the diff, {

See also: getOrig}

Definition at line 88 of file DiffOp.php.

◆ reverse()

Wikimedia\Diff\DiffOp::reverse ( )

abstract

Returns: self Inverted operation (a.k.a. revert or undo), e.g. "delete" becomes "add"

Reimplemented in Wikimedia\Diff\DiffOpAdd, Wikimedia\Diff\DiffOpChange, Wikimedia\Diff\DiffOpCopy, and Wikimedia\Diff\DiffOpDelete.

Member Data Documentation

◆ $closing

string [] false Wikimedia\Diff\DiffOp::$closing

The right ("new") side of the diff, or false when it's a "delete".

Access: private: Please use {

See also: getClosing}

Definition at line 42 of file DiffOp.php.

Referenced by Wikimedia\Diff\DiffOpChange\__construct(), Wikimedia\Diff\DiffOpCopy\__construct(), and Wikimedia\Diff\DiffOp\getClosing().

◆ $orig

string [] false Wikimedia\Diff\DiffOp::$orig

The left ("old") side of the diff, or false when it's an "add".

Access: private: Please use {

See also: getOrig}

Definition at line 36 of file DiffOp.php.

Referenced by Wikimedia\Diff\DiffOpChange\__construct(), Wikimedia\Diff\DiffOpCopy\__construct(), and Wikimedia\Diff\DiffOp\getOrig().

◆ $type

string Wikimedia\Diff\DiffOp::$type

Access: private: Please use {

See also: getType}

Definition at line 30 of file DiffOp.php.

Referenced by Wikimedia\Diff\DiffOp\getType().

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

includes/libs/Diff/DiffOp.php

Public Member Functions

Public Attributes