PHP 클래스 Usps\OpenDistributeLabel

상속: extends USPSBase
파일 보기 프로젝트 열기: vinceg/usps-php-api

보호된 프로퍼티들

프로퍼티 타입 설명
$apiVersion - the api version used for this type of call
$fields - route added so far.

공개 메소드들

메소드 설명
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.

보호된 메소드들

메소드 설명
addMissingRequired ( ) : void Add missing required elements.

메소드 상세

addMissingRequired() 보호된 메소드

Add missing required elements.
protected addMissingRequired ( ) : void
리턴 void

createLabel() 공개 메소드

Perform the API call.
public createLabel ( ) : string
리턴 string

getConfirmationNumber() 공개 메소드

Return the USPS confirmation/tracking number if we have one.

getLabelContents() 공개 메소드

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

getPostFields() 공개 메소드

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

setField() 공개 메소드

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
리턴 object

setFromAddress() 공개 메소드

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
리턴 object

setToAddress() 공개 메소드

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
리턴 object

setWeightOunces() 공개 메소드

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

setWeightPounds() 공개 메소드

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

프로퍼티 상세

$apiVersion 보호되어 있는 프로퍼티

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

$fields 보호되어 있는 프로퍼티

- route added so far.
protected $fields