Download the PHP package clarkwinkelmann/flarum-ext-gate-logger without Composer
On this page you can find all versions of the php package clarkwinkelmann/flarum-ext-gate-logger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download clarkwinkelmann/flarum-ext-gate-logger
More information about clarkwinkelmann/flarum-ext-gate-logger
Files in clarkwinkelmann/flarum-ext-gate-logger
Package flarum-ext-gate-logger
Short Description Log all gate queries for debug purpose
License MIT
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 flarum-ext-gate-logger
Gate Logger (for developers)
This extension logs information about all calls to Flarum's Gate to the default Flarum logger with debug priority.
This means all calls to User::can(), User::cannot(), User::assertCan(), etc. But not User::hasPermission().
This creates a lot of logs, so it's probably best to only enable the extension right when you want to debug something.
There is no user-facing interface. It only logs to a file (in storage/logs with default logger).
Performance impact will largely be related to how fast the logger can write to disk. If you are using a custom log driver that doesn't write to disk, performance impact might be negligible, as the logic is otherwise identical to native Flarum.
Caveats (not permanent, only when the extension is enabled):
- The extension completely replaces Flarum's Gate class with a custom one, so as new Flarum updates get released, this extension might cause Flarum to behave differently than a standard installation, or could be missing important security fixes!
- If an extension overrides
AbstractPolicy::checkAbility()in its policy class, the method will never be called!
Log format
The first line of the log should be prefixed by the time and debug level automatically (this is added by the logger library).
The first line will then show the gate ability name, followed by information about the actor (username or [Guest]) and the gate parameter (model class and ID or [GLOBAL] for global policies)
The next lines will show every policy class and method that are resolved for those parameters.
After each policy the output will be shown (ALLOW, FORCE_ALLOW, DENY, FORCE_DENY, [TRUE], [FALSE] or [NULL])
When a method exists on the policy with the ability name and returns non-null, the can method on the policy will be skipped.
In this case the output will be shown as SKIPPED.
The final line will show the computed decision and which method lead to that decision.
It will be one of (Criteria Priority: <which criteria stopped was matched first>) if any of the policy classes returned non-null, (Admin role) if the user is admin, (Has permission: key) if the ability name defaulted to a permission key, or (Default) if nothing was matched.
If some gate calls are nested, they will appear as separate entries in the order in which the Gate return statements were reached.
Some examples of the logs that will be created:
Installation
composer require clarkwinkelmann/flarum-ext-gate-loggerSupport
This extension is under minimal maintenance.
It was developed for a client and released as open-source for the benefit of the community. I might publish simple bugfixes or compatibility updates for free.
You can contact me to sponsor additional features or updates.
Support is offered on a "best effort" basis through the Flarum community thread.
