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 <[email protected]>
This commit is contained in:
Tony Murray
2023-10-29 22:45:23 -05:00
committed by GitHub
co-authored by StyleCI Bot
parent 37334e9abc
commit 6bc8a504bb
16 changed files with 238 additions and 36 deletions
+34
View File
@@ -27,6 +27,40 @@ namespace App\Plugins\ExamplePlugin;
use App\Plugins\Hooks\PageHook;
// this page will be shown when the user clicks on the plugin from the plugins menu.
// This allows you to output a full screen of whatever you want to the user
class Page extends PageHook
{
// 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.page';
// The authorize method will determine if the user has access to this page.
// if you want all users to be able to access this page simple return true
public function authorize(\App\Models\User $user): bool
{
// you can check user's roles like this:
// return $user->can('admin');
// or use whatever you like
// return \Carbon\Carbon::now()->dayOfWeek == Carbon::THURSDAY; // only allowed access on Thursdays!
return true; // allow every logged in user to access
}
// override the data function to add additional data to be accessed in the view
// default just passes the stored data through
// inside the blade, all variables will be named based on the key in the returned array
public function data(): array
{
// run any calculations here
$username = auth()->user()->username;
return [
'something' => 'this is a variable and can be accessed with {{ $something }}',
'hello' => 'Hello: ' . $username,
];
}
}