diff --git a/modules/printable_pdf/printable_pdf.module b/modules/printable_pdf/printable_pdf.module index 9f6684e..c76ab54 100644 --- a/modules/printable_pdf/printable_pdf.module +++ b/modules/printable_pdf/printable_pdf.module @@ -1,5 +1,12 @@ getPath('printable_pdf'); - return [ - 'printable_pdf_footer' => [ - 'template' => 'printable-footer', - 'pattern' => 'printable_footer__', - 'variables' => [], - 'path' => $module_path . '/templates', - ], - 'printable_pdf_header' => [ - 'template' => 'printable-header', - 'pattern' => 'printable_header__', - 'variables' => [], - 'path' => $module_path . '/templates', - ], - ]; + return \Drupal::service(PrintablePdfHooks::class)->theme(); } diff --git a/modules/printable_pdf/printable_pdf.services.yml b/modules/printable_pdf/printable_pdf.services.yml new file mode 100644 index 0000000..60dbcec --- /dev/null +++ b/modules/printable_pdf/printable_pdf.services.yml @@ -0,0 +1,5 @@ + +services: + Drupal\printable_pdf\Hook\PrintablePdfHooks: + class: Drupal\printable_pdf\Hook\PrintablePdfHooks + autowire: true diff --git a/modules/printable_pdf/src/Hook/PrintablePdfHooks.php b/modules/printable_pdf/src/Hook/PrintablePdfHooks.php new file mode 100644 index 0000000..27a803c --- /dev/null +++ b/modules/printable_pdf/src/Hook/PrintablePdfHooks.php @@ -0,0 +1,38 @@ +getPath('printable_pdf'); + return [ + 'printable_pdf_footer' => [ + 'template' => 'printable-footer', + 'pattern' => 'printable_footer__', + 'variables' => [], + 'path' => $module_path . '/templates', + ], + 'printable_pdf_header' => [ + 'template' => 'printable-header', + 'pattern' => 'printable_header__', + 'variables' => [], + 'path' => $module_path . '/templates', + ], + ]; + } + +} diff --git a/printable.install b/printable.install index 0c4a336..6e947ca 100644 --- a/printable.install +++ b/printable.install @@ -1,5 +1,12 @@ t('The Printable module depends on the @library library. Please install the library (eg using composer) and then enable this module.', [ '@library' => "wa72/htmlpagedom", ]), - 'severity' => REQUIREMENT_ERROR, + 'severity' => DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.2.0', fn() => RequirementSeverity::Error, fn() => REQUIREMENT_ERROR), ]; } return $requirements; @@ -63,7 +70,6 @@ function printable_update_9002() { } } - /** * Ensure link extractor option is valid. */ diff --git a/printable.module b/printable.module index 0cc55e6..5f1bef8 100755 --- a/printable.module +++ b/printable.module @@ -5,6 +5,8 @@ * Provides printer friendly content entities. */ +use Drupal\Core\Hook\Attribute\LegacyHook; +use Drupal\printable\Hook\PrintableHooks; use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Routing\RouteMatchInterface; @@ -20,91 +22,25 @@ if (file_exists($autoload)) { /** * Implements hook_help(). */ +#[LegacyHook] function printable_help($route_name, RouteMatchInterface $route_match) { - if ($route_name !== 'help.page.printable') { - return; - } - - return t(' -

Introduction

-

This module allows you to generate the following printer-friendly versions of any node:
-

- where nid is the node id of content to render.) -

-

Installation

-

This will simplify a lot once https://www.drupal.org/project/drupal/issues/2494073 - is fixed:
-

-

