From 3402c897c484cc3a2f3a1cfa344242c1c2d56b25 Mon Sep 17 00:00:00 2001
From: Mikkel Ricky <rimi@aarhus.dk>
Date: Thu, 15 Apr 2021 14:45:43 +0200
Subject: [PATCH] LOOP-844: Updated doc blocks

---
 .../modules/os2loop_documents/os2loop_documents.module |  6 ++++++
 .../os2loop_documents/src/Helper/FormHelper.php        |  5 +++++
 .../os2loop_documents/src/Helper/NodeHelper.php        |  5 +++++
 .../modules/os2loop_search_db/os2loop_search_db.module |  2 ++
 .../src/Helper/SearchApiAutocompleteHelper.php         |  3 +++
 .../modules/os2loop_upvote/os2loop_upvote.module       |  6 ++++++
 web/profiles/custom/os2loop/os2loop.profile            | 10 ++++++++++
 web/profiles/custom/os2loop/src/Helper/Helper.php      | 10 ++++++++++
 8 files changed, 47 insertions(+)

diff --git a/web/profiles/custom/os2loop/modules/os2loop_documents/os2loop_documents.module b/web/profiles/custom/os2loop/modules/os2loop_documents/os2loop_documents.module
index 14503f7c6..94333491a 100644
--- a/web/profiles/custom/os2loop/modules/os2loop_documents/os2loop_documents.module
+++ b/web/profiles/custom/os2loop/modules/os2loop_documents/os2loop_documents.module
@@ -27,6 +27,8 @@ function os2loop_documents_help($route_name, RouteMatchInterface $route_match) {
 
 /**
  * Implements hook_form_BASE_FORM_ID_alter().
+ *
+ * @see \Drupal\os2loop_documents\Helper\FormHelper::alterForm()
  */
 function os2loop_documents_form_node_form_alter(array &$form, FormStateInterface $form_state, $form_id) {
   // @todo We should use hook_event_dispatcher for this
@@ -36,6 +38,8 @@ function os2loop_documents_form_node_form_alter(array &$form, FormStateInterface
 
 /**
  * Implements hook_ENTITY_TYPE_update().
+ *
+ * @see \Drupal\os2loop_documents\Helper\NodeHelper::updateNode()
  */
 function os2loop_documents_node_update(EntityInterface $entity) {
   \Drupal::service('os2loop_documents.node_helper')->updateNode($entity);
@@ -43,6 +47,8 @@ function os2loop_documents_node_update(EntityInterface $entity) {
 
 /**
  * Implements hook_preprocess_HOOK().
+ *
+ * @see \Drupal\os2loop_documents\Helper\NodeHelper::preprocessNode()
  */
 function os2loop_documents_preprocess_node(array &$variables) {
   \Drupal::service('os2loop_documents.node_helper')->preprocessNode($variables);
diff --git a/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/FormHelper.php b/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/FormHelper.php
index 5c27dfb27..a266c279f 100644
--- a/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/FormHelper.php
+++ b/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/FormHelper.php
@@ -81,6 +81,11 @@ public function __construct(CollectionHelper $collectionHelper, RendererInterfac
 
   /**
    * Implements hook_form_BASE_FORM_ID_alter().
+   *
+   * Hides legacy body field on non-legacy documents (cf.
+   * self::isLegacyDocument).
+   *
+   * Insert UI for adding documents to a collection.
    */
   public function alterForm(array &$form, FormStateInterface $formState, string $formId) {
     switch ($formId) {
diff --git a/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/NodeHelper.php b/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/NodeHelper.php
index 613ead09e..0bba38d2f 100644
--- a/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/NodeHelper.php
+++ b/web/profiles/custom/os2loop/modules/os2loop_documents/src/Helper/NodeHelper.php
@@ -64,6 +64,11 @@ public function updateNode(NodeInterface $node) {
 
   /**
    * Implements hook_preprocess_HOOK().
+   *
+   * Adds collection table of contents to collection and document views.
+   *
+   * Adds list of collections to document view (when document is in more than
+   * one colletion).
    */
   public function preprocessNode(array &$variables) {
     /** @var \Drupal\node\NodeInterface $node */
diff --git a/web/profiles/custom/os2loop/modules/os2loop_search_db/os2loop_search_db.module b/web/profiles/custom/os2loop/modules/os2loop_search_db/os2loop_search_db.module
index 2aafa678d..4a142ec95 100644
--- a/web/profiles/custom/os2loop/modules/os2loop_search_db/os2loop_search_db.module
+++ b/web/profiles/custom/os2loop/modules/os2loop_search_db/os2loop_search_db.module
@@ -25,6 +25,8 @@ function os2loop_search_db_help($route_name, RouteMatchInterface $route_match) {
 
 /**
  * Implements hook_search_api_autocomplete_suggestions_alter().
+ *
+ * @see \Drupal\os2loop_search_db\Helper\SearchApiAutocompleteHelper::alterSuggestions()
  */
 function os2loop_search_db_search_api_autocomplete_suggestions_alter(array &$suggestions, array $alter_params) {
   $helper = \Drupal::service('os2loop_search_db.search_api_autocomplete_helper');
diff --git a/web/profiles/custom/os2loop/modules/os2loop_search_db/src/Helper/SearchApiAutocompleteHelper.php b/web/profiles/custom/os2loop/modules/os2loop_search_db/src/Helper/SearchApiAutocompleteHelper.php
index fb8e7f2ff..5ad23773c 100644
--- a/web/profiles/custom/os2loop/modules/os2loop_search_db/src/Helper/SearchApiAutocompleteHelper.php
+++ b/web/profiles/custom/os2loop/modules/os2loop_search_db/src/Helper/SearchApiAutocompleteHelper.php
@@ -15,6 +15,9 @@ class SearchApiAutocompleteHelper {
 
   /**
    * Implements hook_search_api_autocomplete_suggestions_alter().
+   *
+   * Adds a suggestion, "See all results for …", linking to the full search
+   * result for the current query.
    */
   public function alterSuggestions(array &$suggestions, array $alter_params) {
     /** @var string $user_input */
diff --git a/web/profiles/custom/os2loop/modules/os2loop_upvote/os2loop_upvote.module b/web/profiles/custom/os2loop/modules/os2loop_upvote/os2loop_upvote.module
index b6db2741f..4d45872e7 100644
--- a/web/profiles/custom/os2loop/modules/os2loop_upvote/os2loop_upvote.module
+++ b/web/profiles/custom/os2loop/modules/os2loop_upvote/os2loop_upvote.module
@@ -7,6 +7,8 @@
 
 /**
  * Implements hook_preprocess_flag().
+ *
+ * @see \Drupal\os2loop_upvote\Helper\FlagHelper::preprocessFlag()
  */
 function os2loop_upvote_preprocess_flag(array &$variables) {
   Drupal::service('os2loop_upvote.flag_helper')->preprocessFlag($variables);
@@ -14,6 +16,8 @@ function os2loop_upvote_preprocess_flag(array &$variables) {
 
 /**
  * Implements hook_preprocess_field().
+ *
+ * @see \Drupal\os2loop_upvote\Helper\FlagHelper::preprocessField()
  */
 function os2loop_upvote_preprocess_field(array &$variables, $hook) {
   Drupal::service('os2loop_upvote.flag_helper')->preprocessField($variables);
@@ -21,6 +25,8 @@ function os2loop_upvote_preprocess_field(array &$variables, $hook) {
 
 /**
  * Implements hook_preprocess_comment().
+ *
+ * @see \Drupal\os2loop_upvote\Helper\FlagHelper::preprocessComment()
  */
 function os2loop_upvote_preprocess_comment(array &$variables) {
   Drupal::service('os2loop_upvote.flag_helper')->preprocessComment($variables);
diff --git a/web/profiles/custom/os2loop/os2loop.profile b/web/profiles/custom/os2loop/os2loop.profile
index b615b27d8..b08e45bed 100644
--- a/web/profiles/custom/os2loop/os2loop.profile
+++ b/web/profiles/custom/os2loop/os2loop.profile
@@ -13,6 +13,8 @@ use Drupal\Core\Form\FormStateInterface;
 
 /**
  * Implements hook_entity_create_access().
+ *
+ * @see Helper::entityCreateAccess()
  */
 function os2loop_entity_create_access(AccountInterface $account, array $context, $entity_bundle) {
   return Drupal::service(Helper::class)->entityCreateAccess($account, $context, $entity_bundle);
@@ -20,6 +22,8 @@ function os2loop_entity_create_access(AccountInterface $account, array $context,
 
 /**
  * Implements hook_node_access().
+ *
+ * @see Helper::nodeAccess()
  */
 function os2loop_node_access(NodeInterface $node, $op, AccountInterface $account) {
   return Drupal::service(Helper::class)->nodeAccess($node, $op, $account);
@@ -27,6 +31,8 @@ function os2loop_node_access(NodeInterface $node, $op, AccountInterface $account
 
 /**
  * Implements hook_form_alter().
+ *
+ * @see Helper::formAlter()
  */
 function os2loop_form_alter(&$form, FormStateInterface $form_state, $form_id) {
   return Drupal::service(Helper::class)->formAlter($form, $form_state, $form_id);
@@ -34,6 +40,8 @@ function os2loop_form_alter(&$form, FormStateInterface $form_state, $form_id) {
 
 /**
  * Implements hook_preprocess_node().
+ *
+ * @see Helper::preprocessNode()
  */
 function os2loop_preprocess_node(array &$variables) {
   return Drupal::service(Helper::class)->preprocessNode($variables);
@@ -41,6 +49,8 @@ function os2loop_preprocess_node(array &$variables) {
 
 /**
  * Implements hook_block_access().
+ *
+ * @see Helper::blockAccess()
  */
 function os2loop_block_access(Block $block, $operation, AccountInterface $account) {
   return Drupal::service(Helper::class)->blockAccess($block, $operation, $account);
diff --git a/web/profiles/custom/os2loop/src/Helper/Helper.php b/web/profiles/custom/os2loop/src/Helper/Helper.php
index 542fb58df..7e4efa607 100644
--- a/web/profiles/custom/os2loop/src/Helper/Helper.php
+++ b/web/profiles/custom/os2loop/src/Helper/Helper.php
@@ -30,6 +30,8 @@ public function __construct(ConfigFactoryInterface $configFactory) {
 
   /**
    * Implements hook_entity_create_access().
+   *
+   * Checks if a node type is enabled (cf self::contentTypeAccess()).
    */
   public function entityCreateAccess(AccountInterface $account, array $context, $entity_bundle): AccessResult {
     if ('node' === $context['entity_type_id']) {
@@ -41,6 +43,8 @@ public function entityCreateAccess(AccountInterface $account, array $context, $e
 
   /**
    * Implements hook_node_access().
+   *
+   * Checks if a node type is enabled (cf self::contentTypeAccess()).
    */
   public function nodeAccess(NodeInterface $node, $op, AccountInterface $account): AccessResult {
     return $this->contentTypeAccess($node->bundle());
@@ -48,6 +52,8 @@ public function nodeAccess(NodeInterface $node, $op, AccountInterface $account):
 
   /**
    * Implements hook_form_alter().
+   *
+   * Hides field for disabled taxonomies from a form.
    */
   public function formAlter(&$form, FormStateInterface $form_state, $form_id) {
     $this->hideTaxonomyVocabularies($form);
@@ -55,6 +61,8 @@ public function formAlter(&$form, FormStateInterface $form_state, $form_id) {
 
   /**
    * Implements hook_preprocess_node().
+   *
+   * Hides disabled taxonomies from a node.
    */
   public function preprocessNode(array &$variables) {
     if (isset($variables['content'])) {
@@ -67,6 +75,8 @@ public function preprocessNode(array &$variables) {
 
   /**
    * Implements hook_block_access().
+   *
+   * Hides disabled blocks.
    */
   public function blockAccess(Block $block, $operation, AccountInterface $account) {
     if ('view' === $operation) {