SU-SWS/stanford_fields

<?php
 
namespace Drupal\stanford_fields\Service;
 
use Drupal\book\BookManagerInterface;
use Drupal\Component\Utility\NestedArray;
use Drupal\Component\Utility\SortArray;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Access\AccessResultInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\node\NodeInterface;
use Drupal\stanford_fields\Event\BookOutlineUpdatedEvent;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
/**
 * Book manager service decorator.
 */
The class StanfordFieldsBookManager has 18 public methods. Consider refactoring StanfordFieldsBookManager to keep number of public methods under 10.
`StanfordFieldsBookManager` has 27 functions (exceeds 25 allowed). Consider refactoring.
class StanfordFieldsBookManager implements BookManagerInterface {
 
  use StringTranslationTrait;
 
  /**
   * Decorated service constructor.
   *
   * @param \Drupal\book\BookManagerInterface $bookManager
   *   Original book manager service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   Config factory service.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher
   *   Event dispatcher service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager service.
   */
`syntax error, unexpected 'protected' (T_PROTECTED), expecting variable (T_VARIABLE)`
  public function __construct(protected BookManagerInterface $bookManager, protected ConfigFactoryInterface $configFactory, protected EventDispatcherInterface $eventDispatcher, protected EntityTypeManagerInterface $entityTypeManager) {}
 