' - ); + return \Drupal::service(PrintableHooks::class)->help($route_name, $route_match); } /** * Implements hook_permission(). */ +#[LegacyHook] function printable_permission() { - return [ - 'view printer friendly versions' => [ - 'title' => t('View Printer Friendly Versions'), - ], - 'administer printable' => [ - 'title' => t('Administer Printable'), - ], - ]; + return \Drupal::service(PrintableHooks::class)->permission(); } /** * Implements hook_theme(). */ +#[LegacyHook] function printable_theme() { - $module_path = \Drupal::service('extension.list.module')->getPath('printable'); - return [ - 'printable_navigation' => [ - 'variables' => ['printable_link' => NULL], - ], - 'printable' => [ - 'template' => 'printable', - 'pattern' => 'printable__', - 'variables' => [ - 'header' => NULL, - 'content' => NULL, - 'footer' => NULL, - ], - 'path' => $module_path . '/templates', - ], - 'printable_header' => [ - 'template' => 'printable-header', - 'pattern' => 'printable_header__', - 'variables' => [ - 'logo_url' => NULL, - ], - 'path' => $module_path . '/templates', - ], - 'printable_footer' => [ - 'template' => 'printable-footer', - 'pattern' => 'printable_footer__', - 'variables' => [ - 'footer_links' => [], - ], - 'path' => $module_path . '/templates', - ], - ]; + return \Drupal::service(PrintableHooks::class)->theme(); } /** @@ -193,50 +129,9 @@ function printable_entity_view_mode_info_alter(&$view_modes) { /** * Implements hook_entity_view(). */ +#[LegacyHook] function printable_entity_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode) { - - $config = \Drupal::config('printable.settings'); - $renderer = \Drupal::service('renderer'); - - // No need to add a dependency on user.permissions for the access control - // below - it's already in the cache contexts. - $renderer->addCacheableDependency($build, $config); - $printable_manager = \Drupal::service('printable.entity_manager'); - $link_builder = \Drupal::service('printable.link_builder'); - if ($printable_manager->isPrintableEntity($entity) && !empty($entity->id())) { - $print_setting = $config->get('printable_print_link_locations'); - $pdf_setting = $config->get('printable_pdf_link_locations'); - // Get the name of entity over here. - $entity_name = $printable_manager->getEntityName($entity); - $printable_navigation = [ - '#theme' => 'links__entity__printable', - '#links' => $link_builder->buildLinks($entity, $view_mode), - '#attributes' => [ - 'class' => ['pre_links'], - ], - '#access' => \Drupal::currentUser()->hasPermission('view printer friendly versions'), - ]; - if (!in_array($entity_name, $print_setting)) { - unset($printable_navigation['#links']['print']); - } - - $pdf_library = (string) $config->get('pdf_tool'); - if (!$pdf_library || !in_array($entity_name, $pdf_setting)) { - unset($printable_navigation['#links']['pdf']); - } - - // Add the build links to the entity being rendered. - $build['printable_navigation'] = [ - '#markup' => '
' . $renderer->render($printable_navigation) . '
', - '#attached' => [ - 'library' => ['printable/entity-links'], - ], - '#weight' => 100, - '#cache' => [ - 'tags' => $entity->getEntityType()->getListCacheTags(), - ], - ]; - } + \Drupal::service(PrintableHooks::class)->entityView($build, $entity, $display, $view_mode); } /** @@ -313,21 +208,7 @@ function printable_link_alter(array &$link) { /** * Implements hook_theme_suggestions_alter(). */ +#[LegacyHook] function printable_theme_suggestions_alter(array &$suggestions, array $variables, $hook) { - - if (!printable_preparing_content()) { - return; - } - - $originalCount = count($suggestions); - for ($i = 0; $i < $originalCount; $i++) { - if (str_ends_with($suggestions[$i], '__printable')) { - continue; - } - - $possibility = $suggestions[$i] . '__printable'; - if (!in_array($possibility, $suggestions)) { - $suggestions[] = $possibility; - } - } + \Drupal::service(PrintableHooks::class)->themeSuggestionsAlter($suggestions, $variables, $hook); } diff --git a/printable.services.yml b/printable.services.yml index 9ffdc43..2f6c962 100644 --- a/printable.services.yml +++ b/printable.services.yml @@ -31,3 +31,7 @@ services: printable.controller: class: Drupal\printable\Controller\PrintableController arguments: ['@printable.format_plugin_manager', '@printable.entity_manager'] + + Drupal\printable\Hook\PrintableHooks: + class: Drupal\printable\Hook\PrintableHooks + autowire: true diff --git a/src/Hook/PrintableHooks.php b/src/Hook/PrintableHooks.php new file mode 100644 index 0000000..90e32d6 --- /dev/null +++ b/src/Hook/PrintableHooks.php @@ -0,0 +1,180 @@ +t(' +

Introduction

+

This module allows you to generate the following printer-friendly versions of any node:
+

+ where nid is the node id of content to render.) +

