Download the PHP package cabag/ext-backend-progress without Composer
On this page you can find all versions of the php package cabag/ext-backend-progress. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ext-backend-progress
Backend Progress
About
This extension is based on cabag's boiler_plate extension.
The goal of this extension is to provide a progress bar to the TYPO3 backend accessible as a toolbar item, so switching from a module to another still allows to keep track of a long running task.
The extension implementing this feature have two ways of displaying the progres:
- As a progress circle, containing the progress percentage as a number in the middle
- As a progress bar with an additional progress label, allowing to give additional information on a long running task which overall amount of subtasks may not be known in advance, in this case the progress bar might be used to display the progress over all tasks.
Such long running tasks have to be implemented as tasks for now but could be implemented as Websocket calls in the future.
For developers
To ease the implementation effort, a BackendProgressAwareTrait is provided by the extension.
Initialising
See examples/Command/ExampleProgressBarCommand.php for a full example
See examples/Command for the source.
Do not forget to delete all files and folders, you do not need.
Static analysis
The Boilerplate Extension features several static code analysis tools. Currently they are:
- PHPStan (https://github.com/phpstan/phpstan)
- phpcs (https://github.com/squizlabs/PHP_CodeSniffer)
- Gitlab SAST (https://docs.gitlab.com/ee/user/application_security/sast/)
All of them are configured to run out of the box either in your local environment or in Gitlabs CI.
If you just clone the boilerplate, all tools are enabled by default.
If you want to disable them in gitlab, remove the following lines (starting with - composer from gitlab-ci.yml according to the tests, you want to remove:
Example: if you want to remove phpcs from analysis in the deployment, remove the line - composer phpcs
If you want to remove Gitlab SAST, remove the include - template: Security/SAST.gitlab-ci.yml (not recommended)
How to use the static analysis features in your own extension?
PHPStan
-
[ ] Add the following your .editorconfig file (if it does not exist already):
- [ ] Copy the file phpstan.neon.dist to your extension
- [ ] Copy the gitlab-ci.yml file (or only the required parts) if you want to integrate static analysis into the CI. If you want static analysis only on your local system, skip this step.
- [ ] Make sure to delete the scripts from gitlab-ci, you do not want to fire during your deployment
-
[ ] Add the following your .gitignore file (if it does not exist already):
- [ ] Add the following two sections to your composer.json file (if they do not exist already). If the sections exist, only add their contents:
If the core is already required in the require {} section, remove it from require-dev.
To find out, which other core packages are required, scan the use statements in your classes to get an idea of the required packages from the core.
- [ ] You might have to add more typo3/cms-* dependencies to require-dev if you use Core Classes in your ext (which you should!)
- [ ] Do a
composer update - [ ] After update is finished, you can run
composer phpstanto check for errors in your extension. - [ ] Pro-Tip: Do it on your local System before you push.
phpcs
-
[ ] Add the following your .editorconfig file (if it does not exist already):
- [ ] Copy the file phpcs.xml.dist to your extension
- [ ] Copy the gitlab-ci.yml file (or only the required parts) if you want to integrate static analysis into the CI. If you want static analysis only on your local system, skip this step.
- [ ] Make sure to delete the scripts from gitlab-ci, you do not want to fire during your deployment
-
[ ] Add the following your .gitignore file (if it does not exist already):
-
[ ] Add the following two sections to your composer.json file (if they do not exist already). If the sections exist, only add their contents:
- [ ] You might have to add more typo3/cms-* dependencies to require-dev if you use Core Classes in your ext (which you should!)
- [ ] Do a
composer update - [ ] After update is finished, you can run
composer phpcsto check for errors in your extension. If phpcs finds errors, it might be able to fix some of them. If it suggests fixing errors, runvendor/bin/phpcbf - [ ] Pro-Tip: Do it on your local System before you push.
All versions of ext-backend-progress with dependencies
typo3/cms-core Version ^9.5
typo3/cms-backend Version ^9.5
typo3/cms-extbase Version ^9.5