Download the PHP package d8-contrib-modules/cloudflarephpsdk without Composer
On this page you can find all versions of the php package d8-contrib-modules/cloudflarephpsdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download d8-contrib-modules/cloudflarephpsdk
More information about d8-contrib-modules/cloudflarephpsdk
Files in d8-contrib-modules/cloudflarephpsdk
Package cloudflarephpsdk
Short Description PHP client for interacting with CloudFlare's SDK. CloudFlare is a copyright of CloudFlare, Inc. The authors of this tool has no association with CloudFlare, Inc.
License GPL-2.0+
Homepage https://github.com/d8-contrib-modules/cloudflarephpsdk
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cloudflarephpsdk
Introduction
Provides a PHP client to interact with Cloudflare API see: https://api.cloudflare.com/ The SDK is designed to allow developers to work with CloudFlare without having to know all the low-level details of interacting with the API.
The API has been designed with ease of use in mind.
Note: CloudFlare is a trademark of CloudFlare Inc. This project is maintained independently of CloudFlare inc.
Usage
See below for some common uses of the API:
Structure
ApiTypes
Parses incoming data from the API into typed data structures. Creating typed classes for the incoming data makes working with the API a lot simpler for Devs. It takes away the guess work for what's in an array.
ApiEndPoints
Provides facilities to interact with the remote api. Each API endpoint extends CloudFlareAPI. A new endpoint based off CloudFlareAPI gets a lot of the structural work necessary to make requests.
Exceptions
The SDK relies on an exception model for error handling. When an unexpected result occurs an exception is thrown. When developing with the SDK you will need to provide try-catch blocks to handle at the applicaiton level. Different exceptions are thrown based on the area of the SDK where the exception occurs.
CloudFlareAPI.php
Provides facility for making webservice calls to cloudflare. It provides a wrapper around guzzle so that people using this module do not need to concern themselves with the low-level implementation details of guzzle.
Contribution Guidelines for Developers
User proper namespacing
All code in this SDK is name-spaced inside CloudFlarePhpSdk using PSR-4 autoloading.
Coding Standards
Contributed code must pass code sniffer.
Type Hinting
Typehint all variables and parameters. It makes life a LOT simpler for developers working with IDEs.
Unit Testing
The SDK has a goal of 100% PHPUnit test coverage. It normally hovers around 80% coverage. When submitting code please ensure that the change is either covered by existing tests OR provide new test!
Travis CI
The repo is configured to work with Travis CI. All pull requests are automatically enqueued for automated testing. PRs must pass automated testing before being considered for integration.
