Skip to content

Commit

Permalink
prepare to v3
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarotero committed Nov 29, 2019
1 parent 8f03975 commit 9a3f312
Show file tree
Hide file tree
Showing 11 changed files with 88 additions and 207 deletions.
15 changes: 8 additions & 7 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
* text=auto eol=lf

/tests export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.travis.yml export-ignore
phpunit.xml export-ignore
phpcs.xml export-ignore
/tests export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.php_cs export-ignore
.travis.yml export-ignore
phpcs.xml.dist export-ignore
phpunit.xml.dist export-ignore
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
vendor
composer.lock
.php_cs.cache
coverage
.phpunit.result.cache
*.cache
135 changes: 8 additions & 127 deletions .php_cs
Original file line number Diff line number Diff line change
@@ -1,129 +1,10 @@
<?php

$finder = PhpCsFixer\Finder::create()
->files()
->name('*.php')
->in(__DIR__ . '/src')
->in(__DIR__ . '/tests')
;

return PhpCsFixer\Config::create()
->setRules(array(
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
'binary_operator_spaces' => ['align_double_arrow' => false, 'align_equals' => false],
'blank_line_after_namespace' => true,
'blank_line_after_opening_tag' => false,
'blank_line_before_return' => false,
'braces' => ['allow_single_line_closure' => false],
'cast_spaces' => true,
'class_definition' => ['singleLine' => false, 'singleItemSingleLine' => true, 'multiLineExtendsEachSingleLine' => true],
'class_keyword_remove' => false,
'combine_consecutive_unsets' => true,
'concat_space' => false,
'declare_equal_normalize' => ['space' => 'single'],
'declare_strict_types' => false,
'elseif' => true,
'encoding' => true,
'full_opening_tag' => true,
'function_declaration' => true,
'function_typehint_space' => true,
'general_phpdoc_annotation_remove' => ['expectedExceptionMessageRegExp', 'expectedException', 'expectedExceptionMessage'],
'hash_to_slash_comment' => true,
'header_comment' => false,
'heredoc_to_nowdoc' => true,
'include' => true,
'indentation_type' => true,
'line_ending' => true,
'linebreak_after_opening_tag' => true,
'lowercase_cast' => true,
'lowercase_constants' => true,
'lowercase_keywords' => true,
'mb_str_functions' => false,
'method_argument_space' => true,
'method_separation' => true,
'native_function_casing' => true,
'native_function_invocation' => false,
'new_with_braces' => true,
'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => false,
'no_blank_lines_before_namespace' => false,
'no_closing_tag' => true,
'no_empty_comment' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_extra_consecutive_blank_lines' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => ['use' => 'echo'],
'no_multiline_whitespace_around_double_arrow' => true,
'no_multiline_whitespace_before_semicolons' => true,
'no_short_bool_cast' => true,
'no_short_echo_tag' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_after_function_name' => true,
'no_spaces_around_offset' => true,
'no_spaces_inside_parenthesis' => true,
'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => true,
'no_trailing_whitespace' => true,
'no_trailing_whitespace_in_comment' => true,
'no_unneeded_control_parentheses' => true,
'no_unused_imports' => true,
'no_useless_else' => true,
'no_useless_return' => true,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'normalize_index_brace' => true,
'not_operator_with_space' => false,
'not_operator_with_successor_space' => false,
'object_operator_without_whitespace' => true,
'ordered_class_elements' => false,
'ordered_imports' => true,
'php_unit_fqcn_annotation' => true,
'php_unit_strict' => false,
'phpdoc_add_missing_param_annotation' => true,
'phpdoc_align' => true,
'phpdoc_inline_tag' => true,
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => ['property-read' => 'property', 'property-write' => 'property', 'type' => 'var'],
'phpdoc_no_empty_return' => true,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => true,
'phpdoc_order' => true,
'phpdoc_return_self_reference' => true,
'phpdoc_scalar' => true,
'phpdoc_separation' => false,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => false,
'phpdoc_to_comment' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_var_without_name' => true,
'pow_to_exponentiation' => false,
'pre_increment' => true,
'protected_to_private' => true,
'return_type_declaration' => true,
'semicolon_after_instruction' => true,
'short_scalar_cast' => true,
'single_blank_line_at_eof' => true,
'single_blank_line_before_namespace' => false,
'single_class_element_per_statement' => true,
'single_import_per_statement' => true,
'single_line_after_imports' => true,
'single_quote' => true,
'space_after_semicolon' => true,
'standardize_not_equals' => true,
'strict_param' => false,
'switch_case_semicolon_to_colon' => true,
'switch_case_space' => true,
'ternary_operator_spaces' => true,
'ternary_to_null_coalescing' => false,
'trailing_comma_in_multiline_array' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'visibility_required' => true,
'whitespace_after_comma_in_array' => true,
))
->setFinder($finder)
;
return My\PhpCsFixerConfig::create()
->setFinder(
PhpCsFixer\Finder::create()
->files()
->name('*.php')
->in(__DIR__.'/src')
->in(__DIR__.'/tests')
);
3 changes: 1 addition & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ language: php
sudo: false

php:
- 7.0
- 7.1
- 7.2
- 7.3

