Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcTestConstraintSimilarImage

Constraint class for image comparison.

PHPUnit_Framework_Constraint
   |
   --ezcTestConstraintSimilarImage

Version:

//autogentag//

protected int	`$delta` Maximum delta between images.
protected int	`$difference` Difference between images.
protected string	`$filename` Filename of the image to compare against.

public ezcConstraintSimilarImage	`__construct( $filename , [ $delta = 0] )` Constructor.
public abstract bool	`evaluate( $other )` Evaluates the constraint for parameter $other. Returns TRUE if the constraint is met, FALSE otherwise.
public void	`fail( $other , $description , [ $not = false] )` Creates the appropriate exception for the constraint which can be caught by the unit test system. This can be called if a call to evaluate() fails.
public string	`toString( )` Provide test text

ezcConstraintSimilarImage __construct( string $filename , [int $delta = 0] )

Constructor.

Name	Type	Description
`$filename`	string	Filename of the image to compare against.
`$delta`	int	Maximum delta between images.

bool evaluate( mixed $other )

Evaluates the constraint for parameter $other. Returns TRUE if the constraint is met, FALSE otherwise.

Name	Type	Description
`$other`	mixed	Filename of the image to compare.

void fail( mixed $other , string $description , [boolean $not = false] )

Creates the appropriate exception for the constraint which can be caught by the unit test system. This can be called if a call to evaluate() fails.

Name	Type	Description
`$other`	mixed	The value passed to evaluate() which failed the constraint check.
`$description`	string	A string with extra description of what was going on while the evaluation failed.
`$not`	boolean	Flag to indicate negation.

Type	Description
`PHPUnit_Framework_ExpectationFailedException`

string toString( )

Provide test text

Documentation generated by phpDocumentor 1.4.3