forked from LiveCarta/PayPal-PHP-SDK
Removing coveralls from dev dependencies / updating composer instructions
This commit is contained in:
32
README.md
32
README.md
@@ -1,35 +1,31 @@
|
|||||||
REST API SDK for PHP
|
# REST API SDK for PHP
|
||||||
====================
|
|
||||||
[](https://travis-ci.org/paypal/rest-api-sdk-php) [](https://coveralls.io/r/paypal/rest-api-sdk-php?branch=master) [](https://packagist.org/packages/paypal/rest-api-sdk-php) [](https://packagist.org/packages/paypal/rest-api-sdk-php)
|
[](https://travis-ci.org/paypal/rest-api-sdk-php) [](https://coveralls.io/r/paypal/rest-api-sdk-php?branch=master) [](https://packagist.org/packages/paypal/rest-api-sdk-php) [](https://packagist.org/packages/paypal/rest-api-sdk-php)
|
||||||
|
|
||||||
This repository contains PayPal's PHP SDK and samples for REST API.
|
This repository contains PayPal's PHP SDK and samples for REST API.
|
||||||
|
|
||||||
|
|
||||||
Prerequisites
|
## Prerequisites
|
||||||
-------------
|
|
||||||
|
|
||||||
* PHP 5.3 or above
|
* PHP 5.3 or above
|
||||||
* curl, json & openssl extensions must be enabled
|
* curl, json & openssl extensions must be enabled
|
||||||
* composer for running the sample out of the box (See http://getcomposer.org)
|
* composer for running the sample out of the box (See http://getcomposer.org)
|
||||||
|
|
||||||
|
|
||||||
Running the sample
|
## Running the sample
|
||||||
------------------
|
|
||||||
|
|
||||||
* Ensure that you have composer installed on your machine.
|
* Ensure that you have composer installed on your machine.
|
||||||
* Navigate to the samples folder and run 'composer update'.
|
* Navigate to the samples folder and run 'composer update --no-dev'.
|
||||||
* Optionally, update the bootstrap.php file with your own client Id and client secret.
|
* Optionally, update the bootstrap.php file with your own client Id and client secret.
|
||||||
* Run any of the samples in the 'samples' folder to see what the APIs can do.
|
* Run any of the samples in the 'samples' folder to see what the APIs can do.
|
||||||
|
|
||||||
|
|
||||||
Usage
|
## Usage
|
||||||
-----
|
|
||||||
|
|
||||||
To write an app that uses the SDK
|
To write an app that uses the SDK
|
||||||
|
|
||||||
* Copy the composer.json file from the sample folder over to your project and run 'composer update' to fetch all
|
* Copy the composer.json file from the sample folder over to your project and run 'composer update --no-dev' to fetch all dependencies.
|
||||||
dependencies
|
* Copy the sample configuration file sdk_config.ini to a location of your choice and let the SDK know your config path using the following define directive.
|
||||||
* Copy the sample configuration file sdk_config.ini to a location of your choice and let the SDK know your config path using the following define directive
|
|
||||||
|
|
||||||
```php
|
```php
|
||||||
define('PP_CONFIG_PATH', /path/to/your/sdk_config.ini);
|
define('PP_CONFIG_PATH', /path/to/your/sdk_config.ini);
|
||||||
@@ -40,7 +36,7 @@ dependencies
|
|||||||
|
|
||||||
```php
|
```php
|
||||||
|
|
||||||
$apiContext = new ApiContext(new OAuthTokenCredential('<clientId>', '<clientSecret'));
|
$apiContext = new ApiContext(new OAuthTokenCredential('<clientId>', '<clientSecret>'));
|
||||||
|
|
||||||
$payment = new Payment();
|
$payment = new Payment();
|
||||||
|
|
||||||
@@ -55,14 +51,14 @@ dependencies
|
|||||||
$payment = Payment::get('payment_id', $apiContext);
|
$payment = Payment::get('payment_id', $apiContext);
|
||||||
```
|
```
|
||||||
|
|
||||||
These examples pick the SDK configuration from the sdk_config.ini file. If you do not want to use an ini file or want to pick your configuration dynamically, you can use the `$apiContext->setConfig()` method to pass in the configuration.
|
## SDK Configuration
|
||||||
|
|
||||||
|
The samples in this repo pick the SDK configuration from the sdk_config.ini file. If you do not want to use an ini file or want to pick your configuration dynamically, you can use the `$apiContext->setConfig()` method to pass in the configuration as a hashmap. See the `sample/bootstrap.php` file for an example.
|
||||||
|
|
||||||
|
|
||||||
Contributing
|
## Contributing
|
||||||
------------
|
|
||||||
|
|
||||||
More help
|
## More help
|
||||||
---------
|
|
||||||
|
|
||||||
* [API Reference](https://developer.paypal.com/webapps/developer/docs/api/)
|
* [API Reference](https://developer.paypal.com/webapps/developer/docs/api/)
|
||||||
* [Reporting issues / feature requests] (https://github.com/paypal/rest-api-sdk-php/issues)
|
* [Reporting issues / feature requests] (https://github.com/paypal/rest-api-sdk-php/issues)
|
||||||
@@ -18,8 +18,7 @@
|
|||||||
"paypal/sdk-core-php": "2.4.*"
|
"paypal/sdk-core-php": "2.4.*"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"phpunit/phpunit": "3.7.*",
|
"phpunit/phpunit": "3.7.*"
|
||||||
"satooshi/php-coveralls": "dev-master"
|
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-0": {
|
"psr-0": {
|
||||||
|
|||||||
Reference in New Issue
Block a user