helpers.php

Go to the documentation of this file.

<?php

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use Illuminate\Contracts\Container\BindingResolutionException;
use Illuminate\Database\Eloquent\ModelNotFoundException;

if (!function_exists('settings')) {
    function settings($key = null, $default = null)
    {
        if ($key === null) {
            $settings = [];
            app()->make(ModuleInstance::class)->moduleInstanceSettings->each(function($setting) use (&$settings) {
                $settings[$setting->key] = $setting->value;
            });
            return $settings;
        } else {
            try {
                return app()->make(ModuleInstance::class)->moduleInstanceSettings()->where('key', $key)->firstOrFail()->value;
            } catch (ModelNotFoundException $e) {
                return $default;
            }
        }
    }
}

if (!function_exists('alias')) {
    function alias() {
        $moduleInstance = app()->make(ModuleInstance::class);
        if ($moduleInstance->exists) {
            return $moduleInstance->alias;
        }
        throw new Exception('Alias cannot be returned outside a module environment');
    }
}

if (!function_exists('hasPermission')) {
    function hasPermission(string $ability, ?User $userModel = null, ?Group $group = null, ?Role $role = null): bool {
        if ($userModel === null && $group === null && $role === null) {
            return \BristolSU\Support\Permissions\Facade\PermissionTester::evaluate($ability);
        }
        return \BristolSU\Support\Permissions\Facade\PermissionTester::evaluateFor($ability, $userModel, $group, $role);
    }

}