EscolaLMS/model-fields

Avoid excessively long variable names like $metadataFieldVisibility. Keep variable name length under 20.

Open

    private function checkVisibility(?int $visibility = null, int $metadataFieldVisibility): int|bool

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

Avoid using short method names like CreateModelFieldsMetadataTable::up(). The configured minimum method name length is 3.

Open

    public function up()
    {
        Schema::create('model_fields_metadata', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->timestamps();

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ShortMethod {
    public function a( $index ) { // Violation
    }
}

Avoid using short method names like CreateModelFieldsValuesTable::up(). The configured minimum method name length is 3.

Open

    public function up()
    {
        Schema::create('model_fields_values', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->timestamps();

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ShortMethod {
    public function a( $index ) { // Violation
    }
}

Method getExtraAttributesValues has 27 lines of code (exceeds 25 allowed). Consider refactoring.

Open

    public function getExtraAttributesValues(Model $model, ?int $visibility = null): array
    {
        if (config('model-fields.enabled')) {
            if (!array_key_exists('id', $model->getAttributes())) {
                return [];

Each class must be in a namespace of at least one level (a top-level vendor name)

Open

class CreateModelFieldsMetadataTable extends Migration

• Exclude checks
  • Disable engine
  • Disable check

Each class must be in a namespace of at least one level (a top-level vendor name)

Open

class CreateModelFieldsValuesTable extends Migration

• Exclude checks
  • Disable engine
  • Disable check

Method addOrUpdateMetadataField has 7 arguments (exceeds 4 allowed). Consider refactoring.

Open

    public function addOrUpdateMetadataField(string $class_type, string $name, string $type, string $default = '', array $rules = null, int $visibility = 1 << 0, array $extra = null): Metadata

Method addOrUpdateMetadataField has 7 arguments (exceeds 4 allowed). Consider refactoring.

Open

    public function addOrUpdateMetadataField(string $class_type, string $name, string $type, string $default = '', array $rules = null, int $visibility = 1 << 0, array $extra = null): Metadata;

Identical blocks of code found in 2 locations. Consider refactoring.

Open

        if ($instance = $query->first()) {
            foreach ($additionalAttributes as $key => $value) {
                $query = $query->whereHas('fields', function ($query) use ($key, $value){
                    return $query->where([
                        ['name', '=', $key],

• Read up
  Read up

Identical blocks of code found in 2 locations. Consider refactoring.

Open

        if ($instance = $query->first()) {
            foreach ($additionalAttributes as $key => $value) {
                $query = $query->whereHas('fields', function ($query) use ($key, $value){
                    return $query->where([
                        ['name', '=', $key],

• Read up
  Read up

The parameter $class_type is not named in camelCase.

Open

    public function addOrUpdateMetadataField(string $class_type, string $name, string $type, string $default = '', array $rules = null, int $visibility = 1 << 0, array $extra = null): Metadata;

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function removeMetaField(string $class_type, string $name): bool
    {
        $bool = Metadata::where(
            ['class_type' => $class_type, 'name' => $name]
        )->delete();

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function getFieldsMetadataRules(string $class_type): array;

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function getFieldsMetadata(string $class_type): Collection;

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function getFieldsMetadataListPaginated(string $class_type, ?int $perPage = 15, ?OrderDto $orderDto = null): Collection|LengthAwarePaginator;

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function removeMetaField(string $class_type, string $name): bool;

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function addOrUpdateMetadataField(string $class_type, string $name, string $type, string $default = '', array $rules = null, int $visibility = 1 << 0, array $extra = null): Metadata
    {
        if (!MetaFieldTypeEnum::hasValue($type)) {
            throw ValidationException::withMessages([
                'type' => [sprintf('type must be one of %s', implode(",", MetaFieldTypeEnum::getValues()))],

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function getFieldsMetadata(string $class_type): Collection
    {
        // add result of hasTable to the cache to limit database queries
        $tableExist = Cache::rememberForever('model_fields_metadata_table_exists', function () {
            return Schema::hasTable('model_fields_metadata');

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function getFieldsMetadataListPaginated(string $class_type, ?int $perPage = 15, ?OrderDto $orderDto = null): Collection|LengthAwarePaginator
    {
        if (!config('model-fields.enabled')) {
            return collect([]);
        }

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}

The parameter $class_type is not named in camelCase.

Open

    public function getFieldsMetadataRules(string $class_type): array
    {
        if (config('model-fields.enabled')) {
            return $this->getFieldsMetadata($class_type)
                ->mapWithKeys(fn($item, $key) => [$item['name'] => is_array($item['rules']) ? $item['rules'] : []])

• Read up
  Read up
• Exclude checks
  • Disable engine
  • Disable check

class ClassName {
    public function doSomething($user_name) {
    }
}