Sign upLogin

EscolaLMS/Courses-Import-Export

View on GitHub
Star

Showing 113 of 113 total issues

The method createZipFromFolder has a boolean flag argument $withUrl, which is a certain sign of a Single Responsibility Principle violation.
Open

    private function createZipFromFolder($dirName, bool $withUrl = true): string
Severity: Minor
Found in src/Services/ExportImportService.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

Missing class import via use statement (line '122', column '27').
Open

                throw new \Exception("File [`{$file}`] could not be added to the zip file: " . $zip->getStatusString());
Severity: Minor
Found in src/Services/ExportImportService.php by phpmd

MissingImport

Since: 2.7.0

Importing all external classes in a file through use statements makes them clearly visible.

Example

function make() {
    return new \stdClass();
}

Source http://phpmd.org/rules/cleancode.html#MissingImport

The method export has a boolean flag argument $withUrl, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function export($courseId, bool $withUrl = true): string;
Severity: Minor
Found in src/Services/Contracts/ExportImportServiceContract.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

The method export has a boolean flag argument $withUrl, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function export($courseId, bool $withUrl = true): string
Severity: Minor
Found in src/Services/ExportImportService.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

Function export has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public function export(User $user, Course $course)
    {
        if ($user->hasRole('admin')) {
            return true;
        }
Severity: Minor
Found in src/Policies/CoursesExportPolicy.php - About 25 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid using static access to class '\EscolaLms\Courses\Http\Resources\CourseSimpleResource' in method 'import'.
Open

                CourseSimpleResource::make($course),
Severity: Minor
Found in src/Http/Controllers/CourseExportImportAPIController.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid unused parameters such as '$request'.
Open

    public function toArray($request): array
Severity: Minor
Found in src/Http/Resources/LessonExportResource.php by phpmd

UnusedFormalParameter

Since: 0.2

Avoid passing parameters to methods or constructors and then not using those parameters.

Example

class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

Avoid using static access to class '\EscolaLms\Courses\Facades\Topic' in method 'toArray'.
Open

        if (Topic::getResourceClass($this->resource->topicable_type, 'export')) {
Severity: Minor
Found in src/Http/Resources/TopicExportResource.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\EscolaLms\Courses\Facades\Topic' in method 'toArray'.
Open

            $resourceClass = Topic::getResourceClass($this->resource->topicable_type, 'export');
Severity: Minor
Found in src/Http/Resources/TopicExportResource.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\EscolaLms\CoursesImportExport\Events\CloneCourseFailedEvent' in method 'handle'.
Open

            CloneCourseFailedEvent::dispatch($this->user, $this->course);
Severity: Minor
Found in src/Jobs/CloneCourse.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Illuminate\Auth\Access\Response' in method 'export'.
Open

            return Response::deny('You do not own this course.');
Severity: Minor
Found in src/Policies/CoursesExportPolicy.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\EscolaLms\CoursesImportExport\Jobs\CloneCourse' in method 'clone'.
Open

        CloneCourse::dispatch($course, auth()->user());
Severity: Minor
Found in src/Services/CloneCourseService.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Illuminate\Support\Facades\Storage' in method 'createExportJson'.
Open

        Storage::put($dirName . '/content/content.json', $json);
Severity: Minor
Found in src/Services/ExportImportService.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Illuminate\Support\Facades\File' in method 'import'.
Open

            $content = json_decode(File::get($dirFullPath . DIRECTORY_SEPARATOR . 'content.json'), true);
Severity: Minor
Found in src/Services/ExportImportService.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\EscolaLms\CoursesImportExport\Models\Course' in method 'createCourseFromImport'.
Open

        $courseValidator = Validator::make($courseData, Course::rules());
Severity: Minor
Found in src/Services/ExportImportService.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class 'EscolaLms\CoursesImportExport\Http\Resources\CourseScormScoExportResource' in method 'toArray'.
Open

            'scorm_sco' => $this->when($course->scorm_sco_id !== null, fn () => CourseScormScoExportResource::make($course)),
Severity: Minor
Found in src/Http/Resources/CourseExportResource.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Illuminate\Support\Facades\File' in method 'make'.
Open

        if (!File::exists($filePath)) {
Severity: Minor
Found in src/Strategies/H5PTopicTypeStrategy.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class 'EscolaLms\CoursesImportExport\Http\Resources\CategoryExportResource' in method 'toArray'.
Open

            'categories' => CategoryExportResource::collection($course->categories),
Severity: Minor
Found in src/Http/Resources/CourseExportResource.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\EscolaLms\CoursesImportExport\Models\Course' in method 'fixAllPathsBeforeZipping'.
Open

        $course = Course::findOrFail($courseId);
Severity: Minor
Found in src/Services/ExportImportService.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Avoid using static access to class '\Spatie\Permission\Models\Role' in method 'run'.
Open

        $admin = Role::findOrCreate(UserRole::ADMIN, 'api');
Severity: Minor
Found in database/seeders/CoursesExportImportPermissionSeeder.php by phpmd

StaticAccess

Since: 1.4.0

Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

Example

class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

Source https://phpmd.org/rules/cleancode.html#staticaccess

Severity
Category
Status
Source
Language