Zend Framework: Zend_Service_LinkPoint Component Proposal

Proposed Component Name	Zend_Service_LinkPoint
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Service_LinkPoint
Proposers	Colin Snover
Revision	0.1 - 11 April 2008: Initial revision. (wiki revision: 4)

<?php
require_once 'Zeta/Service/LinkPoint.php';

$card = new Zeta_Service_LinkPoint_CreditCard('4111111111111111', 6, 9, 123);

// Zeta_Service_LinkPoint_CreditCard also implements a fluent interface
$card = new Zeta_Service_LinkPoint_CreditCard();
$card->setCcNum('4111111111111111')
     ->setExpiration(6, 2009)
     ->setCvm(123);

$billAddress = new Zeta_Service_LinkPoint_Address();
$billAddress->setName('Joe Schmoe')
            ->setAddress('123 Anywhere Street')
            ->setCity('Minneapolis')
            ->setProvince('MN')
            ->setPostCode('55401')
            ->setCountry('US')
            ->setPhone('612-555-1212')
            ->setEmail('test@example.com');

$service = new Zeta_Service_LinkPoint('1909301429', './1909301429.pem');
$service->setOrderId('9')
        ->setTax(5.20)
        ->setTotal(18.00)
        ->setPaymentObject($card)
        ->setBillingAddress($billAddress)
        ->setShippingAddress($billAddress)
        ->addItem(array(
        	'id'          => 'ASDFGHJKL',
        	'description' => 'Something awesome',
        	'price'       => 6.40,
        	'quantity'    => 2));
$service->process(Zeta_Service_LinkPoint::AUTH, 'live');

UC-02

A basic purchase using a cheque.

<?php
require_once 'Zeta/Service/LinkPoint.php';

$card = new Zeta_Service_LinkPoint_Cheque(3939393939, 91000019, 123, 'PC', 'Wells Fargo', 'ND', 'N3333333333', 'CA');

// Zeta_Service_LinkPoint_CreditCard also implements a fluent interface
$card = new Zeta_Service_LinkPoint_Cheque();
$card->setAccount(3939393939, 91000019)
     ->setChequeNumber(123)
     ->setBank('Wells Fargo', 'ND')
     ->setIdentification('N3333333333', 'CA');

$billAddress = new Zeta_Service_LinkPoint_Address();
$billAddress->setName('Joe Schmoe')
            ->setAddress('123 Anywhere Street')
            ->setCity('Minneapolis')
            ->setProvince('MN')
            ->setPostCode('55401')
            ->setCountry('US')
            ->setPhone('612-555-1212')
            ->setEmail('test@example.com');

$service = new Zeta_Service_LinkPoint('1909301429', './1909301429.pem');
$service->setOrderId('9')
        ->setTax(5.20)
        ->setTotal(18.00)
        ->setPaymentObject($card)
        ->setBillingAddress($billAddress)
        ->setShippingAddress($billAddress)
        ->addItem(array(
        	'id'          => 'ASDFGHJKL',
        	'description' => 'Something awesome',
        	'price'       => 6.40,
        	'quantity'    => 2));
$service->process(Zeta_Service_LinkPoint::AUTH_CAPTURE, 'live');

9. Class Skeletons

/**
 * A service for LinkPoint.
 * @TODO Implement calcshipping method, calctax method,
 *       periodic entity/recurring billing.
 */
class Zeta_Service_LinkPoint extends Zend_Service_Abstract
{
	const AUTH_CAPTURE = 'sale';
	const AUTH = 'preauth';
	const CAPTURE = 'postauth';
	const VOID = 'void';
	const CREDIT = 'credit';

	/**
	 * Merchant store name or store number.
	 * @var string
	 */
	protected $_storeName;
	
	/**
	 * Path and filename for the API digital certificate.
	 * @var string
	 */
	protected $_keyFile;
	
	/**
	 * Hostname of the payment gateway server.
	 * @var string
	 */
	protected $_host = 'secure.linkpt.net';
	
