Skip to content

Commit b852110

Browse files
authored
Add Comments of return data type
Add Comments of return data type on GatewayInterface so my IDE can hint me when I wrote code like `$gateway=new Omnipay('xxPayType'); $gateway->initialize($config)->someOperation($params);`
1 parent 07b94b6 commit b852110

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/Common/GatewayInterface.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ interface GatewayInterface
4040
* Get gateway display name
4141
*
4242
* This can be used by carts to get the display name for each gateway.
43+
*
44+
* @return string
4345
*/
4446
public function getName();
4547

@@ -48,6 +50,8 @@ public function getName();
4850
*
4951
* This name can be used with GatewayFactory as an alias of the gateway class,
5052
* to create new instances of this gateway.
53+
*
54+
* @return string
5155
*/
5256
public function getShortName();
5357

@@ -59,11 +63,15 @@ public function getShortName();
5963
* 'testMode' => false, // boolean variable
6064
* 'landingPage' => array('billing', 'login'), // enum variable, first item is default
6165
* );
66+
*
67+
* @return array
6268
*/
6369
public function getDefaultParameters();
6470

6571
/**
6672
* Initialize gateway with parameters
73+
*
74+
* @return $this
6775
*/
6876
public function initialize(array $parameters = array());
6977

0 commit comments

Comments
 (0)