<?php if (!defined('PAGSEGURO_LIBRARY')) { die('No direct script access allowed'); }

/*

************************************************************************

Copyright [2011] [PagSeguro Internet Ltda.]



Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at



http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

************************************************************************

*/



/**

 * Represents a payment request

 */

class PaymentRequest  {

	

	/**

	* Party that will be sending the money

	*/

    private $sender;

    

    /**

     * Payment currency

     */

    private	$currency;



    /**

     * Products/items in this payment request

     */

    private $items;

    

    /**

     * Uri to where the PagSeguro payment page should redirect the user after the payment information is processed.

     * Typically this is a confirmation page on your web site.

     */

    private $redirectURL;

    

    /**

     * Extra amount to be added to the transaction total

     * 

     * This value can be used to add an extra charge to the transaction

     * or provide a discount in the case ExtraAmount is a negative value.

     */

    private $extraAmount;

    

    /**

    * Reference code

    *

    * Optional. You can use the reference code to store an identifier so you can

    * associate the PagSeguro transaction to a transaction in your system.

    */

    private $reference;	

    

    /**

     * Shipping information associated with this payment request

     */

    private $shipping;

    

    /**

     * How long this payment request will remain valid, in seconds.

     *

     * Optional. After this payment request is submitted, the payment code returned

     * will remain valid for the period specified here.

     */

    private $maxAge;

    

    /**

     * How many times the payment redirect uri returned by the payment web service can be accessed.

     *

     * Optional. After this payment request is submitted, the payment redirect uri returned by

     * the payment web service will remain valid for the number of uses specified here.

     */

    private $maxUses;

	

    /**

     * @return the sender

     *

     * Party that will be sending the Uri to where the PagSeguro payment page should redirect the user after the payment information is processed.

     * money

     */

	public function getSender() {

        return $this->sender;

    }



    /**

     * Sets the Sender, party that will be sending the money

     * @param String $name

     * @param String $email

     * @param String $areaCode

     * @param String $number

     */

	public function setSender($name, $email = null, $areaCode = null, $number = null) {

        $param = $name;

		if (is_array($param)) {

        	$this->sender = new Sender($param);

        } elseif($param instanceof Sender) {

        	$this->sender = $param;

        } else {

        	$sender = new Sender();

        	$sender->setName($param);

        	$sender->setEmail($email);

        	$sender->setPhone(new Phone($areaCode, $number));

        	$this->sender = $sender;

        }

    }

    

    /**

     * Sets the name of the sender, party that will be sending the money

     * @param String $senderName

     */

    public function setSenderName($senderName) {

    	if ($this->sender == null) {

            $this->sender = new Sender();

        }

        $this->sender->setName($senderName);

    }

    

    /**

     * Sets the name of the sender, party that will be sending the money

     * @param String $senderEmail

     */

    public function setSenderEmail($senderEmail) {

    	if ($this->sender == null) {

    		$this->sender = new Sender();

    	}

    	$this->sender->setEmail($senderEmail);

    }

    

    /**

     * Sets the Sender phone number, phone of the party that will be sending the money

     *

     * @param areaCode

     * @param number

     */

    public function setSenderPhone($areaCode, $number = null) {

    	$param = $areaCode;

    	if ($this->sender == null) {

    		$this->sender = new Sender();

    	}

    	if ($param instanceof Phone) {

    		$this->sender->setPhone($param);

    	} else {

    		$this->sender->setPhone(new Phone($param, $number));

    	}

    }



    /**

     * @return the currency

     * Example: BRL

     */

    public function getCurrency() {

        return $this->currency;

    }



    /**

     * Sets the currency

     * @param String $currency

     */

    public function setCurrency($currency) {

        $this->currency = $currency;

    }



    /**

     * @return the items/products list in this payment request

     */

    public function getItems() {

        return $this->items;

    }



    /**

     * Sets the items/products list in this payment request

     * @param array $items

     */

    public function setItems(Array $items) {

    	if (is_array($items)) {

    		$i = Array();

    		foreach ($items as $key => $item) {

    			if ($item instanceof Item) {

    				$i[$key] = $item;

    			} else if (is_array($item)) {

    				$i[$key] = new Item($item);

    			}

    		}

    	}

    	$this->items = $i;

    }



	/**

	 * Adds a new product/item in this payment request

	 * 

	 * @param String $id

	 * @param String $description

	 * @param String $quantity

	 * @param String $amount

	 * @param String $weight

	 * @param String $shippingCost

	 */

    public function addItem($id, $description = null, $quantity = null, $amount = null, $weight = null, $shippingCost = null) {

    	$param = $id;

    	if ($this->items == null) {

            $this->items = Array();

        }

        if (is_array($param)) {

        	array_push($this->items, new Item($param));

        } else if ($param instanceof Item) {

        	array_push($this->items, $param);

        } else {

        	$item = new Item();

        	$item->setId($param);

        	$item->setDescription($description);

        	$item->setQuantity($quantity);

        	$item->setAmount($amount);

        	$item->setWeight($weight);

        	$item->setShippingCost($shippingCost);

        	array_push($this->items, $item);

        }

    }



