Media Default Image

Thank you for applying!

Please read Review process for security advisory coverage: What to expect → for more details and Security advisory coverage application checklist → to understand what reviewers look for. Tips for ensuring a smooth review → gives some hints for a smoother review.

The important notes are the following.

• If you have not done it yet, you should run phpcs --standard=Drupal,DrupalPractice on the project, which alone fixes most of what reviewers would report.
• For the time this application is open, only your commits are allowed.
• The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application and no other user will be able to opt projects into security advisory policy.
• We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

To the reviewers

Please read How to review security advisory coverage applications → , Application workflow → , What to cover in an application review → , and Tools to use for reviews → .

The important notes are the following.

• It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
• Reviewers should show the output of a CLI tool → only once per application.
• It may be best to have the applicant fix things before further review.

For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues → .

Remember to change status, when the project is ready to be reviewed. In this queue, projects are only reviewed when the status is Needs review.

The code is ready to review

1. Fix phpcs issues.

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml media_default_image/

FILE: media_default_image/Readme.md
-----------------------------------------------------------------------
FOUND 1 ERROR AND 2 WARNINGS AFFECTING 3 LINES
-----------------------------------------------------------------------
 34 | WARNING | [ ] Line exceeds 80 characters; contains 81 characters
 36 | WARNING | [ ] Line exceeds 80 characters; contains 94 characters
 40 | ERROR   | [x] Expected 1 newline at end of file; 0 found
-----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------

2. FILE: media_default_image.module

/**
 * @file
 * Contains media default image module.
 */

The usual description for a .module file is “Hook implementations for the [module name] module”, where [module name] is the module name given in the .info.yml file.

3. FILE: src/Form/DefaultImageSettingsForm.php

Properties should be declared first in a class, followed by methods.

Comments #7 💬 Media Default Image Active is fixed

Rest seems fine to me.

Let’s wait for other reviewers and Code Review Administrator to take a look and if everything goes fine, you will get the role.

I will review the project tomorrow.

• The following points are just a start and don't necessarily encompass all of the changes that may be necessary
• A specific point may just be an example and may apply in other places
• A review is about code that does not follow the coding standards, contains possible security issue, or does not correctly use the Drupal API
• The single review points are not ordered, not even by importance

src/Form/DefaultImageSettingsForm.php

If the settings are only used by a plugin, there is no need to create a form class. A plugin's form is returned by its settingsForm() method.

      catch (FileException $exception) {
        $this->logger('media_default_image')->error($exception->getMessage());
      }

The $message parameter passed to the LoggerInterface methods must be a literal string that uses placeholders. It's not a translatable string returned from t() or $this->t(), a string concatenation, nor a value returned from a function/method.

$form_state->setErrorByName('test', 'No image found for image one');

The second argument passed to ::setErrorByName() needs to be a translatable string.

src/Plugin/Field/FieldFormatter/DefaultImageFormatter.php

The class is not part of the public API and cannot be used as parent class for classes implemented by a contributed module. Only base classes can be used as parent class.

Hi,
The reason why I use Form, I need to use default image multiple times, not only for the FieldFormatter.

I will fix the others issue.

Regards
Khalil

Hi,

I've updated my code, can you please review?

Best regards
Khalil

I am changing priority as per Issue priorities → .

Hi @ckhalilo!
Below you have my feedback:

1. One of the issues reported in comment #11 💬 Media Default Image Active is still pending in src/Form/DefaultImageSettingsForm.php file, validateForm() method.

2. In the DefaultImageSettingsForm.php the default_image field is not required, so that means that I can leave the field empty. The submitForm() method does not store the data when the field is empty, which can be confusing. Either make the field required or allow to store empty data.

3. The DefaultImageFormatter.php file duplicates significant code from web/core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php. I was about to ask why not extending it, but it is unclear why you are trying to apply "image" options to a "media" formatter. You should consider extending the Rendered entity or Thumbnail formatters and simply handle the default image addition, and let the parent do its job, unless there's something that I am missing. By doing the current implementation you are cancelling the Media image usage.

4. You have some French comments in the createDefaultImageElement method.

5. There is no error handling for when a user attempts to use the formatter without any default image set.

6. The formatter seems to be intended for Media entity but the isApplicable method is not implemented to limit the options. Because of this I can set this formatter to any type of entity reference.

7. When you are building the default image element, you should consider adding the configuration as cacheable dependency.

8. Better replace "How to use" with "Configuration" in README and provide better info on how to configure and use the module. And it would be preferred to have the name of the README file in full uppercase.

9. The hook_help provides no relevant information.

10. It's still not clear what's the benefit of this module and the global configuration as mentioned in comments #11 💬 Media Default Image Active and #12 💬 Media Default Image Active . The current explanation is

I need to use default image multiple times, not only for the FieldFormatter

but there is only one usage implemented in the module, and that's the field formatter.

I am changing priority as per Issue priorities → .