VirtueMart  3.2.14.9808
Public Member Functions | Private Attributes | List of all members
ValidateRequest Class Reference

Public Member Functions

 __construct ($address=null, $textCase= 'Default', $coordinates=false)
 
 setAddress (&$value)
 
 setTextCase ($value)
 
 setCoordinates ($value)
 
 setTaxability ($value)
 
 getAddress ()
 
 getTextCase ()
 
 getCoordinates ()
 

Private Attributes

 $Address
 
 $TextCase = 'Default'
 
 $Coordinates = false
 
 $Taxability =false
 

Constructor & Destructor Documentation

ValidateRequest::__construct (   $address = null,
  $textCase = 'Default',
  $coordinates = false 
)

Member Function Documentation

ValidateRequest::getAddress ( )

The address to Validate.

Example:
$address = new Address();
$address->setLine1("900 Winslow Way");
$address->setCity("Bainbridge Island");
$address->setRegion("WA");
$address->setPostalCode("98110");
$validateRequest = new ValidateRequest();
$validateRequest->setAddress(address);
$validateRequest->setTextCase(TextCase::$Upper);
$result = svc->validate(validateRequest);
Returns
Address
ValidateRequest::getCoordinates ( )

Returns whether to return the coordinates value for this ValidateRequest.

True will return the

See also
ValidAddress::Latitude and
ValidAddress::Longitude values for the
ValidAddresses Default value is false
Returns
boolean
ValidateRequest::getTextCase ( )

The casing to apply to the validated address(es).

Example:
Example:
$address = new Address();
$address->setLine1("900 Winslow Way");
$address->setCity("Bainbridge Island");
$address->setRegion("WA");
$address->setPostalCode("98110");
$validateRequest = new ValidateRequest();
$validateRequest->setAddress(address);
$validateRequest->setTextCase(TextCase::$Upper);
$result = svc->validate(validateRequest);
Returns
string
See also
TextCase
ValidateRequest::setAddress ( $value)
ValidateRequest::setCoordinates (   $value)
ValidateRequest::setTaxability (   $value)
ValidateRequest::setTextCase (   $value)

Member Data Documentation

ValidateRequest::$Address
private
ValidateRequest::$Coordinates = false
private
ValidateRequest::$Taxability =false
private
ValidateRequest::$TextCase = 'Default'
private

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