bristol-su / upload-file

app/ModuleServiceProvider.php

<?php

Missing file doc comment

namespace BristolSU\Module\UploadFile;

use BristolSU\Module\UploadFile\CompletionConditions\NumberOfDocumentsSubmitted;
use BristolSU\Module\UploadFile\CompletionConditions\NumberOfDocumentsWithStatus;
use BristolSU\Module\UploadFile\Events\CommentCreated;
use BristolSU\Module\UploadFile\Events\CommentDeleted;
use BristolSU\Module\UploadFile\Events\CommentUpdated;
use BristolSU\Module\UploadFile\Events\DocumentDeleted;
use BristolSU\Module\UploadFile\Events\DocumentUpdated;
use BristolSU\Module\UploadFile\Events\DocumentUploaded;
use BristolSU\Module\UploadFile\Events\StatusChanged;
use BristolSU\Module\UploadFile\Fields\TagList;
use BristolSU\Module\UploadFile\Models\Comment;
use BristolSU\Module\UploadFile\Models\File;
use BristolSU\Module\UploadFile\Models\FileStatus;
use BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver;
use BristolSU\Support\Completion\Contracts\CompletionConditionManager;
use BristolSU\Support\Module\ModuleServiceProvider as ServiceProvider;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use FormSchema\Generator\Field;
use FormSchema\Generator\Form as FormGenerator;
use FormSchema\Generator\Group;
use FormSchema\Schema\Form;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Route;

class ModuleServiceProvider extends ServiceProvider

Missing doc comment for class ModuleServiceProvider

{

    protected $permissions = [
        // ##### Web #####
        '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
        ],
        
        // ##### Api #####
        // Files
        'file.store' => [
            'name' => 'Upload a new file',
            'description' => 'Allow the ability to upload a file.',
            'admin' => false
        ],
        'file.download' => [
            'name' => 'Download a file',
            'description' => 'Allow the user to download a file',
            'admin' => false
        ],
        'file.index' => [
            'name' => 'See files',
            'description' => 'Allow the user to view files',
            'admin' => false
        ],
        'file.destroy' => [
            'name' => 'Delete files',
            'description' => 'Allow the user to delete files',
            'admin' => false
        ],
        'file.update' => [
            'name' => 'Edit files',
            'description' => 'Allow the user to edit files',
            'admin' => false
        ],
        // Comments
        'comment.index' => [
            'name' => 'See comments',
            'description' => 'Allow the user to see comments',
            'admin' => false
        ],
        'comment.store' => [
            'name' => 'Comment',
            'description' => 'Allow the user to comment in files',
            'admin' => false
        ],
        'comment.destroy' => [
            'name' => 'Delete a Comment',
            'description' => 'Allow the user to delete a comment.',
            'admin' => false
        ],
        'comment.update' => [
            'name' => 'Update a Comment',
            'description' => 'Allow the user to update a comment.',
            'admin' => false
        ],
        
        // Files
        'admin.file.index' => [
            'name' => 'View all files',
            'description' => 'Allow the user to view all uploaded files',
            'admin' => true
        ],
        'admin.file.store' => [
            'name' => 'Upload a new file',
            'description' => 'Allow the ability to upload a file on behalf of a user.',
            'admin' => true
        ],
        'admin.file.destroy' => [
            'name' => 'Delete a file',
            'description' => 'Allow the user to delete any uploaded file',
            'admin' => true
        ],
        'admin.file.update' => [
            'name' => 'Update a File',
            'description' => 'Allow the user to update any file name/description or reassign the file.',
            'admin' => true
        ],
        'admin.file.download' => [
            'name' => 'Download files',
            'description' => 'Allow the user to download any uploaded files',
            'admin' => true
        ],
        // Statuses
        'admin.status.create' => [
            'name' => 'Change document status',
            'description' => 'Allow the user to change the status of any file',
            'admin' => true
        ],
        // Comments
        'admin.comment.index' => [
            'name' => 'See comments',
            'description' => 'Allow the admin to see comments',
            'admin' => true
        ],
        'admin.comment.store' => [
            'name' => 'Comment',
            'description' => 'Allow the admin to comment in files',
            'admin' => true
        ],
        'admin.comment.destroy' => [
            'name' => 'Delete a Comment',
            'description' => 'Allow the admin to delete a comment.',
            'admin' => true
        ],
        'admin.comment.update' => [
            'name' => 'Update a Comment',
            'description' => 'Allow the admin to update a comment.',
            'admin' => true
        ],
    ];

    protected $events = [
        CommentCreated::class => [
            'name' => 'Comment Left',
            'description' => 'When a comment has been left'
        ],
        CommentDeleted::class => [
            'name' => 'Comment Deleted',
            'description' => 'When a comment has been deleted'
        ],
        CommentUpdated::class => [
            'name' => 'Comment Updated',
            'description' => 'When a comment has been updated'
        ],
        DocumentDeleted::class => [
            'name' => 'Document Deleted',
            'description' => 'When a document is deleted'
        ],
        DocumentUpdated::class => [
            'name' => 'Document Updated',
            'description' => 'When a document is updated'
        ],
        DocumentUploaded::class => [
            'name' => 'Document Uploaded',
            'description' => 'When a document is uploaded'
        ],
        StatusChanged::class => [
            'name' => 'Status Changed',
            'description' => 'When the status of a document is changed'
        ]
    ];
    
    protected $commands = [
        
    ];
    
    public function alias(): string

