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>
This commit is contained in:
Tony Murray
2023-10-29 22:45:23 -05:00
committed by GitHub
parent 37334e9abc
commit 6bc8a504bb
16 changed files with 238 additions and 36 deletions
@@ -29,4 +29,31 @@ use App\Plugins\Hooks\DeviceOverviewHook;
class DeviceOverview extends DeviceOverviewHook
{
// 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.device-overview';
public function authorize(\App\Models\User $user, \App\Models\Device $device): bool
{
// In this example, we check if the user has a custom role/permission and if it is member of any device groups
// return $user->can('view-extra-port-info') && $device->has('groups');
return true;
}
// 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\Device $device): array
{
// here we pass a title string, url to notes, and the device to the blade view for display
return [
'title' => 'Example Plugin: Device Notes',
'device' => $device,
'url' => url('device/' . $device->device_id . '/notes'),
];
}
}