diff --git a/.gitattributes b/.gitattributes index 6669e716..16d8d293 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,10 +1,10 @@ -/docs export-ignore -/test export-ignore /.coveralls.yml export-ignore /.gitattributes export-ignore /.gitignore export-ignore /.travis.yml export-ignore /composer.lock export-ignore +/docs/ export-ignore /mkdocs.yml export-ignore /phpcs.xml export-ignore /phpunit.xml.dist export-ignore +/test/ export-ignore diff --git a/.gitignore b/.gitignore index 9e685001..245087af 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ -docs/html/ -vendor/ -zf-mkdoc-theme/ -clover.xml -coveralls-upload.json -phpunit.xml -zf-mkdoc-theme.tgz +/clover.xml +/coveralls-upload.json +/docs/html/ +/phpunit.xml +/vendor/ +/zf-mkdoc-theme.tgz +/zf-mkdoc-theme/ diff --git a/LICENSE.md b/LICENSE.md index 986c6190..90504846 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,5 +1,4 @@ -Copyright (c) 2015-2017, Zend Technologies USA, Inc. - +Copyright (c) 2015-2019, Zend Technologies USA, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, diff --git a/README.md b/README.md index b7cffad9..41e3e4d5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ # zend-inputfilter [![Build Status](https://secure.travis-ci.org/zendframework/zend-inputfilter.svg?branch=master)](https://secure.travis-ci.org/zendframework/zend-inputfilter) -[![Coverage Status](https://coveralls.io/repos/zendframework/zend-inputfilter/badge.svg?branch=master)](https://coveralls.io/r/zendframework/zend-inputfilter?branch=master) +[![Coverage Status](https://coveralls.io/repos/github/zendframework/zend-inputfilter/badge.svg?branch=master)](https://coveralls.io/github/zendframework/zend-inputfilter?branch=master) The zend-inputfilter component can be used to filter and validate generic sets of input data. For instance, you could use it to filter `$_GET` or `$_POST` values, CLI arguments, etc. -- File issues at https://github.com/zendframework/zend-inputfilter/issues -- Documentation is at https://docs.zendframework.com/zend-inputfilter/ +## Installation + +Run the following to install this library: + +```bash +$ composer require zendframework/zend-inputfilter +``` + +## Documentation + +Browse the documentation online at https://docs.zendframework.com/zend-inputfilter/ + +## Support + +* [Issues](https://github.com/zendframework/zend-inputfilter/issues/) +* [Chat](https://zendframework-slack.herokuapp.com/) +* [Forum](https://discourse.zendframework.com/) diff --git a/composer.json b/composer.json index d4825e7d..62e8e27b 100644 --- a/composer.json +++ b/composer.json @@ -7,26 +7,13 @@ "zendframework", "inputfilter" ], - "config": { - "sort-packages": true - }, - "extra": { - "branch-alias": { - "dev-master": "2.10.x-dev", - "dev-develop": "2.11.x-dev" - }, - "zf": { - "component": "Zend\\InputFilter", - "config-provider": "Zend\\InputFilter\\ConfigProvider" - } - }, "support": { "docs": "https://docs.zendframework.com/zend-inputfilter/", "issues": "https://github.com/zendframework/zend-inputfilter/issues", "source": "https://github.com/zendframework/zend-inputfilter", "rss": "https://github.com/zendframework/zend-inputfilter/releases.atom", - "slack": "https://zendframework-slack.herokuapp.com", - "forum": "https://discourse.zendframework.com/c/questions/expressive" + "chat": "https://zendframework-slack.herokuapp.com", + "forum": "https://discourse.zendframework.com/c/questions/components" }, "require": { "php": "^5.6 || ^7.0", @@ -53,6 +40,19 @@ "ZendTest\\InputFilter\\": "test/" } }, + "config": { + "sort-packages": true + }, + "extra": { + "branch-alias": { + "dev-master": "2.10.x-dev", + "dev-develop": "2.11.x-dev" + }, + "zf": { + "component": "Zend\\InputFilter", + "config-provider": "Zend\\InputFilter\\ConfigProvider" + } + }, "scripts": { "check": [ "@cs-check", diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 18f41249..b7c261b7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -7,7 +7,7 @@ read/subscribe to the following resources: - [Coding Standards](https://github.com/zendframework/zend-coding-standard) - [Forums](https://discourse.zendframework.com/c/contributors) - - [Slack](https://zendframework-slack.herokuapp.com) + - [Chat](https://zendframework-slack.herokuapp.com) - [Code of Conduct](CODE_OF_CONDUCT.md) If you are working on new features or refactoring diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md index 6d3255a7..c13185cd 100644 --- a/docs/ISSUE_TEMPLATE.md +++ b/docs/ISSUE_TEMPLATE.md @@ -1,11 +1,19 @@ -Provide a narrative description of the issue. + - [ ] I was not able to find an [open](https://github.com/zendframework/zend-inputfilter/issues?q=is%3Aopen) or [closed](https://github.com/zendframework/zend-inputfilter/issues?q=is%3Aclosed) issue matching what I'm seeing. + - [ ] This is not a question. (Questions should be asked on [chat](https://zendframework.slack.com/) ([Signup here](https://zendframework-slack.herokuapp.com/)) or our [forums](https://discourse.zendframework.com/).) + +Provide a narrative description of what you are trying to accomplish. ### Code to reproduce the issue + + ```php ``` ### Expected results + + ### Actual results + diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md index 3ad62523..f00d90c0 100644 --- a/docs/PULL_REQUEST_TEMPLATE.md +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -18,8 +18,8 @@ Provide a narrative description of what you are trying to accomplish: - [ ] Add a `CHANGELOG.md` entry for the new feature. - [ ] Is this related to quality assurance? - - [ ] Detail why the changes are necessary. + - [ ] Is this related to documentation? - - [ ] Is it a typographical and/or grammatical fix? - - [ ] Is it new documentation? + + diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md index c6be82be..2aeaf7e7 100644 --- a/docs/SUPPORT.md +++ b/docs/SUPPORT.md @@ -3,13 +3,13 @@ Zend Framework offers three support channels: - For real-time questions, use our - [Slack](https://zendframework-slack.herokuapp.com) + [chat](https://zendframework-slack.herokuapp.com) - For detailed questions (e.g., those requiring examples) use our [forums](https://discourse.zendframework.com/c/questions/components) - To report issues, use this repository's [issue tracker](https://github.com/zendframework/zend-inputfilter/issues/new) -**DO NOT** use the issue tracker to ask questions; use Slack or the forums for +**DO NOT** use the issue tracker to ask questions; use chat or the forums for that. Questions posed to the issue tracker will be closed. When reporting an issue, please include the following details: diff --git a/docs/book/optional-input-filters.md b/docs/book/optional-input-filters.md index 0ea23c54..1c06d379 100644 --- a/docs/book/optional-input-filters.md +++ b/docs/book/optional-input-filters.md @@ -7,7 +7,7 @@ a subset of another input filter (e.g., to validate a subset of a larger set of data), and no data is provided for that item, or an empty set of data is provided, then the input filter will consider the data invalid. -If you want to allow a set of data to be empty, you can use +If you want to allow a set of data to be empty, you can use `Zend\InputFilter\OptionalInputFilter`. To illustrate this, let's consider a form where a user provides profile