EWPP-253: Move media creation into trait. #124
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,214 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types = 1); | ||
|
|
||
| namespace Drupal\Tests\oe_media\Traits; | ||
|
|
||
| use Drupal\file\FileInterface; | ||
| use Drupal\media_avportal\Plugin\media\Source\MediaAvPortalSourceInterface; | ||
| use Drupal\media\Entity\Media; | ||
| use Drupal\Component\Utility\Html; | ||
|
|
||
| /** | ||
| * Helper methods to deal with media creation. | ||
| */ | ||
| trait MediaCreationTrait { | ||
|
|
||
| /** | ||
| * Create a file entity from given file path. | ||
| * | ||
| * @param string $filepath | ||
| * Path to the file location. | ||
| * | ||
| * @return \Drupal\file\FileInterface | ||
| * File entity object. | ||
| */ | ||
| protected function createFile(string $filepath): FileInterface { | ||
| $file = file_save_data(file_get_contents($filepath), 'public://' . basename($filepath)); | ||
| $file->setPermanent(); | ||
| $file->save(); | ||
|
|
||
| return $file; | ||
| } | ||
|
|
||
| /** | ||
| * Suggest a safe file name using the file uri. | ||
| * | ||
| * @param \Drupal\file\FileInterface $file | ||
| * The file entity. | ||
| * | ||
| * @return string | ||
| * The suggested name for the file entity. | ||
| */ | ||
| protected function getFileNameSuggestion(FileInterface $file): string { | ||
| return Html::cleanCssIdentifier($file->getFileUri()); | ||
| } | ||
|
|
||
| /** | ||
| * Create a media entity of image bundle. | ||
| * | ||
| * @param \Drupal\file\FileInterface $file | ||
| * The file entity. | ||
| * @param array $settings | ||
| * An associative array of settings for the media entity. | ||
| * | ||
| * @return \Drupal\media\Entity\Media | ||
|
|
||
| * The media object. | ||
| */ | ||
| protected function createMediaDocument(FileInterface $file, array $settings = []): Media { | ||
|
There was a problem hiding this comment. Return type hint should be MediaInterface. |
||
| $settings += [ | ||
| 'name' => $this->getFileNameSuggestion($file), | ||
| 'status' => 1, | ||
| 'uid' => 0, | ||
| ]; | ||
|
|
||
| $values = [ | ||
| 'bundle' => 'document', | ||
| 'name' => $settings['name'], | ||
| 'oe_media_file' => [ | ||
| 'target_id' => (int) $file->id(), | ||
| ], | ||
| 'status' => $settings['status'], | ||
| 'uid' => $settings['uid'], | ||
| ]; | ||
|
|
||
| foreach (['name', 'status', 'uid'] as $key) { | ||
| if (isset($settings[$key])) { | ||
| // Remove already used values. | ||
| unset($settings[$key]); | ||
| } | ||
| } | ||
|
|
||
| $values += $settings; | ||
| $media = \Drupal::entityTypeManager() | ||
| ->getStorage('media')->create($values); | ||
| $media->save(); | ||
|
|
||
| return $media; | ||
| } | ||
|
|
||
| /** | ||
| * Create a media entity of image bundle. | ||
| * | ||
| * @param \Drupal\file\FileInterface $file | ||
| * The file entity. | ||
| * @param array $settings | ||
| * An associative array of settings for the media entity. | ||
| * | ||
| * @return \Drupal\media\Entity\Media | ||
| * The media object. | ||
| */ | ||
| protected function createMediaImage(FileInterface $file, array $settings = []): Media { | ||
|
|
||
| $settings += [ | ||
| 'name' => $this->getFileNameSuggestion($file), | ||
| 'file_id' => FALSE, | ||
| 'alt' => 'image', | ||
|
There was a problem hiding this comment. Might be we can use $this->getFileNameSuggestion($file) for alt and title to make them more specific. |
||
| 'title' => 'image', | ||
| 'status' => 1, | ||
| 'uid' => 0, | ||
| ]; | ||
|
|
||
| $values = [ | ||
| 'bundle' => 'image', | ||
| 'name' => $settings['name'], | ||
| 'oe_media_image' => [ | ||
| 'target_id' => (int) $file->id(), | ||
| 'alt' => $settings['alt'], | ||
| 'title' => $settings['title'], | ||
| ], | ||
| 'status' => $settings['status'], | ||
| 'uid' => $settings['uid'], | ||
| ]; | ||
|
|
||
| foreach (['name', 'alt', 'title', 'status', 'uid'] as $key) { | ||
| if (isset($settings[$key])) { | ||
| // Remove already used values. | ||
| unset($settings[$key]); | ||
| } | ||
| } | ||
|
|
||
| $values += $settings; | ||
| $media = \Drupal::entityTypeManager() | ||
| ->getStorage('media')->create($values); | ||
| $media->save(); | ||
|
|
||
| return $media; | ||
| } | ||
|
|
||
| /** | ||
| * Create a media entity of av_portal_photo bundle. | ||
| * | ||
| * @param Drupal\media_avportal\Plugin\media\Source\MediaAvPortalSourceInterface $media_source | ||
| * The av_portal_photo media source. | ||
| * @param array $settings | ||
| * An associative array of settings for the media entity. | ||
| * | ||
| * @return \Drupal\media\Entity\Media | ||
| * The media object. | ||
| */ | ||
| protected function createMediaAvPortalPhoto(MediaAvPortalSourceInterface $media_source, array $settings = []): Media { | ||
|
|
||
| $settings += [ | ||
| 'status' => 1, | ||
| 'uid' => 0, | ||
| ]; | ||
|
|
||
| $values = [ | ||
| 'bundle' => 'av_portal_photo', | ||
| 'oe_media_avportal_photo' => $media_source->transformUrlToReference($settings['url']), | ||
| 'status' => $settings['status'], | ||
| 'uid' => $settings['uid'], | ||
| ]; | ||
|
|
||
| foreach (['url', 'status', 'uid'] as $key) { | ||
| if (isset($settings[$key])) { | ||
| // Remove already used values. | ||
| unset($settings[$key]); | ||
| } | ||
| } | ||
|
|
||
| $values += $settings; | ||
| $media = \Drupal::entityTypeManager() | ||
| ->getStorage('media')->create($values); | ||
| $media->save(); | ||
|
|
||
| return $media; | ||
| } | ||
|
|
||
| /** | ||
| * Create a media entity of remote_video bundle. | ||
| * | ||
| * @param array $settings | ||
| * An associative array of settings for the media entity. | ||
| * | ||
| * @return \Drupal\media\Entity\Media | ||
| * The media object. | ||
| */ | ||
| protected function createMediaRemoteVideo(array $settings = []): Media { | ||
|
|
||
| $settings += [ | ||
| 'status' => 1, | ||
| 'uid' => 0, | ||
| ]; | ||
|
|
||
| $values = [ | ||
| 'bundle' => 'remote_video', | ||
| 'oe_media_oembed_video' => $settings['url'], | ||
| 'status' => $settings['status'], | ||
| 'uid' => $settings['uid'], | ||
| ]; | ||
|
|
||
| foreach (['url', 'status', 'uid'] as $key) { | ||
| if (isset($settings[$key])) { | ||
| // Remove already used values. | ||
| unset($settings[$key]); | ||
| } | ||
| } | ||
|
|
||
| $values += $settings; | ||
| $media = \Drupal::entityTypeManager() | ||
| ->getStorage('media')->create($values); | ||
| $media->save(); | ||
|
|
||
| return $media; | ||
| } | ||
|
|
||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... from the given file path.