	/**
	 * Port for the gateway server.
	 * @var int
	 */
	protected $_port = 1129;
	
	/**
	 * The order ID. Must be unique for pre-authorisation,
	 * or must be valid from a prior authorisation for VOID,
	 * CREDIT, and CAPTURE.
	 * @var string
	 */
	protected $_orderId;
	
	/**
	 * Invoice number. If NULL, set to a normalised version
	 * of the order ID upon processing.
	 * @var string
	 */
	protected $_invoiceNumber = null;
	
	/**
	 * Tax exemption status.
	 * @var boolean
	 */
	protected $_taxExempt = false;
	
	/**
	 * Customer-supplied purchase order number.
	 * @var string
	 */
	protected $_purchaseOrder = '';
	
	/**
	 * Purchase subtotal. Optional.
	 * @var float
	 */
	protected $_subtotal = null;
	
	/**
	 * Tax amount.
	 * @var float
	 */
	protected $_tax = 0.00;
	
	/**
	 * VAT amount. Optional.
	 * @var float
	 */
	protected $_vat = null;
	
	/**
	 * Shipping cost. Optional.
	 * @var float
	 */
	protected $_shipping = null;
	
	/**
	 * Total charge amount.
	 * @var float
	 */
	protected $_total = 0.00;
	
	/**
	 * The payment object entity.
	 * @var Zeta_Service_LinkPoint_CreditCard|Zeta_Service_LinkPoint_Cheque
	 */
	protected $_paymentObject = null;
	
	/**
	 * The item list to send along to the payment processor. Optional.
	 * A multi-dimensional array, this must be in the following format:
	 * array(
	 *     id => array(
	 *         id          => string
	 *         description => string
	 *         price       => float
	 *         quantity    => integer
	 *         options     => array(
	 *             array(
	 *                 name  => string
	 *                 value => string
	 *             ), ...
	 *         )
	 *     ), ...
	 * )
	 * @var array
	 */
	protected $_items = array();
	
	/**
	 * The billing address for the payment.
	 * @var Zeta_Service_LinkPoint_Address
	 */
	protected $_billingAddress;
	
	/**
	 * The shipping address for the payment. Optional.
	 * @var Zeta_Service_LinkPoint_Address
	 */
	protected $_shippingAddress = null;
	
	/**
	 * Note about the transaction. Optional.
	 * @var string
	 */
	protected $_note = null;
	
	/**
	 * Referrer information, for marketing purposes. Optional.
	 * @var string
	 */
	protected $_referrer = null;
	
	/**
	 * The result XML from the processor.
	 * @var string
	 */
	protected $_result = '';
	
	/**
	 * Whether or not the transaction succeeded.
	 * @var boolean
	 */
	public $hasError = false;

	/**
	 * Constructor
	 *
	 * @param string $storeName
	 * @param string $keyFile
	 * @returns void
	 */
	public function __construct($storeName, $keyFile)
	{}
	
	/**
	 * Sets the store name.
	 *
	 * @param string $storeName
	 * @returns Zend_Service_LinkPoint
	 */
	public function setStoreName($storeName)
	{}
	
	/**
	 * Returns the store name.
	 * @returns string
	 */
	public function getStoreName()
	{}

	/**
	 * Sets the digital certificate's filename.
	 *
	 * @param string $keyFile
	 * @returns Zend_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setKeyFile($keyFile)
	{}
	
	/**
	 * Returns the digital certificate's filename.
	 * @returns string
	 */
	public function getKeyFile()
	{}
	
	/**
	 * Sets the host name.
	 * @param string $host
	 * @returns Zend_Service_LinkPoint
	 */
	public function setHost($host)
	{}
	
	/**
	 * Returns the host name.
	 * @returns string
	 */
	public function getHost()
	{}
	
	/**
	 * Sets the port number.
	 * @param int $port
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setPort($port)
	{}
	
	/**
	 * Returns the port number.
	 * @returns int
	 */
	public function getPort()
	{}
	
