Skip to content
Snippets Groups Projects
Commit 01b9414f authored by Sven Decabooter's avatar Sven Decabooter
Browse files

Issue #3519841 by peterlemmens, svendecabooter: Support OOP hooks

parent 94dd18ad
No related branches found
No related tags found
No related merge requests found
Pipeline #488964 canceled
Stage: build
Stage: validate
Hide whitespace changes
Inline Side-by-side
contextual_image_widget_crop.module
+ 2
− 38
View file @ 01b9414f
......@@ -6,6 +6,7 @@
*/
use Drupal\contextual_image_widget_crop\Hook\EntityTypeHooks;
use Drupal\contextual_image_widget_crop\Hook\HelpHooks;
use Drupal\contextual_image_widget_crop\Hook\ThemeHooks;
use Drupal\Core\Hook\Attribute\LegacyHook;
use Drupal\Core\Routing\RouteMatchInterface;
......@@ -14,44 +15,7 @@ use Drupal\Core\Routing\RouteMatchInterface;
* Implements hook_help().
*/
function contextual_image_widget_crop_help($route_name, RouteMatchInterface $route_match) {
switch ($route_name) {
// Main module help for the contextual_image_widget_crop module.
case 'help.page.contextual_image_widget_crop':
$output = '';
$output .= '<h2>' . t('About') . '</h2>';
$output .= '<p>' . t('Enhances the Image Widget Crop module when using the Media Library, to take
into account the context of the entity the Image Media entity gets added.') . '</p>';
$output .= '<p>' . t('Say you have a node type "blogpost", and it contains a Media entity reference
field for the blog post teaser image. On the "Manage display" page for blogpost,
you have configured the Media image to be displayed through the image_blog_post
image style (which uses for example a 4:3 crop type, from your list of available
crop types).') . '</p>';
$output .= '<p>' . t('When adding a Media image to your blog post, you only want to let editors set
the 4:3 crop type, since that will be the one used after saving the node. Other
crop types that might have been configured, are not relevant in this context, so
we do not expose them to the editor, to simplify their workflow.') . '</p>';
$output .= '<h3>' . t('Prerequisites') . '</h3>';
$output .= '<p>' . t('Have multiple crop types defined at Home > Administration > Configuration > Media > Crop types') . '</p>';
$output .= '<p>' . t('Have ImageCropWidget module configured at Home > Administration > Configuration > Media >Image Crop Widget settings') . '</p>';
$output .= '<p>' . t('Have one or more image styles configured that use cropping, at Home > Administration > Configuration > Media > Image styles') . '</p>';
$output .= '<h3>' . t('First, configure the form for the entity that has the Media attached:') . '</h3>';
$output .= '<p>' . t('Figure out which entity type(s) / bundle(s) have a Media reference field, for which you want to enable this functionality. E.g. if this is a Node entity of bundle "blogpost", to go Structure > Content Types > Blog post > "Manage form display"') . '</p>';
$output .= '<p>' . t('Find the Media field, and set the widget to "Contextual Image Widget Crop: Media library"') . '</p>';
$output .= '<h3>' . t('Next, configure the display for the entity that has the Media attached:') . '</h3>';
$output .= '<p>' . t('E.g. if this is a Node entity of bundle "blogpost", to go Structure > Content Types > Blog post > Manage display"') . '</p>';
$output .= '<p>' . t('For the Media field on that page, configure the formatter. E.g. "Thumbnail" format with image style "image_blog_post".') . '</p>';
$output .= '<h3>' . t('Finally, set our custom widget for the image field on the Media entity:') . '</h3>';
$output .= '<p>' . t('Go to Home > Administration > Structure > Media types > Image.') . '</p>';
$output .= '<p>' . t('For the "Media library" form display, set the widget for field "Image" to "Contextual ImageWidget crop". Configure as you would with the default ImageWidget crop widget.') . '</p>';
$output .= '<p>' . t('Now if you add a new instance of your entity type, you will open the Media Library to select an existing or new Media image. The ImageWidget crop tool will only show the relevant crop type (in our case, the one used by "image_blog_post", as described above).') . '</p>';
$output .= '<p>' . t(
'Visit the <a href=":project_link">Contextual Image Widget Crop project page</a>.',
[':project_link' => 'https://www.drupal.org/project/contextual_image_widget_crop']
) . '</p>';
$output .= '<p>' . t('Kindly refer the README.md file for more details.') . '</p>';
return $output;
}
return \Drupal::service(HelpHooks::class)->help();
}
/**
......
contextual_image_widget_crop.services.yml
+ 5
− 0
View file @ 01b9414f
parameters:
contextual_image_widget_crop.hooks_converted: true
services:
contextual_image_widget_crop.route_subscriber:
class: Drupal\contextual_image_widget_crop\Routing\RouteSubscriber
......@@ -7,6 +9,9 @@ services:
Drupal\contextual_image_widget_crop\Hook\EntityTypeHooks:
class: Drupal\contextual_image_widget_crop\Hook\EntityTypeHooks
autowire: true
Drupal\contextual_image_widget_crop\Hook\HelpHooks:
class: Drupal\contextual_image_widget_crop\Hook\HelpHooks
autowire: true
Drupal\contextual_image_widget_crop\Hook\ThemeHooks:
class: Drupal\contextual_image_widget_crop\Hook\ThemeHooks
autowire: true
src/Hook/HelpHooks.php 0 → 100644
+ 62
− 0
View file @ 01b9414f
<?php
declare(strict_types=1);
namespace Drupal\contextual_image_widget_crop\Hook;
use Drupal\Core\Hook\Attribute\Hook;
use Drupal\Core\StringTranslation\StringTranslationTrait;
/**
* Help hook implementations for the contextual_image_widget_crop module.
*/
class HelpHooks {
use StringTranslationTrait;
/**
* Implements hook_help().
*/
#[Hook('help')]
public function help(string $route_name): ?string {
// Main module help for the contextual_image_widget_crop module.
if ($route_name === 'help.page.contextual_image_widget_crop') {
$output = '';
$output .= '<h2>' . $this->t('About') . '</h2>';
$output .= '<p>' . $this->t('Enhances the Image Widget Crop module when using the Media Library, to take
into account the context of the entity the Image Media entity gets added.') . '</p>';
$output .= '<p>' . $this->t('Say you have a node type "blogpost", and it contains a Media entity reference
field for the blog post teaser image. On the "Manage display" page for blogpost,
you have configured the Media image to be displayed through the image_blog_post
image style (which uses for example a 4:3 crop type, from your list of available
crop types).') . '</p>';
$output .= '<p>' . $this->t('When adding a Media image to your blog post, you only want to let editors set
the 4:3 crop type, since that will be the one used after saving the node. Other
crop types that might have been configured, are not relevant in this context, so
we do not expose them to the editor, to simplify their workflow.') . '</p>';
$output .= '<h3>' . $this->t('Prerequisites') . '</h3>';
$output .= '<p>' . $this->t('Have multiple crop types defined at Home > Administration > Configuration > Media > Crop types') . '</p>';
$output .= '<p>' . $this->t('Have ImageCropWidget module configured at Home > Administration > Configuration > Media >Image Crop Widget settings') . '</p>';
$output .= '<p>' . $this->t('Have one or more image styles configured that use cropping, at Home > Administration > Configuration > Media > Image styles') . '</p>';
$output .= '<h3>' . $this->t('First, configure the form for the entity that has the Media attached:') . '</h3>';
$output .= '<p>' . $this->t('Figure out which entity type(s) / bundle(s) have a Media reference field, for which you want to enable this functionality. E.g. if this is a Node entity of bundle "blogpost", to go Structure > Content Types > Blog post > "Manage form display"') . '</p>';
$output .= '<p>' . $this->t('Find the Media field, and set the widget to "Contextual Image Widget Crop: Media library"') . '</p>';
$output .= '<h3>' . $this->t('Next, configure the display for the entity that has the Media attached:') . '</h3>';
$output .= '<p>' . $this->t('E.g. if this is a Node entity of bundle "blogpost", to go Structure > Content Types > Blog post > Manage display"') . '</p>';
$output .= '<p>' . $this->t('For the Media field on that page, configure the formatter. E.g. "Thumbnail" format with image style "image_blog_post".') . '</p>';
$output .= '<h3>' . $this->t('Finally, set our custom widget for the image field on the Media entity:') . '</h3>';
$output .= '<p>' . $this->t('Go to Home > Administration > Structure > Media types > Image.') . '</p>';
$output .= '<p>' . $this->t('For the "Media library" form display, set the widget for field "Image" to "Contextual ImageWidget crop". Configure as you would with the default ImageWidget crop widget.') . '</p>';
$output .= '<p>' . $this->t('Now if you add a new instance of your entity type, you will open the Media Library to select an existing or new Media image. The ImageWidget crop tool will only show the relevant crop type (in our case, the one used by "image_blog_post", as described above).') . '</p>';
$output .= '<p>' . $this->t(
'Visit the <a href=":project_link">Contextual Image Widget Crop project page</a>.',
[':project_link' => 'https://www.drupal.org/project/contextual_image_widget_crop']
) . '</p>';
$output .= '<p>' . $this->t('Kindly refer the README.md file for more details.') . '</p>';
return $output;
}
return NULL;
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment