Add PHPdoc to all methods, minor code reorder
Move some methods around to have them together by call order logic. Also update current test methods with composer based .env reader.
This commit is contained in:
@@ -5,68 +5,68 @@ namespace gullevek\AmazonIncentives\Config;
|
||||
interface ConfigInterface
|
||||
{
|
||||
/**
|
||||
* @return string
|
||||
* @return string Returns current set endpoint, without https://
|
||||
*/
|
||||
public function getEndpoint(): string;
|
||||
|
||||
/**
|
||||
* @param string $endpoint
|
||||
* @return ConfigInterface
|
||||
* @param string $endpoint Full endpoint url with https://
|
||||
* @return ConfigInterface Class interface (self)
|
||||
*/
|
||||
public function setEndpoint(string $endpoint): ConfigInterface;
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @return string Current access key
|
||||
*/
|
||||
public function getAccessKey(): string;
|
||||
|
||||
/**
|
||||
* @param string $key
|
||||
* @return ConfigInterface
|
||||
* @param string $key Access Key to set
|
||||
* @return ConfigInterface Class interface (self)
|
||||
*/
|
||||
public function setAccessKey(string $key): ConfigInterface;
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @return string Current secret key
|
||||
*/
|
||||
public function getSecret(): string;
|
||||
|
||||
/**
|
||||
* @param string $secret
|
||||
* @return ConfigInterface
|
||||
* @param string $secret Secret key to set
|
||||
* @return ConfigInterface Class interface (self)
|
||||
*/
|
||||
public function setSecret(string $secret): ConfigInterface;
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @return string Current set currency
|
||||
*/
|
||||
public function getCurrency(): string;
|
||||
|
||||
/**
|
||||
* @param string $currency
|
||||
* @return ConfigInterface
|
||||
* @param string $currency Currency to set (eg USD, JPY, etc)
|
||||
* @return ConfigInterface Class interface (self)
|
||||
*/
|
||||
public function setCurrency(string $currency): ConfigInterface;
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @return string Current set partner id
|
||||
*/
|
||||
public function getPartner(): string;
|
||||
|
||||
/**
|
||||
* @param string $partner
|
||||
* @return ConfigInterface
|
||||
* @param string $partner Partner id to set
|
||||
* @return ConfigInterface Class interface (self)
|
||||
*/
|
||||
public function setPartner(string $partner): ConfigInterface;
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
* @return bool Current set debug flag as bool
|
||||
*/
|
||||
public function getDebug(): bool;
|
||||
|
||||
/**
|
||||
* @param bool $debug
|
||||
* @return ConfigInterface
|
||||
* @param bool $debug Set debug flag as bool
|
||||
* @return ConfigInterface Class interface (self)
|
||||
*/
|
||||
public function setDebug(bool $debug): ConfigInterface;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user