drupalmoduleupgrader-8.x-1.5/src/Plugin/DMU/Analyzer/HookFormAlter.php

<?php

namespace Drupal\drupalmoduleupgrader\Plugin\DMU\Analyzer;

use Drupal\drupalmoduleupgrader\AnalyzerBase;
use Drupal\drupalmoduleupgrader\TargetInterface;
use Pharborist\Filter;
use Pharborist\Functions\FunctionDeclarationNode;

/**
 * @Analyzer(
 *  id = "hook_form_alter",
 *  description = @Translation("Checks for outdated hook_form_alter() implementations."),
 *  documentation = {
 *    {
 *      "url" = "https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21form.api.php/function/hook_form_alter/8",
 *      "title" = @Translation("`hook_form_alter()` documentation")
 *    }
 *  },
 *  tags = {
 *    "category" = { "form" }
 *  },
 *  message = @Translation("The signature of hook_form_alter() has changed in Drupal 8.")
 * )
 */
class HookFormAlter extends AnalyzerBase {

  /**
   * {@inheritdoc}
   */
  public function analyze(TargetInterface $target) {
    $violations = [];

    $indexer = $target->getIndexer('function');
    if ($indexer->has('hook_form_alter')) {
      $violations[] = $indexer->get('hook_form_alter');
    }

    $query = $target
      ->getIndexer('function')
      ->getQuery();
    $alter_hooks = $query
      ->condition('id', $query->escapeLike($target->id() . '_form_') . '%' . $query->escapeLike('_alter'), 'LIKE')
      ->execute();

    foreach ($alter_hooks as $alter_hook) {
      $violations[] = $target
        ->open($alter_hook->file)
        ->find(Filter::isFunction($alter_hook->id))
        ->get(0);
    }

    $issues = [];

    if ($violations) {
      $issue = $this->buildIssue($target);
      array_walk($violations, function (FunctionDeclarationNode $function) use ($issue) {
        $issue->addViolation($function, $this);
      });
      $issues[] = $issue;
    }

    return $issues;
  }

}