	/**
	 * Sets the order ID.
	 *
	 * @param string $orderId
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */	
	public function setOrderId($orderId)
	{}
	
	/**
	 * Returns the order ID.
	 * @returns string
	 */
	public function getOrderId()
	{}
	
	/**
	 * Sets the invoice number.
	 *
	 * @param string $invoiceId
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setInvoiceNumber($invoiceId)
	{}
	
	/**
	 * Returns the invoice number.
	 * @returns string
	 */
	public function getInvoiceNumber()
	{}
	
	/**
	 * Sets the customer-provided purchase order number.
	 *
	 * @param string $poId
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setPurchaseOrder($poId)
	{}
	
	/**
	 * Returns the customer-provided purchase order number.
	 * @returns string
	 */
	public function getPurchaseOrder()
	{}
	
	/**
	 * Sets the tax-exempt status of the order.
	 *
	 * @param boolean $status
	 * @returns Zeta_Service_LinkPoint
	 */
	public function setTaxExemptStatus($status = false)
	{}
	
	/**
	 * Returns the tax-exempt status of the order.
	 * @returns boolean
	 */
	public function getTaxExemptStatus()
	{}
	
	/**
	 * Set the purchase subtotal. Optional.
	 *
	 * @param float $subtotal
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setSubtotal($subtotal)
	{}
	
	/**
	 * Returns the purchase subtotal.
	 * @returns float|integer
	 */
	public function getSubtotal()
	{}
	
	/**
	 * Clears the purchase subtotal.
	 * @returns Zeta_Service_LinkPoint
	 */
	public function clearSubtotal()
	{}
	
	/**
	 * Set the tax amount.
	 *
	 * @param float $tax
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setTax($tax)
	{}
	
	/**
	 * Returns the tax amount.
	 * @returns float|integer
	 */
	public function getTax()
	{}
	
	/**
	 * Set the VAT amount. Optional.
	 *
	 * @param float $vat
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setVat($vat)
	{}
	
	/**
	 * Returns the VAT amount.
	 * @returns float|integer
	 */
	public function getVat()
	{}
	
	/**
	 * Clears the VAT.
	 * @returns Zeta_Service_LinkPoint
	 */
	public function clearVat()
	{}
	
	/**
	 * Set the shipping amount. Optional.
	 *
	 * @param float $shipping
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setShipping($shipping)
	{}
	
	/**
	 * Returns the shipping amount.
	 * @returns float|integer
	 */
	public function getShipping()
	{}
	
	/**
	 * Clears the shipping amount.
	 * @returns Zeta_Service_LinkPoint
	 */
	public function clearShipping()
	{}
	
	/**
	 * Set the purchase total.
	 *
	 * @param float $subtotal
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setTotal($total)
	{}
	
	/**
	 * Returns the total amount.
	 * @returns float|integer
	 */
	public function getTotal()
	{}
	
	/**
	 * Add an item to the list of items in this purchase.
	 * @param array $item
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function addItem(array $item)
	{}
	
	/**
	 * Add multiple items to the list of items in this purchase.
	 * @param array $items
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function addItems(array $items)
	{}
	
	/**
	 * Returns whether or not an item exists in this purchase.
	 * @param string $id
	 * @returns boolean
	 */
	public function hasItem($id)
	{}
	
	/**
	 * Returns a single item, or FALSE if item doesn't exist.
	 * @param string $id
	 * @returns array|boolean
	 */
	public function getItem($id)
	{}
	
	/**
	 * Returns all items.
	 * @returns array
	 */
	public function getItems()
	{}
	
	/**
	 * Remove an item from the list of items in this purchase.
	 * @param string $id
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function removeItem($id)
	{}
	
	/**
	 * Remove multiple items from the list of items in this purchase.
	 * @param array $ids
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function removeItems(array $ids)
	{}
	
	/**
	 * Remove all items from the list of items in this purchase.
	 * @returns Zeta_Service_LinkPoint
	 */
	public function clearItems()
	{}
	
