ClassInterface Veriplace_LocationFilter

Description

Interface for an object that can apply post-processing to returned locations.

If present, VeriplaceGetLocationAPI passes all new locations returned by the server through this filter.

Located in /Veriplace/Interfaces.php (line 308)


	
			
Method Summary
 Veriplace_Location filterLocation ($returnedLocation $returnedLocation, $returnedException $returnedException)
Methods
filterLocation (line 325)

Transforms the result of a location request.

If this method returns null, the filter has no effect. If it returns a location object, that becomes the return value of the location request, even if the request would normally have failed. It can also throw a different exception, regardless of whether the request would normally have failed or succeeded.

  • return: A new location to return; null to keep the original location, or to throw the original exception if there was an exception.
Veriplace_Location filterLocation ($returnedLocation $returnedLocation, $returnedException $returnedException)
  • $returnedLocation $returnedLocation: Veriplace_Location The valid location returned by the server, or null if an error occurred.
  • $returnedException $returnedException: Veriplace_PositionFailureException The exception that would normally be thrown if an error occurred.

Documentation generated on Sun, 29 Aug 2010 04:08:39 -0700 by phpDocumentor 1.4.1