  /**
   * {@inheritdoc}
   */
  public function bookTreeAllData(int $bid, ?array $link = NULL, ?int $max_depth = NULL, ?int $min_depth = NULL): array {
    return $this->bookManager->bookTreeAllData($bid, $link, $max_depth, $min_depth);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function getActiveTrailIds(string $bid, array $link): array {
    return $this->bookManager->getActiveTrailIds($bid, $link);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function loadBookLink(int $nid, bool $translate = TRUE): array {
    return $this->bookManager->loadBookLink($nid, $translate);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function loadBookLinks(array $nids, bool $translate = TRUE): array {
    return $this->bookManager->loadBookLinks($nids, $translate);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
Expected 1 space before "|"; 0 found
Expected 1 space after "|"; 0 found
  public function getTableOfContents(int|string $bid, int $depth_limit, array $exclude = [], bool $truncate = TRUE): array {
    return $this->bookManager->getTableOfContents($bid, $depth_limit, $exclude, $truncate);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function getParentDepthLimit(array $book_link): int {
    return $this->bookManager->getParentDepthLimit($book_link);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function bookTreeCollectNodeLinks(array &$tree, array &$node_links): void {
    $this->bookManager->bookTreeCollectNodeLinks($tree, $node_links);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function bookLinkTranslate(array &$link): array {
    return $this->bookManager->bookLinkTranslate($link);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function bookTreeGetFlat(array $book_link): array {
    return $this->bookManager->bookTreeGetFlat($book_link);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function getAllBooks(): array {
    return $this->bookManager->getAllBooks();
  }
 
  /**
   * {@inheritdoc}
   */
Function `updateOutline` has a Cognitive Complexity of 14 (exceeds 10 allowed). Consider refactoring.
  public function updateOutline(NodeInterface $node): bool {
    if (isset($node->book['weight'])) {
      // Before saving the node, look at the book weight data . The weight has
      // to be an integer, but we also have to adjust the weights of the sibling
      // book items so that they all stay in proper order.
      if (is_array($node->book['weight'])) {
        // Remove the parent ID from the keys in the weight data.
        $weights = $node->book['weight'];
        foreach ($weights as $key => $weight) {
Variable $nid is undefined.
          [, $nid] = explode(':', $key);
Variable $nid is undefined.
          $weights[$nid] = $weight;
          unset($weights[$key]);
        }
 
        // New nodes use the key 'new'. At this point trying to use
        // $node->isNew() doesn't work because the database transactions have
        // been scheduled and the node has an id value.
        $key = array_key_exists('new', $weights) ? 'new' : $node->id();
 
        // Loop through the sibling book links and adjust their weights.
        foreach ($weights as $nid => $weight) {
          if ($nid == $key) {
            continue;
          }
          $book_link = $this->loadBookLink($nid);
          $book_link['weight'] = $weight['weight'];
          $this->saveBookLink($book_link, FALSE);
        }
 
        // Finally set the weight of the current node to it's submitted value.
        $node->book['weight'] = $weights[$key]['weight'] ?? 0;
      }
      // Make sure there's always a number value in the weight. Empty strings
      // throw errors.
      $node->book['weight'] = $node->book['weight'] ?: 0;
    }
    $return = $this->bookManager->updateOutline($node);
    $this->eventDispatcher->dispatch(new BookOutlineUpdatedEvent($node), BookOutlineUpdatedEvent::OUTLINE_UPDATED);
    return $return;
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function saveBookLink(array $link, bool $new): array {
    return $this->bookManager->saveBookLink($link, $new);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
Expected 1 space before "|"; 0 found
Expected 1 space after "|"; 0 found
  public function getLinkDefaults(int|string $nid): array {
    return $this->bookManager->getLinkDefaults($nid);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function getBookParents(array $item, array $parent = []): array {
    return $this->bookManager->getBookParents($item, $parent);
  }
 
  /**
   * Is the given node allowed in books based on config settings.
   *
   * @param \Drupal\node\NodeInterface $node
   *   Node entity.
   *
   * @return bool
   *   If the given node can be added to books.
   */
  protected function nodeAllowedInBook(NodeInterface $node): bool {
    $allowed_types = $this->configFactory->get('book.settings')
      ->get('allowed_types');
    return in_array($node->getType(), $allowed_types);
  }
 
  /**
   * {@inheritdoc}
   */
Method `addFormElements` has 70 lines of code (exceeds 40 allowed). Consider refactoring.
The method addFormElements() has 100 lines of code. Current threshold is set to 100. Avoid really long methods.
  public function addFormElements(array $form, FormStateInterface $form_state, NodeInterface $node, AccountInterface $account, bool $collapsed = TRUE): array {
    // The book module will add the book settings to all node types for admins,
    // which makes it annoying. This checks the node against the settings
    // instead of only the 'administer book outlines' permission.
    // @see book_form_node_form_alter()
    if (!$this->nodeAllowedInBook($node)) {
      return $form;
    }
 
    // Prepare the form state before passing to the original service to add form
    // elements.
    if ($form_state->hasValue(['book', 'weight'])) {
      // During the AJAX call, the weight value is keyed array of other book
      // links. Extract the weight of the current node on this form so that the
      // original service can still use it normally.
      $weight_value = $form_state->getValue(['book', 'weight']);
      if (is_array($weight_value)) {
        $key = array_key_exists('new', $weight_value) ? 'new' : $node->id();
        $this_node_weight = NestedArray::getValue($weight_value, [
          $key,
          'weight',
        ]);
        $form_state->setValue(['book', 'weight'], $this_node_weight);
      }
      else {
        $form_state->setValue(['book', 'weight'], (int) $weight_value);
      }
    }
 
    // Call the original service to add the form parts.
    $form = $this->bookManager->addFormElements($form, $form_state, $node, $account, $collapsed);
 
    // Force the book details to be open, because after the ajax returns, the
    // field set closes.
    $form['book']['#open'] = TRUE;
    $form['book']['#prefix'] = '<div id="book-widget-wrapper">';
    $form['book']['#suffix'] = '</div>';
    // Override the book selection ajax callback so that we can return the whole
    // book portion, not just the parent selector.
    // @see book_form_update().
    $form['book']['bid']['#ajax']['callback'] = [self::class, 'bookSelected'];
    $form['book']['bid']['#ajax']['wrapper'] = 'book-widget-wrapper';
 
    // Add the ajax to the parent selector.
    $form['book']['pid']['#ajax'] = [
      'callback' => [self::class, 'parentChosen'],
      'wrapper' => 'book-item-reorder-wrapper',
    ];
 
    $form['book']['weight'] = [
      '#type' => 'table',
      '#header' => [
        'name' => t('Name'),
        'weight' => t('Weight'),
      ],
      '#prefix' => '<div id="book-item-reorder-wrapper">',
      '#suffix' => '</div>',
      '#id' => 'book-item-reorder',
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'book-item-weight',
        ],
      ],
      '#access' => FALSE,
    ];
 
    $parent_id = $this->getParentIdFromForm($form, $form_state);
 
    if (!$parent_id) {
      return $form;
    }
    $form['book']['weight']['#access'] = TRUE;
 
    foreach ($this->getSiblingBookItems($parent_id, $form['book']['nid']['#value']) as $nid => $link_data) {
      // To avoid the weight value to linger after the ajax finishes, use
      // different keys for each parent. That way when you change to a different
      // parent, the weight will all reset to proper order.
      $form['book']['weight']["$parent_id:$nid"] = [
        '#attributes' => [
          'class' => [
            'draggable',
          ],
        ],
        '#weight' => $link_data['weight'],
        'name' => ['#markup' => $link_data['title']],
        'weight' => [
          '#type' => 'weight',
          '#title' => t('Weight'),
          '#default_value' => $link_data['weight'],
          '#delta' => 50,
          '#title_display' => 'invisible',
          '#attributes' => ['class' => ['book-item-weight']],
        ],
      ];
    }
 
    return $form;
  }
 
  /**
   * Get book links that would be children of the parent id.
   *
   * @param int $parent_id
   *   Node ID.
   * @param int|string $current_nid
   *   Another Node ID to identify different links.
   *
   * @return array
   *   Keyed array of book link data.
   */
Expected 1 space before "|"; 0 found
Expected 1 space after "|"; 0 found
  protected function getSiblingBookItems(int $parent_id, int|string $current_nid): array {
    $parent_link = $this->loadBookLink($parent_id);
    if (!$parent_link) {
      return [];
    }
 
    $parent_subtree = $this->bookSubtreeData($parent_link);
 
    $parent_key = key($parent_subtree);
    $sibling_links = $parent_subtree[$parent_key]['below'] ?? [];
 
    $items = [];
    $adding_new_link = TRUE;
    $highest_weight = -50;
 
    foreach ($sibling_links as $sibling) {
      if ($sibling['link']['nid'] == $current_nid) {
        $adding_new_link = FALSE;
        $sibling['link']['title'] .= ' (' . $this->t('This Content') . ')';
      }
      $items[$sibling['link']['nid']] = $sibling['link'];
      $highest_weight = max($sibling['link']['weight'], $highest_weight);
    }
 
    if ($adding_new_link || $current_nid == 'new') {
      $items['new'] = [
        'weight' => $highest_weight + 1,
        'title' => $this->t('(This Content)'),
        'nid' => $current_nid,
      ];
    }
 
    uasort($items, [SortArray::class, 'sortByWeightElement']);
    return $items;
  }
 
  /**
   * Get the parent book item from the current form state.
   *
   * @param array $form
   *   Complete form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current state of the form.
   *
   * @return int|null
   *   Parent ID or null if none was found.
   */
  protected function getParentIdFromForm(array $form, FormStateInterface $form_state): ?int {
    // The book module uses -1 as it's indication that nothing was chosen.
    $parent_id = $form['book']['pid']['#default_value'] ?? -1;
 
    // If the form was submitted via ajax, grab the book id from the user input.
    $user_input = $form_state->getUserInput() ?: [];
    $parent_id = $parent_id != -1 ? $parent_id : NestedArray::getValue($user_input, [
      'book',
      'bid',
    ]);
 
    // As an extra check, if the parent item still hasn't been found, try to
    // fetch the parent id from the form state.
    if ($parent_id == -1 && $form_state->hasValue(['book', 'pid'])) {
      $parent_id = $form_state->getValue(['book', 'pid']);
    }
 
    return $parent_id >= 1 ? (int) $parent_id : NULL;
  }
 
  /**
   * Ajax callback when a book is selected.
   *
   * @param array $form
   *   Complete Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Ajaxed form state.
   *
   * @return array
   *   Modified book element.
   */
  public static function bookSelected(array &$form, FormStateInterface $form_state): array {
    return $form['book'];
  }
 
  /**
   * Ajax callback when a parent page is selected for the book.
   *
   * @param array $form
   *   Complete Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Ajaxed form state.
   *
   * @return array
   *   Modified weight element.
   */
  public static function parentChosen(array &$form, FormStateInterface $form_state): array {
    return $form['book']['weight'];
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function deleteFromBook(int $nid): void {
    $this->bookManager->deleteFromBook($nid);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function bookTreeOutput(array $tree): array {
    return $this->bookManager->bookTreeOutput($tree);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function bookTreeCheckAccess(array &$tree, array $node_links = []): void {
    $this->bookManager->bookTreeCheckAccess($tree, $node_links);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function bookSubtreeData(array $link): array {
    return $this->bookManager->bookSubtreeData($link);
  }
 
  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function checkNodeIsRemovable(NodeInterface $node): bool {
    return $this->bookManager->checkNodeIsRemovable($node);
  }
 
  /**
   * Check for access on the "Outline" book route.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Current account.
   * @param int $node
   *   Node entity id.
   *
   * @return \Drupal\Core\Access\AccessResultReasonInterface
   *   Resulting access.
   */
  public function checkBookOutlineAccess(AccountInterface $account, int $node): AccessResultInterface {
    $node = $this->entityTypeManager->getStorage('node')->load($node);
    if ($node && $this->nodeAllowedInBook($node)) {
      return AccessResult::allowedIfHasPermission($account, 'administer book outlines');
    }
    return AccessResult::forbidden();
  }
 
}