Documentation Updates and Minor Refactoring

- Updated README and Release Notes
- Updated PayPal Constant to reflect latest release
This commit is contained in:
japatel
2015-01-08 22:26:26 -06:00
parent 0b43d599c4
commit 88aac05f04
5 changed files with 81 additions and 19 deletions

View File

@@ -11,6 +11,33 @@ This repository contains PayPal's PHP SDK and samples for REST API.
- PHP 5.3 or above
- [curl](http://php.net/manual/en/book.curl.php), [json](http://php.net/manual/en/book.json.php) & [openssl](http://php.net/manual/en/book.openssl.php) extensions must be enabled
## Breaking Changes to 1.* Release
* Removed Deprecated Getter Setters from all Model Classes
* All Camelcase getters and setters are removed. Please use first letter uppercase syntax
* E.g. instead of using get_notify_url(), use getNotifyUrl() instead
* Renamed Classes
* PayPal\Common\PPModel => PayPal\Common\PayPalModel
* PayPal\Common\ResourceModel => PayPal\Common\PayPalResourceModel
* PayPal\Common\PPUserAgent => PayPal\Common\PayPalUserAgent
* PayPal\Core\PPConfigManager => PayPal\Core\PayPalConfigManager
* PayPal\Core\PPConstants => PayPal\Core\PayPalConstants
* PayPal\Core\PPCredentialManager => PayPal\Core\PayPalCredentialManager
* PayPal\Core\PPHttpConfig => PayPal\Core\PayPalHttpConfig
* PayPal\Core\PPHttpConnection => PayPal\Core\PayPalHttpConnection
* PayPal\Core\PPLoggingLevel => PayPal\Core\PayPalLoggingLevel
* PayPal\Core\PPLoggingManager => PayPal\Core\PayPalLoggingManager
* PayPal\Exception\PPConfigurationException => PayPal\Exception\PayPalConfigurationException
* PayPal\Exception\PPConnectionException => PayPal\Exception\PayPalConnectionException
* PayPal\Exception\PPInvalidCredentialException => PayPal\Exception\PayPalInvalidCredentialException
* PayPal\Exception\PPMissingCredentialException => PayPal\Exception\PayPalMissingCredentialException
* PayPal\Handler\IPPHandler => PayPal\Handler\IPayPalHandler
* PayPal\Transport\PPRestCall => PayPal\Transport\PayPalRestCall
* Namespace Changes and Class Naming Convention
* PayPal\Common\FormatConverter => PayPal\Converter\FormatConverter
* PayPal\Rest\RestHandler => PayPal\Handler\RestHandler
* PayPal\Rest\OauthHandler => PayPal\Handler\OauthHandler
## Installation
### - Using Composer

View File

@@ -14,6 +14,24 @@ class PayPalModel
private $_propMap = array();
/**
* OAuth Credentials to use for this call
*
* @var \PayPal\Auth\OAuthTokenCredential $credential
*/
protected static $credential;
/**
* Sets Credential
*
* @deprecated Pass ApiContext to create/get methods instead
* @param \PayPal\Auth\OAuthTokenCredential $credential
*/
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* Default Constructor
*

View File

@@ -17,24 +17,6 @@ use PayPal\Transport\PayPalRestCall;
class PayPalResourceModel extends PayPalModel implements IResource
{
/**
* OAuth Credentials to use for this call
*
* @var \PayPal\Auth\OAuthTokenCredential $credential
*/
protected static $credential;
/**
* Sets Credential
*
* @deprecated Pass ApiContext to create/get methods instead
* @param \PayPal\Auth\OAuthTokenCredential $credential
*/
public static function setCredential($credential)
{
self::$credential = $credential;
}
/**
* Sets Links
*

View File

@@ -12,7 +12,7 @@ class PayPalConstants
{
const SDK_NAME = 'PayPal-PHP-SDK';
const SDK_VERSION = '1.0.0-beta';
const SDK_VERSION = '1.0.0';
/**
* Approval URL for Payment

View File

@@ -1,5 +1,40 @@
PayPal PHP SDK release notes
============================
v1.0.0
----
* Enabled Payouts API Support
* Authorization Cache Custom Path Directory Configuration
* Helper Functions to retrieve specific HATEOS Links
* Default Mode set to Sandbox
* Enabled Rest SDK to work nicely with Classic SDKs.
* If missing annotation of return type in Getters, it throws a proper exception
> ## Breaking Changes
* Removed Deprecated Getter Setters from all Model Classes
* All Camelcase getters and setters are removed. Please use first letter uppercase syntax
* E.g. instead of using get_notify_url(), use getNotifyUrl() instead
* Renamed Classes
* PayPal\Common\PPModel => PayPal\Common\PayPalModel
* PayPal\Common\ResourceModel => PayPal\Common\PayPalResourceModel
* PayPal\Common\PPUserAgent => PayPal\Common\PayPalUserAgent
* PayPal\Core\PPConfigManager => PayPal\Core\PayPalConfigManager
* PayPal\Core\PPConstants => PayPal\Core\PayPalConstants
* PayPal\Core\PPCredentialManager => PayPal\Core\PayPalCredentialManager
* PayPal\Core\PPHttpConfig => PayPal\Core\PayPalHttpConfig
* PayPal\Core\PPHttpConnection => PayPal\Core\PayPalHttpConnection
* PayPal\Core\PPLoggingLevel => PayPal\Core\PayPalLoggingLevel
* PayPal\Core\PPLoggingManager => PayPal\Core\PayPalLoggingManager
* PayPal\Exception\PPConfigurationException => PayPal\Exception\PayPalConfigurationException
* PayPal\Exception\PPConnectionException => PayPal\Exception\PayPalConnectionException
* PayPal\Exception\PPInvalidCredentialException => PayPal\Exception\PayPalInvalidCredentialException
* PayPal\Exception\PPMissingCredentialException => PayPal\Exception\PayPalMissingCredentialException
* PayPal\Handler\IPPHandler => PayPal\Handler\IPayPalHandler
* PayPal\Transport\PPRestCall => PayPal\Transport\PayPalRestCall
* Namespace Changes and Class Naming Convention
* PayPal\Common\FormatConverter => PayPal\Converter\FormatConverter
* PayPal\Rest\RestHandler => PayPal\Handler\RestHandler
* PayPal\Rest\OauthHandler => PayPal\Handler\OauthHandler
v1.0.0-beta
----
* Namespace Changes and Class Naming Convention