Download the PHP package josantonius/hook without Composer
On this page you can find all versions of the php package josantonius/hook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download josantonius/hook
More information about josantonius/hook
Files in josantonius/hook
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 hook
PHP Hook library
Translations: Español
Library for handling hooks in PHP.
- Requirements
- Installation
- Available Classes
- Action Instance
- Hook Class
- Priority Class
- Exceptions Used
- Usage
- Tests
- TODO
- Changelog
- Contribution
- Sponsor
- License
Requirements
-
Operating System: Linux | Windows.
- PHP versions: 8.1 | 8.2.
Installation
The preferred way to install this extension is through Composer.
To install PHP Hook library, simply:
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
You can also clone the complete repository with Git:
Available Classes
Action Instance
Josantonius\Hook\Action
Gets action priority:
Gets action callback result:
Checks if the action is done once:
Checks if the action has already been done:
Hook Class
Josantonius\Hook\Hook
Register new hook:
Adds action on the hook:
Adds action once on the hook:
Runs the added actions for the hook:
Checks if the hook has actions:
Checks if the hook has undone actions:
Checks if the actions were done at least once:
Gets hook name:
Priority Class
Josantonius\Hook\Priority
Available constants:
Exceptions Used
Usage
Example of use for this library:
Register new hook
Adds actions on the hook
Add actions with custom priority in the hook
Adds actions once on the hook
Adds actions once with custom priority in the hook
Do actions with the same priority
Do actions with different priority
Do actions with arguments
Do actions recurrently
Do actions only once
Checks if the hook has actions
Checks if the hook has undone actions
Checks if the actions were done at least once
Gets hook name
Gets action priority
Gets action callback result
Checks if the action is done once
Checks if the action has already been done
Tests
To run composer and to execute the following:
Run unit tests with PHPUnit:
Run code standard tests with PHPCS:
Run PHP Mess Detector tests to detect inconsistencies in code style:
Run all previous tests:
TODO
- [ ] Add new feature
- [ ] Improve tests
- [ ] Improve documentation
- [ ] Improve English translation in the README file
- [ ] Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)
- [ ] Make Action->runCallback() accessible only to the Hook class
- [ ] Add method to remove action?
- [ ] Add option to add ID in actions?
Changelog
Detailed changes for each release are documented in the release notes.
Contribution
Please make sure to read the Contributing Guide, before making a pull request, start a discussion or report a issue.
Thanks to all contributors! :heart:
Sponsor
If this project helps you to reduce your development time, you can sponsor me to support my open source work :blush:
License
This repository is licensed under the MIT License.
Copyright © 2017-present, Josantonius
