Diff Class Reference

Public Member Functions
	__construct (GranularityInterface $granularity=null, RendererInterface $renderer=null, ParserInterface $parser=null)
	getGranularity ()
	setGranularity (GranularityInterface $granularity)
	getRenderer ()
	setRenderer (RendererInterface $renderer)
	getParser ()
	setParser (ParserInterface $parser)
	getOpcodes ($from_text, $to_text)
	render ($from_text, $to_text)

Protected Attributes
	$granularity
	$renderer
	$parser

Detailed Description

Diff class.

Definition at line 31 of file Diff.php.

Constructor & Destructor Documentation

__construct	(	GranularityInterface	$granularity = null,
		RendererInterface	$renderer = null,
		ParserInterface	$parser = null
	)

Instantiate a new instance of Diff.

Parameters

cogpowered\FineDiff\Granularity\GranularityInterface	$granularity	Level of diff.
cogpowered\FineDiff\Render\RenderInterface	$renderer	Diff renderer.
cogpowered\FineDiff\Parser\ParserInterface	$parser	Parser used to generate opcodes.

Exceptions

cogpowered\FineDiff\Exceptions\GranularityCountException
cogpowered\FineDiff\Exceptions\OperationException

Definition at line 58 of file Diff.php.

References Diff\$granularity, Diff\$parser, and Diff\$renderer.

Member Function Documentation

getGranularity

(

)

Returns the granularity object used by the parser.

Returns

Definition at line 77 of file Diff.php.

getOpcodes	(		$from_text,
			$to_text
	)

Gets the diff / opcodes between two strings.

Returns the opcode diff which can be used for example, to to generate a HTML report of the differences.

Returns

cogpowered

Definition at line 143 of file Diff.php.

Referenced by Diff\render().

getParser

(

)

Get the parser responsible for generating the diff/opcodes.

Returns

cogpowered

Definition at line 119 of file Diff.php.

References Diff\$parser.

getRenderer

(

)

Get the render.

Returns

cogpowered

Definition at line 98 of file Diff.php.

References Diff\$renderer.

render	(		$from_text,
			$to_text
	)

Render the difference between two strings.

By default will return the difference as HTML.

Parameters

string	$from_text
string	$to_text

Returns

string

Definition at line 157 of file Diff.php.

References Diff\getOpcodes().

setGranularity

(

GranularityInterface

$granularity

)

Set the granularity level of the parser.

Parameters

cogpowered\FineDiff\Granularity\GranularityInterface

$granularity

Returns

void

Definition at line 88 of file Diff.php.

setParser

(

ParserInterface

$parser

)

Set the parser.

Parameters

cogpowered\FineDiff\Parser\ParserInterface

$parser

Returns

void

Definition at line 130 of file Diff.php.

References Diff\$parser.

setRenderer

(

RendererInterface

$renderer

)

Set the renderer.

Parameters

cogpowered\FineDiff\Render\RendererInterface

$renderer

Returns

void

Definition at line 109 of file Diff.php.

References Diff\$renderer.

Member Data Documentation

$granularity

protected

Definition at line 36 of file Diff.php.

Referenced by Diff\__construct().

$parser

protected

Definition at line 46 of file Diff.php.

Referenced by Diff\__construct(), Diff\getParser(), and Diff\setParser().

$renderer

protected

Definition at line 41 of file Diff.php.

Referenced by Diff\__construct(), Diff\getRenderer(), and Diff\setRenderer().