	/**
	 * Sets the transaction note.
	 * @returns Zeta_Service_LinkPoint
	 */
	public function setNote($note)
	{}
	
	/**
	 * Returns the transaction note.
	 * @returns string
	 */
	public function getNote()
	{}
	
	/**
	 * Sets the transaction referrer.
	 * @returns Zeta_Service_LinkPoint
	 */
	public function setReferrer($referrer)
	{}
	
	/**
	 * Returns the transaction referrer.
	 * @returns string
	 */
	public function getReferrer()
	{}
	
	/**
	 * Sets the payment object being used to pay
	 * for the transaction.
	 * @param Zeta_Service_LinkPoint_CreditCard|Zeta_Service_LinkPoint_Cheque
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setPaymentObject($object)
	{}
	
	/**
	 * Removes the payment object.
	 * @returns Zeta_Service_LinkPoint
	 */
	public function clearPaymentObject()
	{}
	
	/**
	 * Returns the payment object.
	 * @returns Zeta_Service_LinkPoint_Cheque|Zeta_Service_LinkPoint_CreditCard
	 */
	public function getPaymentObject()
	{}
	
	/**
	 * Sets the billing address.
	 * @param Zeta_Service_LinkPoint_Address $address
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setBillingAddress(Zeta_Service_LinkPoint_Address $address)
	{}
	
	/**
	 * Returns the billing address.
	 * @returns Zeta_Service_LinkPoint_Address
	 */
	public function getBillingAddress()
	{}

	/**
	 * Sets the shipping address. Optional.
	 * @param Zeta_Service_LinkPoint_Address $address
	 * @returns Zeta_Service_LinkPoint
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setShippingAddress(Zeta_Service_LinkPoint_Address $address)
	{}
	
	/**
	 * Returns the shipping address.
	 * @returns Zeta_Service_LinkPoint_Address
	 */
	public function getShippingAddress()
	{}
	
	/**
	 * Submits the current order to the payment processor.
	 *
	 * @param string $orderType
	 * @param string $testMode
	 * @returns boolean
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function process($orderType = 'sale', $testMode = 'live')
	{}
	
	/**
	 * Creates an XML string corresponding to a passed
	 * multi-dimensional array.
	 * @param string $rootKey
	 * @param array $data
	 * @returns string
	 */
	public static function buildXmlString($rootKey, array $data = array())
	{}
}

class Zeta_Service_LinkPoint_Address
{
	const BILLING  = 'billing';
	const SHIPPING = 'shipping';

	/**
	 * Address type.
	 * @var string
	 */
	protected $_addressType = 'billing';

	/**
	 * Customer name.
	 * @var string
	 */
	protected $_name;
	
	/**
	 * Company name. Optional.
	 * Billing address only.
	 * @var string
	 */
	protected $_companyName;
	
	/**
	 * Address line 1.
	 * @var string
	 */
	protected $_address1;
	
	/**
	 * Address building number.
	 * Pulled automatically from address line 1.
	 * @var int
	 */
	protected $_addressNumber;
	
	/**
	 * Address line 2. Optional.
	 * @var string
	 */
	protected $_address2;
	
	/**
	 * City name.
	 * @var string
	 */
	protected $_city;
	
	/**
	 * State/province. For US states,
	 * must be a valid 2-character state identifier.
	 * @var string
	 */
	protected $_province;
	
	/**
	 * Postal code.
	 * @var string
	 */
	protected $_postCode;
	
	/**
	 * Country code.
	 * @var string
	 */
	protected $_country;
	
	/**
	 * Phone number.
	 * @var string
	 */
	protected $_phone;
	
	/**
	 * Fax number. Optional.
	 * Billing address only.
	 * @var string
	 */
	protected $_fax;
	
	/**
	 * Email address. Optional. Used to email receipt.
	 * @var string
	 */
	protected $_email;
	
	/**
	 * User ID. Optional. Used to track customers.
	 * Billing address only.
	 * @var string
	 */
	protected $_userId;
	
