Customer Class

The Customer class in the Mypos\IPC namespace is used to collect, manage, and validate customer details for transactions. It is commonly used in purchase and card storage flows to provide required information about the client.

Class Information

Namespace: Mypos\IPC
File: Customer.php
Purpose: Holds customer contact and address information, validates completeness before making a payment request.

Method Summary

Method	Return Type	Description
`getPhone()`	`string`	Returns the customer's phone number.
`setPhone(string $phone)`	`Customer`	Sets the customer's phone number.
`getFirstName()`	`string`	Returns the customer's first name.
`setFirstName(string $firstName)`	`Customer`	Sets the customer's first name.
`getLastName()`	`string`	Returns the customer's last name.
`setLastName(string $lastName)`	`Customer`	Sets the customer's last name.
`getEmail()`	`string`	Returns the customer's email address.
`setEmail(string $email)`	`Customer`	Sets the customer's email address.
`getCountry()`	`string`	Returns the ISO 3166-1 country code.
`setCountry(string $country)`	`Customer`	Sets the customer's country code.
`getCity()`	`string`	Returns the city.
`setCity(string $city)`	`Customer`	Sets the city.
`getZip()`	`string`	Returns the ZIP/postal code.
`setZip(string $zip)`	`Customer`	Sets the ZIP/postal code.
`getAddress()`	`string`	Returns the full address.
`setAddress(string $address)`	`Customer`	Sets the full address.
`validate(string $paymentParametersRequired)`	`bool`	Validates the provided customer data based on required parameters.

Example Usage

<?php
namespace Mypos\IPC;
/**
 * Customer details class.
 * Collect and validate client details
 */
class Customer
{
    private $email;
    private $phone;
    private $firstName;
    private $lastName;
    private $country;
    private $city;
    private $zip;
    private $address;
    /**
     * Customer Phone number
     *
     * @return string
     */
    public function getPhone()
    {
        return $this->phone;
    }
    /**
     * Customer Phone number
     *
     * @param string $phone
     *
     * @return Customer
     */
    public function setPhone($phone)
    {
        $this->phone = $phone;
        return $this;
    }
    /**
     * Customer country code ISO 3166-1
     *
     * @return string
     */
    public function getCountry()
    {
        return $this->country;
    }
    /**
     * Customer country code ISO 3166-1
     *
     * @param string $country
     *
     * @return Customer
     */
    public function setCountry($country)
    {
        $this->country = $country;
        return $this;
    }
    /**
     * Customer city
     *
     * @return string
     */
    public function getCity()
    {
        return $this->city;
    }
    /**
     * Customer city
     *
     * @param string $city
     *
     * @return Customer
     */
    public function setCity($city)
    {
        $this->city = $city;
        return $this;
    }
    /**
     * Customer ZIP code
     *
     * @return string
     */
    public function getZip()
    {
        return $this->zip;
    }
    /**
     * Customer ZIP code
     *
     * @param string $zip
     *
     * @return Customer
     */
    public function setZip($zip)
    {
        $this->zip = $zip;
        return $this;
    }
    /**
     * Customer address
     *
     * @return string
     */
    public function getAddress()
    {
        return $this->address;
    }
    /**
     * Customer address
     *
     * @param string $address
     *
     * @return Customer
     */
    public function setAddress($address)
    {
        $this->address = $address;
        return $this;
    }
    /**
     * Validate all set customer details
     *
     * @param string $paymentParametersRequired
     *
     * @return bool
     * @throws IPC_Exception
     */
    public function validate($paymentParametersRequired)
    {
        if ($paymentParametersRequired == Purchase::PURCHASE_TYPE_FULL) {
            if ($this->getFirstName() == null) {
                throw new IPC_Exception('Invalid First name');
            }
            if ($this->getLastName() == null) {
                throw new IPC_Exception('Invalid Last name');
            }
            if ($this->getEmail() == null || !Helper::isValidEmail($this->getEmail())) {
                throw new IPC_Exception('Invalid Email');
            }
        }
        return true;
    }
    /**
     * Customer first name
     *
     * @return string
     */
    public function getFirstName()
    {
        return $this->firstName;
    }
    /**
     * Customer first name
     *
     * @param string $firstName
     *
     * @return Customer
     */
    public function setFirstName($firstName)
    {
        $this->firstName = $firstName;
        return $this;
    }
    /**
     * Customer last name
     *
     * @return string
     */
    public function getLastName()
    {
        return $this->lastName;
    }
    /**
     * Customer last name
     *
     * @param string $lastName
     *
     * @return Customer
     */
    public function setLastName($lastName)
    {
        $this->lastName = $lastName;
        return $this;
    }
    /**
     * Customer Email address
     *
     * @return string
     */
    public function getEmail()
    {
        return $this->email;
    }
    /**
     * Customer Email address
     *
     * @param string $email
     *
     * @return Customer
     */
    public function setEmail($email)
    {
        $this->email = $email;
        return $this;
    }
}

Use Cases

Use the Customer class when:

You need to pass customer billing/shipping info during a purchase
You want to pre-fill customer fields on the payment page
You need to comply with AVS (Address Verification System) requirements