This repository was archived by the owner on Jan 30, 2020. It is now read-only.
Deprecate Transfer and prepare documentation #25
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Converted from bookdown to mkdocs - Filled in documentation for the ClassFileLocator - Added an intro, which points to the ZF1 `Zend_File_Transfer` documentation for those interested in the `Transfer` subcomponent, as well as notes the ZF2 components that provide alternatives.
weierophinney
added a commit
that referenced
this pull request
Apr 28, 2016
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR intentionally mixes concerns.
In preparing the documentation, I realized that the
Transfersubcomponent documentation was utterly missing. In looking through the functionality, I discovered that it has been marked as "to refactor" for the entire ZF2 lifetime. Furthermore, everything it does is now split into multiple other components: zend-filter, for moving uploaded files to their final location, renaming them, and potentially transforming them; zend-validator, for validating upload succes, file type, hash, etc.; and zend-progressbar, for managing upload status. As such, those "to refactor" items really needed to become "to deprecate". This patch formally deprecates the full subcomponent.Next, the patch provides documentation of the
ClassFileLocator, fixing #24, and prepares the documentation for publication, and publishes it to https://zendframework.github.io/zend-file/