You are here

Home » API reference » Drupal 7 to 8/9 Module Upgrader 8 » HookEntityInfo.php

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

Plugin annotation


@Converter(
 id = "hook_entity_info",
 description = @Translation("Creates entity class boilerplate from hook_entity_info()."),
 hook = "hook_entity_info"
)

Hierarchy

Expanded class hierarchy of HookEntityInfo

File

src/Plugin/DMU/Converter/HookEntityInfo.php, line 17

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter
View source 
class HookEntityInfo extends ConverterBase {
  use StringTransformTrait;

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target) {
    try {
      $entity_types = $this
        ->executeHook($target, 'entity_info');
    } catch (\LogicException $e) {
      $this->log
        ->warning($e
        ->getMessage(), [
        'target' => $target
          ->id(),
        'hook' => $this->pluginDefinition['hook'],
      ]);
      return;
    }
    foreach ($entity_types as $id => $entity_type) {
      $entity_type['id'] = $id;
      $entity_type['base_table'] = $entity_type['base table'];
      unset($entity_type['base table']);
      $entity_type['keys'] = $entity_type['entity keys'];
      unset($entity_type['entity keys']);
      if (isset($entity_type['controller class'])) {

        /** @var \Pharborist\Objects\ClassNode $controller */
        $indexer = $target
          ->getIndexer('class');
        if ($indexer
          ->has($entity_type['controller class'])) {
          $controller = $indexer
            ->get($entity_type['controller class']);
          $parent = $controller
            ->getExtends();
          if ($parent) {
            if ($parent
              ->getText() == 'DrupalDefaultEntityController' || $parent
              ->getText() == 'EntityAPIController') {
              $controller
                ->setExtends('Drupal\\Core\\Entity\\Sql\\SqlContentEntityStorage');
            }
            else {

              // @todo Not entirely sure what to do here. It's not a huge problem
              // if the controller extends another class defined by the target
              // (which is, admittedly, an edge case), but if it extends a
              // controller defined by *another* module that isn't Entity API?
            }
          }

          // @todo Handle interfaces implemented by the entity controller.
          $this
            ->writeClass($target, PSR4::toPSR4($target, $controller));
          $entity_type['controllers']['storage'] = $controller
            ->getName()
            ->getAbsolutePath();
        }
        else {
          throw new \LogicException((new FormattableMarkup('Cannot get ahold of the controller class for @entity_type entity type.', [
            '@entity_type' => $id,
          ]))
            ->__toString());
        }
      }
      else {
        $entity_type['controllers']['storage'] = 'Drupal\\Core\\Entity\\Sql\\SqlContentEntityStorage';
      }
      $render = [
        '#module' => $target
          ->id(),
        '#class' => $this
          ->toTitleCase($id),
        '#theme' => 'dmu_entity_type',
        '#info' => $entity_type,
      ];
      $this
        ->writeClass($target, $this
        ->parse($render));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConverterBase::buildFixMe protected function Builds a FIXME notice using either the text in the plugin definition, or passed-in text.
ConverterBase::DOC_COMMENT constant
ConverterBase::executeHook protected function Executes the target module's implementation of the specified hook, and returns the result.
ConverterBase::implement protected function Creates an empty implementation of a hook.
ConverterBase::isExecutable public function Returns if this conversion applies to the target module. If FALSE, the convert() method will not be called. Overrides ConverterInterface::isExecutable 4
ConverterBase::LINE_COMMENT constant
ConverterBase::parse protected function Parses a generated class into a syntax tree.
ConverterBase::rewriteFunction protected function Parametrically rewrites a function.
ConverterBase::write public function Writes a file to the target module's directory.
ConverterBase::writeClass public function Writes a class to the target module's PSR-4 root.
ConverterBase::writeInfo protected function Writes out arbitrary data in YAML format.
ConverterBase::writeService protected function Writes a service definition to the target module's services.yml file.
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
HookEntityInfo::convert public function Performs required conversions. Overrides ConverterInterface::convert
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
StringTransformTrait::deleteLegacyWildcards public function Deletes %wildcards from a route path.
StringTransformTrait::deleteWildcards public function Deletes {wildcards} from a route path.
StringTransformTrait::getIdentifier public function Generates an identifier (prefixed with the module name, if $this->module exists) from an arbitrary string.
StringTransformTrait::getIdentifierFromLegacyPath public function Generates an identifier from a Drupal 7 path.
StringTransformTrait::getIdentifierFromPath public function Generates an identifier from a path.
StringTransformTrait::toCamelCase public function Converts a string toCamelCase :)
StringTransformTrait::toTitleCase public function Converts a string ToTitleCase.
StringTransformTrait::unPrefix public function Trims a prefix (as well as leading or trailing underscore, if any) from a string.
StringTransformTrait::unSuffix public function Trims a suffix (as well as leading underscore, if any) from a string.
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.