bristol-su / assign-roles

app/ModuleServiceProvider.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles;

use BristolSU\ControlDB\Contracts\Repositories\Position;
use BristolSU\Module\AssignRoles\CompletionConditions\RequiredPositionsFilled;
use BristolSU\Module\AssignRoles\Events\RoleCreated;
use BristolSU\Module\AssignRoles\Events\UserAssigned;
use BristolSU\Module\AssignRoles\Fields\PositionSettings;
use BristolSU\Support\Completion\Contracts\CompletionConditionManager;
use BristolSU\Support\Logic\Contracts\LogicRepository;
use BristolSU\Support\Logic\Logic;
use BristolSU\Support\Module\ModuleServiceProvider as ServiceProvider;
use FormSchema\Generator\Field;
use FormSchema\Generator\Group;
use FormSchema\Schema\Form;
use Illuminate\Support\Facades\Route;

class ModuleServiceProvider extends ServiceProvider

Missing doc comment for class ModuleServiceProvider

{

    protected $permissions = [
        'view-page' => [
            'name' => 'View Participant Page',
            'description' => 'View the main page of the module.',
            'admin' => false
        ],
        'admin.view-page' => [
            'name' => 'View Admin Page',
            'description' => 'View the administrator page of the module.',
            'admin' => true
        ],
        
        'assign' => [
            'name' => 'Assign a Role',
            'description' => 'Assign a role to a member of the group',
            'admin' => false
        ],
        'unassign' => [
            'name' => 'Unassign a Role',
            'description' => 'Unassign a user from a role',
            'admin' => false
        ],
        'see-members' => [
            'name' => 'See Member Lists',
            'description' => 'See a list of members that can be assigned roles',
            'admin' => false
        ],
        
        'role.index' => [
            'name' => 'See all roles',
            'description' => 'See a list of all existing roles for their group',
            'admin' => false
        ],
        'role.store' => [
            'name' => 'Create a role',
            'description' => 'Create a new role according to the settings',
            'admin' => false
        ],
        'role.delete' => [
            'name' => 'Delete a Role',
            'description' => 'Delete a role if no users are assigned to it',
            'admin' => false
        ],
        'role.update' => [
            'name' => 'Update a Role',
            'description' => 'Change the name and email of an existing role',
            'admin' => false
        ],
        
        
    ];

    protected $events = [
        RoleCreated::class => [
            'name' => 'Role Created',
            'description' => 'When a new role is created'
        ],
        UserAssigned::class => [
            'name' => 'User Assigned',
            'description' => 'When a user is assigned to a role'
        ],
    ];

    protected $commands = [

    ];

    public function alias(): string

Missing doc comment for function alias()

    {
        return 'assign-roles';
    }

    public function namespace()

Missing doc comment for function namespace()

    {
        return '\BristolSU\Module\AssignRoles\Http\Controllers';
    }

    public function baseDirectory()

Missing doc comment for function baseDirectory()

    {
        return __DIR__ . '/..';
    }

    public function boot()

Missing doc comment for function boot()

    {
        parent::boot();
        $this->registerGlobalScript('modules/assign-roles/js/components.js');
        
        app(CompletionConditionManager::class)->register('assign-roles', 'required_positions_are_filled', RequiredPositionsFilled::class);
    }

    public function register()

Missing doc comment for function register()

    {
        parent::register();
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function settings(): Form
    {
        return \FormSchema\Generator\Form::make()->withGroup(
            Group::make('Page Layout')->withField(
                Field::input('title')->inputType('text')->label('Title')->featured(false)->required(true)
                    ->default('Page Title')->hint('The title of the page')
                    ->help('This title will be shown at the top of the page, to help users understand what the module is for')
            )->withField(
                Field::input('subtitle')->inputType('text')->label('Subtitle')->featured(false)->required(true)
                    ->default('Page Subtitle')->hint('The subtitle for the page')
                    ->help('This subtitle will be shown under the title, and should include more information for users')
            )->withField(
                Field::input('no_settings')->inputType('text')->label('No Settings Text')->featured(false)->required(true)
                    ->default('No position settings found')->hint('Text to show if no position settings are found for the group')
                    ->help('If no position settings are found matching the group, an error page will be loaded. Use this text to explain what went wrong and how the user can fix it.')
            )
        )->withGroup(
            Group::make()->withField(
                Field::make(PositionSettings::class, 'position_settings')
                    ->label('Position Settings')->featured(true)->required(true)
                    ->default([])->hint('Define which positions can be assigned to whom')
                    ->help('Define the positions that may be used, positions which may only be held by one person and positions for which the assignee is not allowed any other positions')
                    ->logic($this->getLogic())
                    ->positions($this->getPositions())
            )->withField(
                Field::select('logic_group')->label('Logic Group to show')
                    ->featured(false)->required(false)->default(null)
                    ->hint('The logic group to show the roles from')
                    ->help('The logic group the roles should be in. If given, only roles in this logic group will be shown.')
                    ->values($this->getLogic()->map(function(Logic $logic) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                        return ['id' => $logic->id, 'name' => $logic->name];
                    }))

For multi-line function calls, the closing parenthesis should be on a new line.

                    ->selectOptions(['noneSelectedText' => '-- Show all roles --', 'hideNoneSelectedText' => false])
            )
        )->getSchema();
    }

    private function getLogic()

Private method name "ModuleServiceProvider::getLogic" must be prefixed with an underscore

Missing doc comment for function getLogic()

    {
        try {
            return collect(app(LogicRepository::class)->all());
        } catch (\Exception $e) {
            return collect();
        }
    }

    private function getPositions()

Private method name "ModuleServiceProvider::getPositions" must be prefixed with an underscore

Missing doc comment for function getPositions()

    {
        try {
            return collect(app(Position::class)->all());
        } catch (\Exception $e) {
            return collect();
        }
    }
}