11<?php
2- namespace PHPCommerce \Entity ;
2+ namespace PHPCommerce \Payment \ Entity ;
33
44/**
55 * <p>This entity is designed to deal with payments associated to an {@link Order} and is <i>usually</i> unique for a particular
2323class OrderPayment /*extends Serializable, Status*/ {
2424 protected $ id ;
2525
26- protected $ order ;
26+ // protected $order;
2727
2828 public function getId ()
2929 {
@@ -38,107 +38,107 @@ public function setId($id)
3838 /**
3939 * @return Order
4040 */
41- public function getOrder ()
41+ /* public function getOrder()
4242 {
4343 return $this->order;
4444 }
45-
45+ */
4646 /**
4747 * @param Order $order
4848 * @return mixed
4949 */
50- public function setOrder (Order $ order )
50+ /* public function setOrder(Order $order)
5151 {
5252 $this->order = $order;
5353 }
54-
54+ */
5555 /**
5656 * Gets the billing address associated with this payment. This might be null for some payments where no billing address
5757 * is required (like gift cards or account credit)
5858 * @return Address
5959 */
60- public function getBillingAddress ()
60+ /* public function getBillingAddress()
6161 {
6262
63- }
63+ }*/
6464
6565 /**
6666 * Sets the billing address associated with this payment. This might be null for some payments where no billing address
6767 * is required (like gift cards or account credit)
6868 */
69- public function setBillingAddress (Address $ billingAddress )
69+ /* public function setBillingAddress(Address $billingAddress)
7070 {
7171
72- }
72+ }*/
7373
7474 /**
7575 * The amount that this payment is allotted for. The summation of all of the {@link OrderPayment}s for a particular
7676 * {@link Order} should equal {@link Order#getTotal()}
7777 * @return Money
7878 */
79- public function getAmount ()
79+ /* public function getAmount()
8080 {
8181
82- }
82+ }*/
8383
8484 /**
8585 * The amount that this payment is allotted for. The summation of all of the {@link OrderPayment}s for a particular
8686 * {@link Order} should equal {@link Order#getTotal()}
8787 */
88- public function setAmount (Money $ amount )
88+ /* public function setAmount(Money $amount)
8989 {
9090
91- }
91+ }*/
9292
9393 /**
9494 * The soft link to a {@link Referenced} entity which will be stored in the blSecurePU persistence unit. If you are not
9595 * attempting to store credit cards in your own database (which is the usual, recommended case) then this will not be
9696 * used or set. If you do use this reference number, this can be anything that is unique (like System.currentTimeMillis()).
9797 */
98- public function getReferenceNumber ()
98+ /* public function getReferenceNumber()
9999 {
100100
101- }
101+ }*/
102102
103103 /**
104104 * Sets the soft link to a {@link Referenced} entity stored in the blSecurePU persistence unit. This will likely not
105105 * be used as the common case is to not store credit cards yourself.
106106 */
107- public function setReferenceNumber ($ referenceNumber )
107+ /* public function setReferenceNumber($referenceNumber)
108108 {
109109
110- }
110+ }*/
111111
112112 /**
113113 * The type of this payment like Credit Card or Gift Card.
114114 *
115115 * @see {@link PaymentType}
116116 * @return PaymentType
117117 */
118- public function getType ()
118+ /* public function getType()
119119 {
120120
121- }
121+ }*/
122122
123123 /**
124124 * Sets the type of this payment like Credit Card or Gift Card
125125 *
126126 * @see {@link PaymentType}
127127 */
128- public function setType (PaymentType $ type )
128+ /* public function setType(PaymentType $type)
129129 {
130130
131- }
131+ }*/
132132
133133 /**
134134 * Gets the gateway that was used to process this order payment. Only a SINGLE payment gateway can modify transactions
135135 * on a particular order payment.
136136 * @return PaymentGatewayType
137137 */
138- public function getGatewayType ()
138+ /* public function getGatewayType()
139139 {
140140
141- }
141+ }*/
142142
143143 /**
144144 * <p>Gets the gateway that was used to process this order payment. Only a SINGLE payment gateway can modify transactions
@@ -147,10 +147,10 @@ public function getGatewayType()
147147 * <p>It usually does not make sense to modify the gateway type after it has already been set once. Instead, consider
148148 * just archiving this payment type (by deleting it) and creating a new payment for the new gateway.</p>
149149 */
150- public function setPaymentGatewayType (PaymentGatewayType $ gatewayType )
150+ /* public function setPaymentGatewayType(PaymentGatewayType $gatewayType)
151151 {
152152
153- }
153+ }*/
154154
155155 /**
156156 * <p>All of the transactions that have been applied to this particular payment. Transactions are denoted by the various
@@ -162,10 +162,10 @@ public function setPaymentGatewayType(PaymentGatewayType $gatewayType)
162162 * @see {@link #addTransaction(PaymentTransaction)}
163163 * @return PaymentTransaction[]
164164 */
165- public function getTransactions ()
165+ /* public function getTransactions()
166166 {
167167
168- }
168+ }*/
169169
170170 /**
171171 * <p>All of the transactions that have been applied to this particular payment. Transactions are denoted by the various
@@ -177,19 +177,19 @@ public function getTransactions()
177177 * @see {@link #addTransaction(PaymentTransaction)}
178178 * @param PaymentTransaction
179179 */
180- public function setTransactions ($ details )
180+ /* public function setTransactions($details)
181181 {
182182
183- }
183+ }*/
184184
185185 /**
186186 * A more declarative way to invoke {@link #getTransactions().add()}. This is the preferred way to add a transaction
187187 * to this payment.
188188 */
189- public function addTransaction (PaymentTransaction $ transaction )
189+ /* public function addTransaction(PaymentTransaction $transaction)
190190 {
191191
192- }
192+ }*/
193193
194194 /**
195195 * Returns a transaction for given <b>type</b>. This is useful when validating whether or not a {@link PaymentTransaction}
@@ -201,10 +201,10 @@ public function addTransaction(PaymentTransaction $transaction)
201201 *
202202 * @return PaymentTransaction[]
203203 */
204- public function getTransactionsForType (PaymentTransactionType $ type )
204+ /* public function getTransactionsForType(PaymentTransactionType $type)
205205 {
206206
207- }
207+ }*/
208208
209209 /**
210210 * Returns the initial transaction for this order payment. This would either be an {@link PaymentTransactionType#AUTHORIZE}
@@ -214,10 +214,10 @@ public function getTransactionsForType(PaymentTransactionType $type)
214214 *
215215 * @return PaymentTransaction the initial transaction for this order payment or null if there isn't any
216216 */
217- public function getInitialTransaction ()
217+ /* public function getInitialTransaction()
218218 {
219219
220- }
220+ }*/
221221
222222 /**
223223 * Looks through all of the transactions for this payment and adds up the amount for the given transaction type. This
@@ -227,21 +227,21 @@ public function getInitialTransaction()
227227 * @return the amount of all of the transactions for the given type
228228 * @see {@link #getSuccessfulTransactionAmountForType(PaymentTransactionType)}
229229 */
230- public function getTransactionAmountForType (PaymentTransactionType $ type )
230+ /* public function getTransactionAmountForType(PaymentTransactionType $type)
231231 {
232232
233- }
233+ }*/
234234
235235 /**
236236 * Returns all of the transactions on this payment that were successful for the given type.
237237 *
238238 * @param type the type of transaction
239239 * @return the amount of all of the transaction on this payment for the given type that have been successful
240240 */
241- public function getSuccessfulTransactionAmountForType (PaymentTransactionType $ type )
241+ /* public function getSuccessfulTransactionAmountForType(PaymentTransactionType $type)
242242 {
243243
244- }
244+ }*/
245245
246246 /**
247247 * Looks through all of the transactions for this payment and returns whether or not
@@ -250,10 +250,10 @@ public function getSuccessfulTransactionAmountForType(PaymentTransactionType $ty
250250 *
251251 * @return
252252 */
253- public function isConfirmed ()
253+ /* public function isConfirmed()
254254 {
255255
256- }
256+ }*/
257257
258258 /**
259259 * Returns whether or not this payment is considered to be the final payment on the order.
@@ -266,18 +266,18 @@ public function isConfirmed()
266266 *
267267 * @return bool
268268 */
269- public function isFinalPayment ()
269+ /* public function isFinalPayment()
270270 {
271271
272- }
272+ }*/
273273
274274 /**
275275 * The currency that this payment should be taken in. This is a delegate to {@link #getOrder()#getCurrency()}.
276276 * @return BroadleafCurrency
277277 */
278- public function getCurrency ()
278+ /* public function getCurrency()
279279 {
280280
281- }
281+ }*/
282282
283283}
0 commit comments