Files
librenms-librenms/app/Plugins/ExamplePlugin/PortTab.php
Tony Murray 6bc8a504bb Plugin update (breaking) (#15498)
* 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>
2023-10-29 22:45:23 -05:00

32 lines
1.1 KiB
PHP

<?php
namespace App\Plugins\ExamplePlugin;
use App\Plugins\Hooks\PortTabHook;
// this will insert a tab into every port view
class PortTab extends PortTabHook
{
// point to the view for your plugin's port plugin
// 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.port-tab';
// override the data function to add additional data to be accessed in the view
// title is a required attribute and will be shown above your returned html from your blade file
// inside the blade, all variables will be named based on the key in the returned array
public function data(\App\Models\Port $port): array
{
// run any calculations here
$total_delta = $port->ifOutOctets_delta + $port->ifInOctets_delta; // nonsense calculation :)
return [
'title' => 'Example Plugin',
'port' => $port,
'something' => 'this is a variable and can be accessed with {{ $something }}',
'total' => $total_delta,
];
}
}