mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
6bc8a504bb
* Plugin update (breaking) A couple breaking changes regarding property types and method arguments. Add a setting to allow plugin errors to be shown instead of automatically disabling the plugin. All default hooks now use Dependency Injection to make it easy to get access to whatever you need (such as settings) Add a ton of comments and examples in the PHP code. Expand a bit on the documentation, it could still use more help Fix a bug in the settings and page view where the included blade file was output before the page headers, etc * Apply fixes from StyleCI --------- Co-authored-by: StyleCI Bot <bot@styleci.io>
37 lines
1.3 KiB
PHP
37 lines
1.3 KiB
PHP
<?php
|
|
|
|
namespace App\Plugins\ExamplePlugin;
|
|
|
|
use App\Plugins\Hooks\MenuEntryHook;
|
|
|
|
// this will create a menu entry in the plugin menu
|
|
// it should generally just be a
|
|
class Menu extends MenuEntryHook
|
|
{
|
|
// point to the view for your plugin's settings
|
|
// this is the default name so you can create the blade file as in this plugin
|
|
// by ommitting the variable, or point to another one
|
|
|
|
// public string $view = 'resources.views.menu';
|
|
|
|
// this will determine if the menu entry should be shown to the user
|
|
public function authorize(\App\Models\User $user, array $settings = []): bool
|
|
{
|
|
// menu entry shown if users has the global-read role and there is a setting that has > one entries in it
|
|
// return $user->can('global-read') && isset($settings['some_data']) && count($settings['some_data']) > 0;
|
|
|
|
return true; // allow every logged in user
|
|
}
|
|
|
|
// override the data function to add additional data to be accessed in the view
|
|
// inside the blade, all variables will be named based on the key in the returned array
|
|
public function data(array $settings = []): array
|
|
{
|
|
// inject settings and count how many we have so we can display it in the menu
|
|
|
|
return [
|
|
'count' => count($settings),
|
|
];
|
|
}
|
|
}
|