	/**
	 * Weight of the order. Optional.
	 * Shipping address only.
	 * @var float
	 */
	protected $_weight;
	
	/**
	 * Number of items in the order. Optional.
	 * Shipping address only.
	 * @var integer
	 */
	protected $_itemCount;
	
	/**
	 * Shipping carrier ID. Optional.
	 * Shipping address only.
	 * @var integer
	 */
	protected $_shippingCarrier;
	
	/**
	 * Purchase total amount before shipping. Optional.
	 * Shipping address only.
	 */
	protected $_total;
	
	/**
	 * Constructor
	 *
	 * @param string $addressType
	 * @returns void
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function __construct($addressType = 'billing')
	{}
	
	/**
	 * Sets address type.
	 *
	 * @param string $addressType
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setAddressType($addressType)
	{}
	
	/**
	 * Returns address type.
	 * @returns string
	 */
	public function getAddressType()
	{}
	
	/**
	 * Sets customer name.
	 *
	 * @param string $name
	 * @returns Zeta_Service_LinkPoint_Address
	 */
	public function setName($name)
	{}
	
	/**
	 * Returns customer name.
	 * @returns string
	 */
	public function getName()
	{}
	
	/**
	 * Sets company name. Valid only for billing addresses.
	 *
	 * @param string $name
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setCompanyName($name)
	{}
	
	/**
	 * Returns company name.
	 * @returns string
	 */
	public function getCompanyName()
	{}
	
	/**
	 * Sets address.
	 *
	 * @param string $address1
	 * @param string $address2
	 * @returns Zeta_Service_LinkPoint_Address
	 */
	public function setAddress($address1, $address2 = null)
	{}
	
	/**
	 * Gets address parts.
	 * @param int $part
	 * @returns array|string
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function getAddress($part = null)
	{}
	
	/**
	 * Sets city name.
	 *
	 * @param string $city
	 * @returns Zeta_Service_LinkPoint_Address
	 */
	public function setCity($city)
	{}
	
	/**
	 * Returns city name.
	 * @returns string
	 */
	public function getCity()
	{}
	
	/**
	 * Sets province.
	 *
	 * @param string $province
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setProvince($province)
	{}
	
	/**
	 * Gets province.
	 * @returns string
	 */
	public function getProvince()
	{}
	
	/**
	 * Sets postal code.
	 *
	 * @param string $postCode
	 * @returns Zeta_Service_LinkPoint_Address
	 */
	public function setPostCode($postCode)
	{}
	
	/**
	 * Returns postal code.
	 * @returns string
	 */
	public function getPostCode()
	{}
	
	/**
	 * Sets country code.
	 *
	 * @param string $country
	 * @returns Zeta_Service_LinkPoint_Address
	 */
	public function setCountry($country)
	{}
	
	/**
	 * Returns country code.
	 * @returns string
	 */
	public function getCountry()
	{}
	
	/**
	 * Sets phone number.
	 *
	 * @param string $phone
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setPhone($phone)
	{}
	
	/**
	 * Returns phone number.
	 * @returns string
	 */
	public function getPhone()
	{}
	
	/**
	 * Sets fax number. Valid only for billing addresses.
	 *
	 * @param string $fax
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setFax($fax)
	{}
	
	/**
	 * Returns fax number.
	 * @returns string
	 */
	public function getFax()
	{}
	
	/**
	 * Sets email address.
	 *
	 * @param string $email
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setEmail($email)
	{}
	
	/**
	 * Returns email address.
	 * @returns string
	 */
	public function getEmail()
	{}
	
	/**
	 * Sets the user ID. Valid only for billing addresses.
	 *
	 * @param string $userId
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setUserId($userId)
	{}
	
	/**
	 * Returns the user ID.
	 * @returns string
	 */
	public function getUserId()
	{}
	
	/**
	 * Sets the transaction weight. Valid only for shipping addresses.
	 *
	 * @param float $weight
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setWeight($weight)
	{}
	
	/**
	 * Returns the weight.
	 * @returns float
	 */
	public function getWeight()
	{}
	
