USPSOpenDistributeLabel.php

<?php
/**
 * Load required classes
 */
require_once('USPSBase.php');

/**
 */
class USPSOpenDistributeLabel extends USPSBase {
  /**
   * @var string - the api version used for this type of call
   */
  protected $apiVersion = 'OpenDistributePriorityV2';
  /**
   * @var array - route added so far.
   */
  protected $fields = array();
  /**
   * Perform the API call.
   * @return string
   */
  public function createLabel() {
  	// Add missing required
  	$this->addMissingRequired();

  	// Sort them
  	// Hack by the only way this will work properly
  	// since usps wants the tags to be in 
  	// a certain order
  	ksort($this->fields, SORT_NUMERIC);

  	// remove the \d. from the key
  	foreach($this->fields as $key => $value) {
  		$newKey = str_replace('.', '', $key);
  		$newKey = preg_replace('/\d+\:/', '', $newKey);
  		unset($this->fields[$key]);
  		$this->fields[$newKey] = $value;
  	}

    return $this->doRequest();
  }

  /**
   * Return the USPS confirmation/tracking number if we have one
   * @return string|bool
   */
  public function getConfirmationNumber() {
  	$response = $this->getArrayResponse();
  	// Check to make sure we have it
  	if(isset($response[$this->getResponseApiName()])) {
  		if(isset($response[$this->getResponseApiName()]['OpenDistributePriorityNumber'])) {
  			return $response[$this->getResponseApiName()]['OpenDistributePriorityNumber'];
  		}
  	}

  	return false;
  }

  /**
   * Return the USPS label as a base64 encoded string
   * @return string|bool
   */
  public function getLabelContents() {
  	$response = $this->getArrayResponse();
  	// Check to make sure we have it
  	if(isset($response[$this->getResponseApiName()])) {
  		if(isset($response[$this->getResponseApiName()]['OpenDistributePriorityLabel'])) {
  			return $response[$this->getResponseApiName()]['OpenDistributePriorityLabel'];
  		}
  	}

  	return false;
  }

  /**
   * returns array of all fields added
   * @return array
   */
  public function getPostFields() {
    return $this->fields;
  }

  /**
   * Set the from address
   * @param string $firstName
   * @param string $lastName
   * @param string $company
   * @param string $address
   * @param string $city
   * @param string $state
   * @param string $zip
   * @param string $address2
   * @param string $zip4
   * @param string $phone
   * @return object
   */
  public function setFromAddress($firstName, $lastName, $company, $address, $city, $state, $zip, $address2=null, $zip4=null) {
  	$this->setField(5, 'FromName', trim($firstName . ' ' . $lastName));
  	$this->setField(7, 'FromFirm', $company);
  	$this->setField(8, 'FromAddress1', $address2);
  	$this->setField(9, 'FromAddress2', $address);
  	$this->setField(10, 'FromCity', $city);
  	$this->setField(11, 'FromState', $state);
  	$this->setField(12, 'FromZip5', $zip);
  	$this->setField(13, 'FromZip4', $zip4);

  	return $this;
  }

  /**
   * Set the to address
   * @param string $firstName
   * @param string $lastName
   * @param string $company
   * @param string $address
   * @param string $city
   * @param string $state
   * @param string $zip
   * @param string $address2
   * @param string $zip4
   * @param string $phone
   * @return object
   */
  public function setToAddress($company, $address, $city, $state, $zip, $address2=null, $zip4=null) {
  	$this->setField(15, 'ToFacilityName', $company);
  	$this->setField(18, 'ToFacilityAddress1', $address2);
  	$this->setField(19, 'ToFacilityAddress2', $address);
  	$this->setField(20, 'ToFacilityCity', $city);
  	$this->setField(21, 'ToFacilityState', $state);
  	$this->setField(22, 'ToFacilityZip5', $zip);
  	$this->setField(23, 'ToFacilityZip4', $zip4);

  	return $this;
  }

  /**
   * Set package weight in ounces
   *
   */
  public function setWeightOunces($weight) {
  	$this->setField(38, 'WeightInOunces', $weight);
  	return $this;
  }

  /**
   * Set package weight in ounces
   *
   */
  public function setWeightPounds($weight) {
  	$this->setField(37, 'WeightInPounds', $weight);
  	return $this;
  }

  /** 
   * Set any other requried string make sure you set the correct position as well
   * as the position of the items matters
   * @param int $position 
   * @param string $key
   * @param string $value
   * @return object
   */
  public function setField($position, $key, $value) {
  	$this->fields[$position . ':' . $key] = $value;
  	return $this;
  }

  /**
   * Add missing required elements
   * @return void
   */
  protected function addMissingRequired() {
  	$required = array(
  		'1:Revision' => '',
  		'2:ImageParameters' => '',
  		'2:PermitNumber' => '',
  		'4:PermitIssuingPOZip5' => '',
  		'14:POZipCode' => '',

  		'34:FacilityType' => 'DDU',
  		'35:MailClassEnclosed' => 'Other',
  		'36:MailClassOther' => 'Free Samples',
  		'37:WeightInPounds' => '22',
  		'38:WeightInOunces' => '10',
  		'39:ImageType' => 'PDF',
  		'40:SeparateReceiptPage' => 'false',
  		'41:AllowNonCleansedFacilityAddr' => 'false',
  		'42:HoldForManifest' => 'N',
  		'43:CommercialPrice' => 'N',
  	);
  	foreach($required as $item => $value) {
  		$explode = explode(':', $item);
  		if(!isset($this->fields[$item])) {
  			$this->setField($explode[0], $explode[1], $value);
  		}
  	}
  }

}