+

Installation

+

This will simplify a lot once https://www.drupal.org/project/drupal/issues/2494073 + is fixed:
+

+

'); + } + + /** + * Implements hook_permission(). + */ + #[Hook('permission')] + public function permission() { + return [ + 'view printer friendly versions' => [ + 'title' => $this->t('View Printer Friendly Versions'), + ], + 'administer printable' => [ + 'title' => $this->t('Administer Printable'), + ], + ]; + } + + /** + * Implements hook_theme(). + */ + #[Hook('theme')] + public function theme() { + $module_path = \Drupal::service('extension.list.module')->getPath('printable'); + return [ + 'printable_navigation' => [ + 'variables' => [ + 'printable_link' => NULL, + ], + ], + 'printable' => [ + 'template' => 'printable', + 'pattern' => 'printable__', + 'variables' => [ + 'header' => NULL, + 'content' => NULL, + 'footer' => NULL, + ], + 'path' => $module_path . '/templates', + ], + 'printable_header' => [ + 'template' => 'printable-header', + 'pattern' => 'printable_header__', + 'variables' => [ + 'logo_url' => NULL, + ], + 'path' => $module_path . '/templates', + ], + 'printable_footer' => [ + 'template' => 'printable-footer', + 'pattern' => 'printable_footer__', + 'variables' => [ + 'footer_links' => [], + ], + 'path' => $module_path . '/templates', + ], + ]; + } + + /** + * Implements hook_entity_view(). + */ + #[Hook('entity_view')] + public function entityView(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode) { + $config = \Drupal::config('printable.settings'); + $renderer = \Drupal::service('renderer'); + // No need to add a dependency on user.permissions for the access control + // below - it's already in the cache contexts. + $renderer->addCacheableDependency($build, $config); + $printable_manager = \Drupal::service('printable.entity_manager'); + $link_builder = \Drupal::service('printable.link_builder'); + if ($printable_manager->isPrintableEntity($entity) && !empty($entity->id())) { + $print_setting = $config->get('printable_print_link_locations'); + $pdf_setting = $config->get('printable_pdf_link_locations'); + // Get the name of entity over here. + $entity_name = $printable_manager->getEntityName($entity); + $printable_navigation = [ + '#theme' => 'links__entity__printable', + '#links' => $link_builder->buildLinks($entity, $view_mode), + '#attributes' => [ + 'class' => [ + 'pre_links', + ], + ], + '#access' => \Drupal::currentUser()->hasPermission('view printer friendly versions'), + ]; + if (!in_array($entity_name, $print_setting)) { + unset($printable_navigation['#links']['print']); + } + $pdf_library = (string) $config->get('pdf_tool'); + if (!$pdf_library || !in_array($entity_name, $pdf_setting)) { + unset($printable_navigation['#links']['pdf']); + } + // Add the build links to the entity being rendered. + $build['printable_navigation'] = [ + '#markup' => '
' . $renderer->render($printable_navigation) . '
', + '#attached' => [ + 'library' => [ + 'printable/entity-links', + ], + ], + '#weight' => 100, + '#cache' => [ + 'tags' => $entity->getEntityType()->getListCacheTags(), + ], + ]; + } + } + + /** + * Implements hook_theme_suggestions_alter(). + */ + #[Hook('theme_suggestions_alter')] + public function themeSuggestionsAlter(array &$suggestions, array $variables, $hook) { + if (!printable_preparing_content()) { + return; + } + $originalCount = count($suggestions); + for ($i = 0; $i < $originalCount; $i++) { + if (str_ends_with($suggestions[$i], '__printable')) { + continue; + } + $possibility = $suggestions[$i] . '__printable'; + if (!in_array($possibility, $suggestions)) { + $suggestions[] = $possibility; + } + } + } + +} diff --git a/src/Plugin/PrintableFormatBase.php b/src/Plugin/PrintableFormatBase.php index 38bfffb..128737e 100644 --- a/src/Plugin/PrintableFormatBase.php +++ b/src/Plugin/PrintableFormatBase.php @@ -2,6 +2,8 @@ namespace Drupal\printable\Plugin; +use Drupal\Component\Utility\DeprecationHelper; +use Drupal\Core\Extension\ThemeSettingsProvider; use Drupal\Core\Config\ConfigFactoryInterface; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Form\FormStateInterface; @@ -205,7 +207,7 @@ abstract class PrintableFormatBase extends PluginBase implements PrintableFormat 'printable_header__' . $this->getPluginId(), 'printable_header', ], - '#logo_url' => theme_get_setting('logo.url'), + '#logo_url' => DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.3.0', fn() => \Drupal::service(ThemeSettingsProvider::class)->getSetting('logo.url'), fn() => theme_get_setting('logo.url')), ], '#content' => $this->content, '#footer' => [ diff --git a/src/Routing/RouteSubscriber.php b/src/Routing/RouteSubscriber.php index 9ebf333..0f7fc80 100644 --- a/src/Routing/RouteSubscriber.php +++ b/src/Routing/RouteSubscriber.php @@ -33,7 +33,7 @@ class RouteSubscriber implements EventSubscriberInterface { /** * {@inheritdoc} */ - public static function getSubscribedEvents() { + public static function getSubscribedEvents(): array { $events[RoutingEvents::ALTER] = 'routes'; return $events; } diff --git a/src/Tests/PrintableBlockTest.php b/src/Tests/PrintableBlockTest.php index 537e56a..c62f2d0 100644 --- a/src/Tests/PrintableBlockTest.php +++ b/src/Tests/PrintableBlockTest.php @@ -2,6 +2,7 @@ namespace Drupal\printable\Tests; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\node\Functional\NodeTestBase; use Drupal\block\Entity\Block; @@ -11,6 +12,7 @@ use PHPUnit\Framework\Attributes\Group; * Tests the blocks present in printable module. */ #[Group('Printable')] +#[RunTestsInSeparateProcesses] class PrintableBlockTest extends NodeTestBase { use StringTranslationTrait; diff --git a/src/Tests/PrintableFormTest.php b/src/Tests/PrintableFormTest.php index a3624d2..f83bb97 100644 --- a/src/Tests/PrintableFormTest.php +++ b/src/Tests/PrintableFormTest.php @@ -2,6 +2,7 @@ namespace Drupal\printable\Tests; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\BrowserTestBase; use PHPUnit\Framework\Attributes\Group; @@ -10,6 +11,7 @@ use PHPUnit\Framework\Attributes\Group; * Tests the printable module functionality. */ #[Group('Printable')] +#[RunTestsInSeparateProcesses] class PrintableFormTest extends BrowserTestBase { use StringTranslationTrait; diff --git a/src/Tests/PrintableLinkTest.php b/src/Tests/PrintableLinkTest.php index 87a4fae..331c08a 100644 --- a/src/Tests/PrintableLinkTest.php +++ b/src/Tests/PrintableLinkTest.php @@ -2,6 +2,7 @@ namespace Drupal\printable\Tests; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\node\Functional\NodeTestBase; use PHPUnit\Framework\Attributes\Group; @@ -10,6 +11,7 @@ use PHPUnit\Framework\Attributes\Group; * Tests the printable module functionality. */ #[Group('Printable')] +#[RunTestsInSeparateProcesses] class PrintableLinkTest extends NodeTestBase { use StringTranslationTrait; diff --git a/src/Tests/PrintablePageTest.php b/src/Tests/PrintablePageTest.php index 12a5a17..e204e1c 100644 --- a/src/Tests/PrintablePageTest.php +++ b/src/Tests/PrintablePageTest.php @@ -2,6 +2,9 @@ namespace Drupal\printable\Tests; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; +use Drupal\Component\Utility\DeprecationHelper; +use Drupal\Core\Extension\ThemeSettingsProvider; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\node\Functional\NodeTestBase; use PHPUnit\Framework\Attributes\Group; @@ -10,6 +13,7 @@ use PHPUnit\Framework\Attributes\Group; * Tests the printable module functionality. */ #[Group('Printable')] +#[RunTestsInSeparateProcesses] class PrintablePageTest extends NodeTestBase { @@ -80,7 +84,7 @@ class PrintablePageTest extends NodeTestBase { // Checks the presence of header in the page. $this->assertSession()->responseContains($edit['title[0][value]']); // Checks the presence of image in the header. - $this->assertSession()->responseContains(theme_get_setting('logo.url')); + $this->assertSession()->responseContains(DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.3.0', fn() => \Drupal::service(ThemeSettingsProvider::class)->getSetting('logo.url'), fn() => theme_get_setting('logo.url'))); // Checks the presence of body in the page. $this->assertSession()->responseContains($edit['body[0][value]']); // Check if footer is rendering correctly. diff --git a/src/Tests/PrintablePdfFormTest.php b/src/Tests/PrintablePdfFormTest.php index d161c60..3df84c0 100644 --- a/src/Tests/PrintablePdfFormTest.php +++ b/src/Tests/PrintablePdfFormTest.php @@ -2,6 +2,7 @@ namespace Drupal\printable\Tests; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\BrowserTestBase; use PHPUnit\Framework\Attributes\Group; @@ -10,6 +11,7 @@ use PHPUnit\Framework\Attributes\Group; * Tests the printable module functionality. */ #[Group('Printable')] +#[RunTestsInSeparateProcesses] class PrintablePdfFormTest extends BrowserTestBase { use StringTranslationTrait; diff --git a/src/Tests/PrintablePdfTest.php b/src/Tests/PrintablePdfTest.php index 1130245..60e0cc8 100644 --- a/src/Tests/PrintablePdfTest.php +++ b/src/Tests/PrintablePdfTest.php @@ -2,6 +2,7 @@ namespace Drupal\printable\Tests; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\node\Functional\NodeTestBase; use Drupal\node\NodeInterface; @@ -12,6 +13,7 @@ use Smalot\PdfParser\Parser; * Tests the printable_pdf module functionality. */ #[Group('Printable')] +#[RunTestsInSeparateProcesses] class PrintablePdfTest extends NodeTestBase { use StringTranslationTrait; diff --git a/src/Tests/PrintableUninstallTest.php b/src/Tests/PrintableUninstallTest.php index 7277c21..77de933 100644 --- a/src/Tests/PrintableUninstallTest.php +++ b/src/Tests/PrintableUninstallTest.php @@ -2,6 +2,7 @@ namespace Drupal\printable\Tests; +use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use Drupal\Core\StringTranslation\StringTranslationTrait; use Drupal\Tests\node\Functional\NodeTestBase; use Drupal\node\NodeInterface; @@ -11,6 +12,7 @@ use PHPUnit\Framework\Attributes\Group; * Tests the whether printable module uninstall successfully. */ #[Group('Printable')] +#[RunTestsInSeparateProcesses] class PrintableUninstallTest extends NodeTestBase { use StringTranslationTrait;