class HookFormAlter in Drupal 7 to 8/9 Module Upgrader 8

Plugin annotation

@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.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\drupalmoduleupgrader\PluginBase implements ContainerFactoryPluginInterface
      • class \Drupal\drupalmoduleupgrader\AnalyzerBase implements AnalyzerInterface
        • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Analyzer\HookFormAlter

File

src/Plugin/DMU/Analyzer/HookFormAlter.php, line 26

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Analyzer

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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AnalyzerBase::buildIssue	protected	function	Creates an issue with title, summary, documentation and tags pulled from the plugin definition.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
HookFormAlter::analyze	public	function	Analyzes a target module and flags any issues found. Overrides AnalyzerInterface::analyze
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$log	protected	property
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	11
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.