	/**
	 * Sets the number of items going to this address. Valid only for shipping addresses.
	 *
	 * @param int $items
	 * @returns Zeta_Service_LinkPoint_Address
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setItemCount($items)
	{}
	
	/**
	 * Returns the number of items going to this address.
	 * @returns integer
	 */
	public function getItemCount()
	{}
	
	/**
	 * Convert the address object into an XML entity
	 * that can be sent to the payment processor.
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function __toString()
	{}
}

class Zeta_Service_LinkPoint_Cheque
{
	const XML_ENTITY = 'telecheck';
	
	const PERSONAL_CHECKING = 'PC';
	const PERSONAL_SAVINGS = 'PS';
	const BUSINESS_CHECKING = 'BC';
	const BUSINESS_SAVINGS = 'BS';
	
	const NUMBER = 'number';
	const NAME = 'name';
	const PROVINCE = 'province';
	
	/**
	 * Account number.
	 * @var int
	 */
	protected $_accountNumber;
	
	/**
	 * Bank routing number.
	 * @var int
	 */
	protected $_routingNumber;
	
	/**
	 * Bank account type.
	 * @var string
	 */
	protected $_accountType = 'PC';
	
	/**
	 * Cheque number. Optional.
	 * @var int
	 */
	protected $_chequeNumber;
	
	/**
	 * Bank name.
	 * @var string
	 */
	protected $_bankName;
	
	/**
	 * Bank province.
	 * @var string
	 */
	protected $_bankProvince;
	
	/**
	 * Driver licence or government ID number.
	 * @var string
	 */
	protected $_idNumber;
	
	/**
	 * Driver licence/government ID province.
	 * @var string
	 */
	protected $_idProvince;
	
	/**
	 * Void the cheque.
	 * @var boolean
	 */
	protected $_void = false;
	
	/**
	 * Social security number. Optional.
	 * @var integer
	 */
	protected $_ssn;
	
	/**
	 * Constructor
	 *
	 * @param string $accountNumber
	 * @param string $routingNumber
	 * @param int $chequeNumber
	 * @param string $accountType
	 * @param string $bankName
	 * @param string $bankProvince
	 * @param string $idNumber
	 * @param string $idProvince
	 * @param boolean $void
	 * @param int $ssn
	 * @returns void
	 */
	public function __construct($accountNumber = null, $routingNumber = null, $chequeNumber = null,
		$accountType = null, $bankName = null, $bankProvince = null, $idNumber = null,
		$idProvince = null, $void = false, $ssn = null)
	{}
	
	/**
	 * Sets the bank account number, routing number, and account type.
	 *
	 * @param int $accountNumber
	 * @param int $routingNumber
	 * @param string $accountType
	 * @returns Zeta_Service_LinkPoint_Cheque
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setAccount($accountNumber, $routingNumber, $accountType = 'PC')
	{}
	
	/**
	 * Returns the account number.
	 * @returns int
	 */
	public function getAccountNumber()
	{}
	
	/**
	 * Returns the bank routing number.
	 * @returns int
	 */
	public function getRoutingNumber()
	{}
	
	/**
	 * Returns the account type.
	 * @returns string
	 */
	public function getAccountType()
	{}
	
	/**
	 * Sets the cheque number.
	 *
	 * @param int $chequeNumber
	 * @returns Zeta_Service_LinkPoint_Cheque
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function setChequeNumber($chequeNumber)
	{}
	
	/**
	 * Sets the bank name and province.
	 *
	 * @param string $bankName
	 * @param string $bankProvince
	 * @returns Zeta_Service_LinkPoint_Cheque
	 */
	public function setBank($bankName, $bankProvince)
	{}
	
	/**
	 * Returns bank information.
	 * @param string $part
	 * @returns array|string
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function getBank($part = null)
	{}
	
	/**
	 * Sets identification number and issuing province.
	 *
	 * @param int $chequeNumber
	 * @returns Zeta_Service_LinkPoint_Cheque
	 */
	public function setIdentification($idNumber, $idProvince)
	{}
	
