Skip to content

Commit 12ceea9

Browse files
Changed annotations to fit project line length limit
Multi line descriptions are allowed for the @method tag, these should now be within the 120 char limit for the project.
1 parent e954e51 commit 12ceea9

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

src/Omnipay/Common/GatewayInterface.php

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,28 @@
1212
* Omnipay gateway needs to define.
1313
*
1414
* @see AbstractGateway
15-
*
16-
* @method \Omnipay\Common\Message\ResponseInterface authorize(array $options = array()) (Optional method) Authorize an amount on the customers card
17-
* @method \Omnipay\Common\Message\ResponseInterface completeAuthorize(array $options = array()) (Optional method) Handle return from off-site gateways after authorization
18-
* @method \Omnipay\Common\Message\ResponseInterface capture(array $options = array()) (Optional method) Capture an amount you have previously authorized
19-
* @method \Omnipay\Common\Message\ResponseInterface purchase(array $options = array()) (Optional method) Authorize and immediately capture an amount on the customers card
20-
* @method \Omnipay\Common\Message\ResponseInterface completePurchase(array $options = array()) (Optional method) Handle return from off-site gateways after purchase
21-
* @method \Omnipay\Common\Message\ResponseInterface refund(array $options = array()) (Optional method) Refund an already processed transaction
22-
* @method \Omnipay\Common\Message\ResponseInterface void(array $options = array()) (Optional method) Generally can only be called up to 24 hours after submitting a transaction
23-
* @method \Omnipay\Common\Message\ResponseInterface createCard(array $options = array()) (Optional method) The returned response object includes a cardReference, which can be used for future transactions
24-
* @method \Omnipay\Common\Message\ResponseInterface updateCard(array $options = array()) (Optional method) Update a stored card
25-
* @method \Omnipay\Common\Message\ResponseInterface deleteCard(array $options = array()) (Optional method) Delete a stored card
26-
*/
15+
*
16+
* @method \Omnipay\Common\Message\ResponseInterface authorize(array $options = array()) (Optional method)
17+
* Authorize an amount on the customers card
18+
* @method \Omnipay\Common\Message\ResponseInterface completeAuthorize(array $options = array()) (Optional method)
19+
* Handle return from off-site gateways after authorization
20+
* @method \Omnipay\Common\Message\ResponseInterface capture(array $options = array()) (Optional method)
21+
* Capture an amount you have previously authorized
22+
* @method \Omnipay\Common\Message\ResponseInterface purchase(array $options = array()) (Optional method)
23+
* Authorize and immediately capture an amount on the customers card
24+
* @method \Omnipay\Common\Message\ResponseInterface completePurchase(array $options = array()) (Optional method)
25+
* Handle return from off-site gateways after purchase
26+
* @method \Omnipay\Common\Message\ResponseInterface refund(array $options = array()) (Optional method)
27+
* Refund an already processed transaction
28+
* @method \Omnipay\Common\Message\ResponseInterface void(array $options = array()) (Optional method)
29+
* Generally can only be called up to 24 hours after submitting a transaction
30+
* @method \Omnipay\Common\Message\ResponseInterface createCard(array $options = array()) (Optional method)
31+
* The returned response object includes a cardReference, which can be used for future transactions
32+
* @method \Omnipay\Common\Message\ResponseInterface updateCard(array $options = array()) (Optional method)
33+
* Update a stored card
34+
* @method \Omnipay\Common\Message\ResponseInterface deleteCard(array $options = array()) (Optional method)
35+
* Delete a stored card
36+
*/
2737
interface GatewayInterface
2838
{
2939
/**

0 commit comments

Comments
 (0)