    /**

     * Uri to where the PagSeguro payment page should redirect the user after the payment information is processed.

     * Typically this is a confirmation page on your web site.

     *

     * @return the redirectURL

     */

    public function getRedirectURL() {

        return $this->redirectURL;

    }



    /**

     * Sets the redirect URL

     * 

     * Uri to where the PagSeguro payment page should redirect the user after the payment information is processed.

     * Typically this is a confirmation page on your web site.

     * 

     * @param String $redirectURL

     */

    public function setRedirectURL($redirectURL) {

        $this->redirectURL = $redirectURL;

    }



    /**

     * This value can be used to add an extra charge to the transaction

     * or provide a discount in the case ExtraAmount is a negative value.

     *

     * @return the extra amount

     */

    public function getExtraAmount() {

        return $this->extraAmount;

    }



    /**

     * Sets the extra amount

     * This value can be used to add an extra charge to the transaction

     * or provide a discount in the case <b>extraAmount</b> is a negative value.

     *

     * @param extraAmount

     */

    public function setExtraAmount($extraAmount) {

        $this->extraAmount = $extraAmount;

    }



    /**

     * @return the reference of this payment request

     */

    public function getReference() {

        return $this->reference;

    }



    /**

     * Sets the reference of this payment request

     * @param reference

     */

    public function setReference($reference) {

        $this->reference = $reference;

    }

	

	/**

	 * @return the shipping information for this payment request

	 * @see Shipping

	 */

    public function getShipping() {

        return $this->shipping;

    }



    /**

     * Sets the shipping information for this payment request

     * @param Shipping $address

     * @param ShippingType $type

     */

    public function setShipping($address, $type = null) {

    	$param = $address;

    	if ($param instanceof Shipping) {

    		$this->shipping = $param;

    	} else {

    		$shipping = new Shipping();

    		if (is_array($param)) {

    			$shipping->setAddress(new Address($param));

    		} else if ($param instanceof Address) {

    			$shipping->setAddress($param);

    		}

    		if ($type) {

    			if ($type instanceof ShippingType) {

    				$shipping->setType($type);

    			} else {

    				$shipping->setType(new ShippingType($type));

    			}    		

    		}

    		$this->shipping = $shipping;

    	}  

    }



    /**

     * Sets the shipping address for this payment request

     * @param String $postalCode

     * @param String $street

     * @param String $number

     * @param String $complement

     * @param String $district

     * @param String $city

     * @param String $state

     * @param String $country

     */

    public function setShippingAddress($postalCode = null, $street = null, $number = null, $complement = null, $district = null, $city = null, $state = null, $country = null) {

    	$param = $postalCode;

    	if ($this->shipping == null) {

			$this->shipping = new Shipping();

		}

		if (is_array($param)) {

			$this->shipping->setAddress(new Address($param));

		} elseif ($param instanceof Address) {

			$this->shipping->setAddress($param);

		} else {

			$address = new Address();

			$address->setPostalCode($postalCode);

			$address->setStreet($street);

			$address->setNumber($number);

			$address->setComplement($complement);

			$address->setDistrict($district);

			$address->setCity($city);

			$address->setState($state);

			$address->setCountry($country);

			$this->shipping->setAddress($address);

		}

    }

    

    /**

     * Sets the shipping type for this payment request

     * @param ShippingType $type

     */

    public function setShippingType($type) {

    	$param = $type;

    	if ($this->shipping == null) {

    		$this->shipping = new Shipping();

    	}

    	if ($param instanceof ShippingType) {

    		$this->shipping->setType($param);

    	} else {

    		$this->shipping->setType(new ShippingType($param));

    	}

    }

    

    /**

     * @return the max age of this payment request

     *

     * After this payment request is submitted, the payment code returned

     * will remain valid for the period specified.

     */

    public function getMaxAge() {

        return $this->maxAge;

    }



    /**

    * Sets the max age of this payment request

    * After this payment request is submitted, the payment code returned

    * will remain valid for the period specified here.

    *

    * @param maxAge

    */

    public function setMaxAge($maxAge) {

        $this->maxAge = $maxAge;

    }



    /**

     * After this payment request is submitted, the payment redirect uri returned by

     * the payment web service will remain valid for the number of uses specified here.

     *

     * @return the max uses configured for this payment request

     */

    public function getMaxUses() {

        return $this->maxUses;

    }



    /**

     * Sets the max uses of this payment request

     *

     * After this payment request is submitted, the payment redirect uri returned by

     * the payment web service will remain valid for the number of uses specified here.

     *

     * @param maxUses

     */

    public function setMaxUses($maxUses) {

        $this->maxUses = $maxUses;

    }

	

    /**

     * Calls the PagSeguro web service and register this request for payment

     * 

     * @param Credentials $credentials

     * @return The URL to where the user needs to be redirected to in order to complete the payment process

     */

    public function register(Credentials $credentials) {

		return PaymentService::createCheckoutRequest($credentials, $this);

    }

	

	/**

    * @return a string that represents the current object

    */

	public function toString(){

		$email = $this->sender ? $this->sender->getEmail() : "null";

		return "PaymentRequest(Reference=".$this->reference.",     SenderEmail=".$email.")";

	}

	

	

}

?>