Missing doc comment for function alias()

    {
        return 'uploadfile';
    }

    public function namespace()

Missing doc comment for function namespace()

    {
        return '\BristolSU\Module\UploadFile\Http\Controllers';
    }
    
    public function baseDirectory()

Missing doc comment for function baseDirectory()

    {
        return __DIR__ . '/..';
    }

    public function register()

Missing doc comment for function register()

    {
        parent::register(); // TODO: Change the autogenerated stub
    }

    public function boot()

Missing doc comment for function boot()

    {
        parent::boot();
        
        $this->registerGlobalScript('modules/uploadfile/js/components.js');
        
        $this->app->make(CompletionConditionManager::class)->register(
            $this->alias(), 'number_of_files_submitted', NumberOfDocumentsSubmitted::class
        );
        $this->app->make(CompletionConditionManager::class)->register(
            $this->alias(), 'number_of_files_submitted_with_status', NumberOfDocumentsWithStatus::class
        );
        
        Route::bind('uploadfile_file', function($id) {

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

            $file = File::findOrFail($id);
            if(request()->route('module_instance_slug') && (int) $file->module_instance_id === request()->route('module_instance_slug')->id()) {

Expected "if (...) {\n"; found "if(...) {\n"

                return $file;
            }
            throw (new ModelNotFoundException)->setModel(File::class);
        });

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

        Route::bind('uploadfile_old_file', function($id) {

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

            $file = File::findOrFail($id);
            
            $currentActivityInstance = app(ActivityInstanceResolver::class)->getActivityInstance();
            $fileActivityInstance = $file->activityInstance();
            if($currentActivityInstance->resource_type === $fileActivityInstance->resource_type

Expected "if (...) {\n"; found "if(...) {\n"

                && (int) $currentActivityInstance->resource_id === (int) $fileActivityInstance->resource_id) {

Closing parenthesis of a multi-line IF statement must be on a new line

                return $file;
            }
            throw (new ModelNotFoundException)->setModel(File::class);
        });

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

        
        Route::bind('uploadfile_file_status', function($id) {

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

            $fileStatus = FileStatus::findOrFail($id);
            if(request()->route('module_instance_slug') && (int) $fileStatus->file->module_instance_id === request()->route('module_instance_slug')->id()) {

Expected "if (...) {\n"; found "if(...) {\n"

                return $fileStatus;
            }
            throw (new ModelNotFoundException)->setModel(FileStatus::class);
        });

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

        
        Route::bind('uploadfile_comment', function($id) {

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

            $comment = Comment::findOrFail($id);
            if(request()->route('module_instance_slug') && (int) $comment->file->module_instance_id === request()->route('module_instance_slug')->id()) {

Expected "if (...) {\n"; found "if(...) {\n"

                return $comment;
            }
            throw (new ModelNotFoundException)->setModel(Comment::class);
        });

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

    }

    public function settings(): Form

Missing doc comment for function settings()

    {

        return FormGenerator::make()->withGroup(
            Group::make('Page Design')->withField(
                Field::input('title')->inputType('text')->label('Module Title')->default('Page Title')
            )->withField(
                Field::textArea('description')->label('Description')->hint('This will appear at the top of the page')->rows(4)->default('Description')
            )
        )->withGroup(
            Group::make('New Documents')->withField(
                Field::input('document_title')->inputType('text')->label('Default document title')->hint('This will be the default title of a new file')->default('Document')
            )->withField(
                Field::switch('multiple_files')->label('Multiple Files')->hint('Should multiple files be able to be uploaded at the same time?')
                    ->textOn('Allow')->textOff('Do not allow')->default(true)
            )->withField(
                Field::checkList('allowed_extensions')->label('Allowed file types')->hint('Which file types can be uploaded?')
                    ->listBox(true)->values($this->app['config']->get($this->alias() . '.file_types'))
		                ->default(['doc', 'docx', 'odt', 'rtf', 'txt', 'csv', 'ppt', 'pptx', 'pdf', 'xls'])

Object operator not indented correctly; expected 20 spaces but found 18

            )
        )->withGroup(
            Group::make('Status Changes')->withField(
                Field::input('initial_status')->inputType('select')->label('Initial Status')->hint('What status should all new files have?')
                        ->default('Awaiting Approval')->values($this->app['config']->get($this->alias() . '.statuses'))

Object operator not indented correctly; expected 20 spaces but found 24

            )->withField(
                Field::checkList('statuses')->label('Available Statuses')->hint('A list of available statuses')
                    ->listBox(true)->values($this->app['config']->get($this->alias() . '.statuses'))
            )
        )->withGroup(
            Group::make('Tags')->withField(
                Field::make(TagList::class, 'new_tags')->label('New Tags')->hint('What tags should we assign when a new document is uploaded?')
            )->withField(
                Field::make(TagList::class, 'tags_to_merge')->label('Tags to merge')->hint('Any files with these tags will also be shown to the user')
            )
        )->getSchema();
    }
}