BasicAuth¶
-
class
DreamCommerce\ShopAppstoreLib\Client\
BasicAuth
¶
A client library allowing to perform REST-ful requests using Basic
authentication method.
This class implements DreamCommerce\ShopAppstoreLib\ClientInterface
.
constants¶
HTTP_ERROR_AUTH_FAILURE
- Authentication failure
HTTP_ERROR_AUTH_IP_NOT_ALLOWED
- Failure due to invalid IP being used
HTTP_ERROR_AUTH_WEBAPI_ACCESS_DENIED
- Missing WebAPI credentials
methods¶
-
DreamCommerce\ShopAppstoreLib\Client\BasicAuth::
__construct
($options =[])¶ constructor
Parameters: - $options (array) – object instantiation options
Throws: ClientBasicAuthException
Available options keys:
username
- auth user name
password
- auth password
-
DreamCommerce\ShopAppstoreLib\Client\BasicAuth::
getUsername
()¶ Get already set user name.
-
DreamCommerce\ShopAppstoreLib\Client\BasicAuth::
setUsername
($username)¶ Set user name for request.
Parameters: - $username (string) – user name
-
DreamCommerce\ShopAppstoreLib\Client\BasicAuth::
getPassword
()¶ Get already set password.
-
DreamCommerce\ShopAppstoreLib\Client\BasicAuth::
setPassword
($password)¶ Set password for request.
Parameters: - $password (string) – password