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

Plugin annotation

@Converter(
 id = "hook_field_formatter_info",
 description = @Translation("Creates formatter class templates from hook_field_formatter_info()."),
 hook = "hook_field_formatter_info"
)

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\ConverterBase implements ConverterInterface
        • class \Drupal\drupalmoduleupgrader\Plugin\DMU\Converter\HookFieldFormatterInfo uses StringTransformTrait

File

src/Plugin/DMU/Converter/HookFieldFormatterInfo.php, line 16

Namespace

Drupal\drupalmoduleupgrader\Plugin\DMU\Converter

class HookFieldFormatterInfo extends ConverterBase {
  use StringTransformTrait;

  /**
   * {@inheritdoc}
   */
  public function convert(TargetInterface $target) {
    try {
      $formatters = $this
        ->executeHook($target, $this->pluginDefinition['hook']);
    } catch (\LogicException $e) {
      $this->log
        ->warning($e
        ->getMessage(), [
        'target' => $target
          ->id(),
        'hook' => $this->pluginDefinition['hook'],
      ]);
      return;
    }
    foreach ($formatters as $id => $formatter) {
      $render = [
        '#module' => $target
          ->id(),
        '#class' => $this
          ->toTitleCase($id),
        '#theme' => 'dmu_formatter',
        '#info' => [
          'id' => $id,
          'label' => $formatter['label'],
          'description' => $formatter['description'] ?: NULL,
          'field_types' => $formatter['field types'],
        ],
      ];
      $this
        ->writeClass($target, $this
        ->parse($render));
    }
  }

}

Members

Name	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
HookFieldFormatterInfo::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.