before_script:
- composer self-update
Expand Down
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [2.2.0] - Unreleased
## [3.0.0] - 2019-11-29
### Added
- New `XmlPayload` middleware [#9]
- Throw `JsonException` on error (Php ^7.3)

### Removed
- Support for PHP 7.0 and 7.1

## [2.1.1] - 2018-11-08
### Fixed
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018
Copyright (c) 2019

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
89 changes: 38 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
[![Build Status][ico-travis]][link-travis]
[![Quality Score][ico-scrutinizer]][link-scrutinizer]
[![Total Downloads][ico-downloads]][link-downloads]
[![SensioLabs Insight][ico-sensiolabs]][link-sensiolabs]

Parses the body of the request if it's not parsed and the method is POST, PUT or DELETE. It contains the following components to support different formats:

Expand All @@ -18,7 +17,7 @@ Failure to parse the body will result in a `Middlewares\Utils\HttpErrorException

## Requirements

* PHP >= 7.0
* PHP >= 7.2
* A [PSR-7 http library](https://github.com/middlewares/awesome-psr15-middlewares#psr-7-implementations)
* A [PSR-15 middleware dispatcher](https://github.com/middlewares/awesome-psr15-middlewares#dispatcher)

Expand All @@ -35,7 +34,7 @@ composer require middlewares/payload
Parses the JSON payload of the request.

```php
$dispatcher = new Dispatcher([
Dispatcher::run([
(new Middlewares\JsonPayload())
->associative(false)
->depth(64)
Expand All @@ -46,90 +45,68 @@ $response = $dispatcher->dispatch(new ServerRequest());

Contains the following options to configure the [json_decode](http://php.net/manual/en/function.json-decode.php) function:

### `associative`
### associative

Enabled by default, convert the objects into associative arrays.

Type | Required | Description
-----|----------|------------
`bool` | No | `true` (or none) to enable, `false` to disable

### `depth`
```php
//Disable associative arrays
$payload = (new Middlewares\JsonPayload())->associative(false);
```

To configure the recursion depth.
### depth

Type | Required | Description
-----|----------|------------
`int` | Yes | The new value
To configure the recursion depth option of json_decode. By default is `512`.

### `options`
### options

To pass the bitmask of json_decode options: `JSON_BIGINT_AS_STRING` (enabled by default), `JSON_OBJECT_AS_ARRAY`, `JSON_THROW_ON_ERROR`.

Type | Required | Description
-----|----------|------------
`int` | Yes | The new options

### `methods`
### methods

To configure the allowed methods. By default only the requests with the method `POST, PUT, PATCH, DELETE, COPY, LOCK, UNLOCK` are handled.

Type | Required | Description
-----|----------|------------
`string[]` | Yes | Array with the new allowed methods (in uppercase)
```php
//Parse json only with POST and PUT requests
$payload = (new Middlewares\JsonPayload())->methods(['POST', 'PUT']);
```

### `contentType`
### contentType

To configure all Content-Type headers allowed in the request. By default is `application/json`
To configure all `Content-Type` headers allowed in the request. By default is `application/json`

Type | Required | Description
-----|----------|------------
`string[]` | Yes | Array with the new `Content-Type` headers allowed
```php
//Parse json only in request with these two Content-Type values
$payload = (new Middlewares\JsonPayload())->contentType(['application/json', 'text/json']);
```

### `override`
### override

To override the previous parsed body if exists (`false` by default)

Type | Required | Description
-----|----------|------------
`bool` | No | `true` (or none) to override the, `false` to don't

## UrlEncodePayload

Parses the url-encoded payload of the request.

```php
$dispatcher = new Dispatcher([
Dispatcher::run([
new Middlewares\UrlEncodePayload()
]);

$response = $dispatcher->dispatch(new ServerRequest());
```

### `methods`
### methods

To configure the allowed methods. By default only the requests with the method `POST, PUT, PATCH, DELETE, COPY, LOCK, UNLOCK` are handled.

Type | Required | Description
-----|----------|------------
`string[]` | Yes | Array with the new allowed methods (in uppercase)

### `contentType`
### contentType

To configure all Content-Type headers allowed in the request. By default is `application/x-www-form-urlencoded`

Type | Required | Description
-----|----------|------------
`string[]` | Yes | Array with the new `Content-Type` headers allowed

### `override`
### override

To override the previous parsed body if exists (`false` by default)

Type | Required | Description
-----|----------|------------
`bool` | No | `true` (or none) to override the, `false` to don't


## CsvPayload

Expand All @@ -140,6 +117,18 @@ CSV payloads are supported by the [middlewares/csv-payload](https://packagist.or

Parses the XML payload of the request. Parsed body will return an instance of [SimpleXMLElement](https://www.php.net/manual/en/class.simplexmlelement.php).

### methods

To configure the allowed methods. By default only the requests with the method `POST, PUT, PATCH, DELETE, COPY, LOCK, UNLOCK` are handled.

### contentType

To configure all Content-Type headers allowed in the request. By default is `text/xml`, `application/xml` and `application/x-xml`.

### override

To override the previous parsed body if exists (`false` by default)

---

Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
Expand All @@ -151,10 +140,8 @@ The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
[ico-travis]: https://img.shields.io/travis/middlewares/payload/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/g/middlewares/payload.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/middlewares/payload.svg?style=flat-square
[ico-sensiolabs]: https://img.shields.io/sensiolabs/i/7200be66-ac83-455c-bc85-c40eb569b94c.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/middlewares/payload
[link-travis]: https://travis-ci.org/middlewares/payload
[link-scrutinizer]: https://scrutinizer-ci.com/g/middlewares/payload
[link-downloads]: https://packagist.org/packages/middlewares/payload
[link-sensiolabs]: https://insight.sensiolabs.com/projects/7200be66-ac83-455c-bc85-c40eb569b94c
Loading

0 comments on commit 9a3f312

Please sign in to comment.