rabe/helpers-cli-input
11
0
Fork 0
mirror of https://github.com/n3w/helpers-cli-input.git synced 2025-12-19 12:43:23 +00:00
Code Issues Projects Releases Wiki Activity

Updated README, CHANGELOG, and composer.json for 1.2.0 release

Browse source
This commit is contained in:
Alannah Kearney 2019-06-01 22:57:42 +10:00
commit 46b87d3d62
3 changed files with 37 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

34
CHANGELOG.md
View file

@ -3,7 +3,27 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
**View all [Unreleased][] changes here**
## [1.2.0][]
#### Added
- Added `InputTypeFilterIterator` class
- Added `UnrecognisedInputException` exception
#### Changed
- `InputCollection` now implements `Iterator` and `Countable` (implementing required methods)
- Removed use of `$type` in `InputCollection`
- Added `InputCollection::getItemsExcludeByType()`
- `InputCollection::getItemsByType()` and `InputCollection::getItems()` now returns an `Iterator`
- Renamed `InputCollection::append()` to `add()` and added `$position` flag
- Added `POSITION_APPEND` and `POSITION_PREPEND` flags to `InputCollection`
- Made `getCollection()`, `getInput()`, `find()`, and `validate()` in `AbstractInputHandler` final
- Removed all categorisation of items by type in `AbstractInputHandler::$input`
- Abstracted most of `AbstractInputHandler::validate()` into it's own protected method called `validateInput()`
- Removed `$skipValidation` argument from `AbstractInputHandler::bind()` and relaced with `$flags`
- Added `FLAG_BIND_SKIP_VALIDATION`, `FLAG_VALIDATION_SKIP_REQUIRED`, `FLAG_VALIDATION_SKIP_CUSTOM`, and `FLAG_VALIDATION_SKIP_UNRECOGNISED` flags to `AbstractInputHandler`
- Added check in `AbstractInputHandler::validate()` to look for unrecognised options and arguments
- Removed `InputHandlerFactory::FLAG_SKIP_VALIDATION` from `InputHandlerFactory`
- Passing flags in call from `InputHandlerFactory::build()` to `AbstractInputHandler::bind()`
- Updated `InputHandlerInterface::bind()` and `validate()` methods to support flags
## [1.1.4][]
#### Fixed
@ -11,7 +31,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [1.1.3][]
#### Fixed
- Fixed logic bug that prevented `$index` and `$type` from being set in `InputCollection::append()`. This means replaceing items in an `InputCollection` now works as expected.
- Fixed logic bug that prevented `$index` and `$type` from being set in `InputCollection::append()`. This means replaceing items in an `InputCollection` now works as expected
## [1.1.2][]
#### Added
@ -19,22 +39,22 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- Added `InputTypeInterface::getDisplayName()` method to standardise how the name of an `InputTypeInterface` class wants to display it's name
#### Changed
- Updated validation logic for inputs that have a validator, no default, and are not set.
- Updated validation logic for inputs that have a validator, no default, and are not set
- Throwing `InputValidationFailedException` exception when validation fails
- Updated `RequiredInputMissingException` and `RequiredInputMissingValueException` exceptions to use `InputTypeInterface::getDisplayName()` when producing their message
- Removed unused `RequiredArgumentMissingException` exception
## [1.1.1][]
#### Changed
- `AbstractInputHandler::find()` returns NULL if it cannot find any input with the supplied name. It is easier to test for NULL than it is to catch an exception.
- `AbstractInputHandler::find()` returns NULL if it cannot find any input with the supplied name. It is easier to test for NULL than it is to catch an exception
## [1.1.0][]
#### Added
- Expanded input types to include `Flag`, `IncrementingFlag`, and `LongOption`.
- Expanded input types to include `Flag`, `IncrementingFlag`, and `LongOption`
- Added `InputTypeFactory` to help with loading input type classes
#### Changed
- Updated to work with more than just `Argument` and `Option` input types. Makes use of `InputTypeFactory` to allow addition of new types as needed.
- Updated to work with more than just `Argument` and `Option` input types. Makes use of `InputTypeFactory` to allow addition of new types as needed
## [1.0.2][]
#### Changed
@ -53,7 +73,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
#### Added
- Initial release
[Unreleased]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.4...integration
[1.2.0]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.4...1.2.0
[1.1.4]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.3...1.1.4
[1.1.3]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.2...1.1.3
[1.1.2]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.1...1.1.2