PHP Class Usps\OpenDistributeLabel

Inheritance: extends USPSBase
Show file Open project: vinceg/usps-php-api

Protected Properties

Property Type Description
$apiVersion - the api version used for this type of call
$fields - route added so far.

Public Methods

Method Description
createLabel ( ) : string Perform the API call.
getConfirmationNumber ( ) : string | boolean Return the USPS confirmation/tracking number if we have one.
getLabelContents ( ) : string | boolean Return the USPS label as a base64 encoded string.
getPostFields ( ) : array returns array of all fields added.
setField ( integer $position, string $key, string $value ) : object Set any other requried string make sure you set the correct position as well as the position of the items matters.
setFromAddress ( string $firstName, string $lastName, string $company, string $address, string $city, string $state, string $zip, string $address2 = null, string $zip4 = null ) : object Set the from address.
setToAddress ( string $company, string $address, string $city, string $state, string $zip, string $address2 = null, string $zip4 = null ) : object Set the to address.
setWeightOunces ( $weight ) Set package weight in ounces.
setWeightPounds ( $weight ) Set package weight in ounces.

Protected Methods

Method Description
addMissingRequired ( ) : void Add missing required elements.

Method Details

addMissingRequired() protected method

Add missing required elements.
protected addMissingRequired ( ) : void
return void

createLabel() public method

Perform the API call.
public createLabel ( ) : string
return string

getConfirmationNumber() public method

Return the USPS confirmation/tracking number if we have one.
public getConfirmationNumber ( ) : string | boolean
return string | boolean

getLabelContents() public method

Return the USPS label as a base64 encoded string.
public getLabelContents ( ) : string | boolean
return string | boolean

getPostFields() public method

returns array of all fields added.
public getPostFields ( ) : array
return array

setField() public method

Set any other requried string make sure you set the correct position as well as the position of the items matters.
public setField ( integer $position, string $key, string $value ) : object
$position integer
$key string
$value string
return object

setFromAddress() public method

Set the from address.
public setFromAddress ( string $firstName, string $lastName, string $company, string $address, string $city, string $state, string $zip, string $address2 = null, string $zip4 = null ) : object
$firstName string
$lastName string
$company string
$address string
$city string
$state string
$zip string
$address2 string
$zip4 string
return object

setToAddress() public method

Set the to address.
public setToAddress ( string $company, string $address, string $city, string $state, string $zip, string $address2 = null, string $zip4 = null ) : object
$company string
$address string
$city string
$state string
$zip string
$address2 string
$zip4 string
return object

setWeightOunces() public method

Set package weight in ounces.
public setWeightOunces ( $weight )
$weight

setWeightPounds() public method

Set package weight in ounces.
public setWeightPounds ( $weight )
$weight

Property Details

$apiVersion protected property

- the api version used for this type of call
protected $apiVersion

$fields protected property

- route added so far.
protected $fields