	/**
	 * Gets identification information.
	 *
	 * @param string $part
	 * @returns array|string|integer
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function getIdentification($part = null)
	{}
	
	/**
	 * Set whether to void the cheque.
	 *
	 * @param boolean $void
	 * @returns Zeta_Service_LinkPoint_Cheque
	 */
	public function setVoid($void)
	{}
	
	/**
	 * Returns whether or not the cheque is to be voided.
	 * @returns boolean
	 */
	public function getVoid()
	{}
	
	/**
	 * Set the social security number.
	 *
	 * @param int $ssn
	 * @returns Zeta_Service_LinkPoint_Cheque
	 */
	public function setSsn($ssn)
	{}
	
	/**
	 * Returns the social security number.
	 * @returns int
	 */
	public function getSsn()
	{}
	
	/**
	 * Convert the cheque object into an XML entity
	 * that can be sent to the payment processor.
	 */
	public function __toString()
	{}
}

class Zeta_Service_LinkPoint_CreditCard
{
	const XML_ENTITY = 'creditcard';

	const CVM_PROVIDED     = 'provided';
	const CVM_NOT_PROVIDED = 'not_provided';
	const CVM_ILLEGIBLE    = 'illegible';
	const CVM_NOT_PRESENT  = 'not_present';
	const CVM_NO_IMPRINT   = 'no_imprint';

	const MONTH = 'month';
	const YEAR  = 'year';

	/**
	 * Credit card number.
	 * @var string
	 */
	protected $_ccNum = '';
	
	/**
	 * Credit card expiration month.
	 * @var int
	 */
	protected $_expMonth = 1;
	
	/**
	 * Credit card expiration year.
	 * @var int
	 */
	protected $_expYear = 2000;
	
	/**
	 * Card not present verification value.
	 * @var int
	 */
	protected $_cvm;
	
	/**
	 * Cart not present verification state.
	 * @var string
	 */
	protected $_cvmState = 'not_provided';
	
	/**
	 * Constructor
	 *
	 * @param string $ccNum
	 * @param int $expMonth
	 * @param int $expYear
	 * @param int $cvm
	 * @returns void
	 */
	public function __construct($ccNum = null, $expMonth = null, $expYear = null, $cvm = null)
	{}
	
	/**
	 * Validates and sets the credit card number.
	 *
	 * @param string $ccNum
	 * @returns Zeta_Service_LinkPoint_CreditCard
	 * @throws Zend_Validate_Exception
	 */
	public function setCcNum($ccNum)
	{}
	
	/**
	 * Returns the credit card number.
	 * @returns string
	 */
	public function getCcNum()
	{}
	
	/**
	 * Sets the expiration date.
	 *
	 * @param int $expMonth
	 * @param int $expYear
	 * @returns Zeta_Service_LinkPoint_CreditCard
	 * @throws Zend_Validate_Exception
	 */
	public function setExpiration($expMonth, $expYear)
	{}
	
	/**
	 * Returns the expiration date.
	 * @returns array|integer
	 * @throws Zeta_Service_LinkPoint_Exception
	 */
	public function getExpiration($part = null)
	{}
	
	/**
	 * Sets the CVM value.
	 *
	 * @param int $cvm
	 * @returns Zeta_Service_LinkPoint_CreditCard
	 * @throws Zend_Validate_Exception
	 */
	public function setCvm($cvm)
	{}
	
	/**
	 * Returns the CVM value, or FALSE if no CVM is provided.
	 *
	 * @returns int|boolean
	 */
	public function getCvm()
	{}
	
	/**
	 * Convert the credit card object into an XML entity
	 * that can be sent to the payment processor.
	 */
	public function __toString()
	{}
}

class Zeta_Service_LinkPoint_Exception extends Zend_Service_Exception
{}

Page Operations

Browse Space

Zend_Service_LinkPoint

Labels

Zend Framework: Zend_Service_LinkPoint Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons