Skip to content

Commit e571eed

Browse files
authored
Merge pull request #284 from cloudflare/docs/readme-and-changelog
docs: update README and add CHANGELOG for 2.0.0
2 parents 9d09daf + 2c15d68 commit e571eed

2 files changed

Lines changed: 42 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
## 2.0.0
4+
5+
### Breaking Changes
6+
7+
- **Minimum PHP version raised from 7.2.5 to 8.1.** PHP 7.x and 8.0 are no
8+
longer supported. All of these versions are past end-of-life upstream.
9+
10+
### Changes
11+
12+
- Add support for `psr/http-message` v2.0 (constraint is now `^1.1 || ^2.0`).
13+
This resolves dependency conflicts with libraries that require PSR-7 v2,
14+
including `league/oauth2-server` and newer Drupal modules.
15+
([#275](https://github.com/cloudflare/cloudflare-php/pull/275))
16+
- Fix PHP 8.4 implicit-nullable deprecation warnings in `Guzzle::__construct()`
17+
and `Zones::cachePurge()`.
18+
([#280](https://github.com/cloudflare/cloudflare-php/pull/280))
19+
- Upgrade `guzzlehttp/guzzle` constraint from `^7.0.1` to `^7.4`.
20+
- Upgrade `phpunit/phpunit` from `^5.7` to `^9.6 || ^10.0 || ^11.0`.
21+
- Upgrade `friendsofphp/php-cs-fixer` from `^2.6` to `^3.0`.
22+
- Remove committed `composer.lock` (correct practice for libraries).
23+
- Update GitHub Actions workflows: `actions/checkout` v4, `actions/cache` v4,
24+
`php-actions/composer` v6, Semgrep runner to `ubuntu-latest`.
25+
- Fix PHP test matrix to 8.1, 8.2, 8.3, 8.4.
26+
- Migrate linter config from `.php_cs` to `.php-cs-fixer.php`.
27+
- Add PHPMD ruleset file (`phpmd.xml`).
28+
- Remove unused test variables in `DNSAnalyticsTest`.
29+
- Update README to reflect PHP 8.1+ requirement and current project status.

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
1-
# Cloudflare SDK (v4 API Binding for PHP 7)
1+
# Cloudflare SDK (v4 API Binding for PHP)
22

3-
[![Build Status](https://travis-ci.org/cloudflare/cloudflare-php.svg?branch=master)](https://travis-ci.org/cloudflare/cloudflare-php)
3+
> **Note:** This is a community-maintained PHP SDK covering a subset of the
4+
> Cloudflare API. A comprehensive, auto-generated PHP SDK is planned for the
5+
> future. In the meantime, for full API coverage consider using the
6+
> [Cloudflare API](https://developers.cloudflare.com/api/) directly.
7+
8+
## Requirements
9+
10+
- PHP 8.1 or later
411

512
## Installation
613

7-
The recommended way to install this package is via the Packagist Dependency Manager ([cloudflare/sdk](https://packagist.org/packages/cloudflare/sdk)).
14+
Install via Composer ([cloudflare/sdk](https://packagist.org/packages/cloudflare/sdk)):
815

916
```
1017
composer require cloudflare/sdk
1118
```
1219

13-
You can get specific usage examples on the Cloudflare Knowledge Base under: [Cloudflare PHP API Binding](https://support.cloudflare.com/hc/en-us/articles/115001661191)
14-
1520
## Cloudflare API version 4
1621

17-
The Cloudflare API can be found [here](https://api.cloudflare.com/).
22+
The Cloudflare API can be found [here](https://developers.cloudflare.com/api/).
1823
Each API call is provided via a similarly named function within various classes in the **Cloudflare\API\Endpoints** namespace:
1924

2025
- [x] [DNS Records](https://www.cloudflare.com/dns/)
21-
- [x] [DNS Analytics](https://api.cloudflare.com/#dns-analytics-table)
26+
- [x] DNS Analytics
2227
- [x] Zones
2328
- [x] User Administration (partial)
2429
- [x] [Cloudflare IPs](https://www.cloudflare.com/ips/)
25-
- [x] [Page Rules](https://support.cloudflare.com/hc/en-us/articles/200168306-Is-there-a-tutorial-for-Page-Rules-)
30+
- [x] Page Rules
2631
- [x] [Web Application Firewall (WAF)](https://www.cloudflare.com/waf/)
2732
- [ ] Virtual DNS Management
2833
- [x] Custom hostnames
@@ -36,8 +41,6 @@ Each API call is provided via a similarly named function within various classes
3641
- [x] Load Balancers
3742
- [x] Firewall Settings
3843

39-
Note that this repository is currently under development, additional classes and endpoints being actively added.
40-
4144
## Getting Started
4245

4346
```php

0 commit comments

Comments
 (0)