From cdc520aed1bb961aa27f0921799d106cff0648f0 Mon Sep 17 00:00:00 2001 From: George Steel Date: Fri, 15 Mar 2024 14:53:17 +0000 Subject: [PATCH] Fix linting issues in docs Signed-off-by: George Steel --- docs/book/v2/migration.md | 16 ++++++++-------- docs/book/v2/server-request-filters.md | 14 +++++++------- docs/book/v3/server-request-filters.md | 14 +++++++------- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/book/v2/migration.md b/docs/book/v2/migration.md index 7cf5701b..a614fe96 100644 --- a/docs/book/v2/migration.md +++ b/docs/book/v2/migration.md @@ -13,17 +13,17 @@ options for doing so: - Update your constraint to allow either version: - - Edit the constraint in your `composer.json` to read: + - Edit the constraint in your `composer.json` to read: - ```json - "laminas/laminas-diactoros": "^1.8.6 || ^2.0" - ``` + ```json + "laminas/laminas-diactoros": "^1.8.6 || ^2.0" + ``` - - Update your dependencies: + - Update your dependencies: - ```bash - $ composer update - ``` + ```bash + $ composer update + ``` The first approach may fail if libraries you depend on specifically require a version 1 release. The second approach may leave you on a version 1 release in diff --git a/docs/book/v2/server-request-filters.md b/docs/book/v2/server-request-filters.md index 71d6a080..db967704 100644 --- a/docs/book/v2/server-request-filters.md +++ b/docs/book/v2/server-request-filters.md @@ -55,13 +55,13 @@ These named constructors are: It is functionally equivalent to `FilterUsingXForwardedHeaders::trustProxies(['*'])`. - `FilterUsingXForwardedHeaders::trustReservedSubnets(): void`: when this method is called, the filter will trust requests made from reserved, private subnets. It is functionally equivalent to `FilterUsingXForwardedHeaders::trustProxies()` with the following elements in the `$proxyCIDRList`: - - 10.0.0.0/8 - - 127.0.0.0/8 - - 172.16.0.0/12 - - 192.168.0.0/16 - - ::1/128 (IPv6 localhost) - - fc00::/7 (IPv6 private networks) - - fe80::/10 (IPv6 local-link addresses) + - 10.0.0.0/8 + - 127.0.0.0/8 + - 172.16.0.0/12 + - 192.168.0.0/16 + - ::1/128 (IPv6 localhost) + - fc00::/7 (IPv6 private networks) + - fe80::/10 (IPv6 local-link addresses) Internally, the filter checks the `REMOTE_ADDR` server parameter (as retrieved from `getServerParams()`) and compares it against each proxy listed; the first to match indicates trust. diff --git a/docs/book/v3/server-request-filters.md b/docs/book/v3/server-request-filters.md index 71d6a080..db967704 100644 --- a/docs/book/v3/server-request-filters.md +++ b/docs/book/v3/server-request-filters.md @@ -55,13 +55,13 @@ These named constructors are: It is functionally equivalent to `FilterUsingXForwardedHeaders::trustProxies(['*'])`. - `FilterUsingXForwardedHeaders::trustReservedSubnets(): void`: when this method is called, the filter will trust requests made from reserved, private subnets. It is functionally equivalent to `FilterUsingXForwardedHeaders::trustProxies()` with the following elements in the `$proxyCIDRList`: - - 10.0.0.0/8 - - 127.0.0.0/8 - - 172.16.0.0/12 - - 192.168.0.0/16 - - ::1/128 (IPv6 localhost) - - fc00::/7 (IPv6 private networks) - - fe80::/10 (IPv6 local-link addresses) + - 10.0.0.0/8 + - 127.0.0.0/8 + - 172.16.0.0/12 + - 192.168.0.0/16 + - ::1/128 (IPv6 localhost) + - fc00::/7 (IPv6 private networks) + - fe80::/10 (IPv6 local-link addresses) Internally, the filter checks the `REMOTE_ADDR` server parameter (as retrieved from `getServerParams()`) and compares it against each proxy listed; the first to match indicates trust.