interface LogTemplateManagerInterface in Commerce Core 8.2

Defines the interface for commerce_log_template plugin managers.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface; interface \Drupal\Component\Plugin\Factory\FactoryInterface; interface \Drupal\Component\Plugin\Mapper\MapperInterface
  • interface \Drupal\Component\Plugin\PluginManagerInterface
    • interface \Drupal\commerce_log\LogTemplateManagerInterface

3 files declare their use of LogTemplateManagerInterface

AdminCommentForm.php in modules/log/src/Plugin/views/area/AdminCommentForm.php

LogCommentForm.php in modules/log/src/Form/LogCommentForm.php

OrderMailEventSubscriber.php in modules/log/src/EventSubscriber/OrderMailEventSubscriber.php

File

modules/log/src/LogTemplateManagerInterface.php, line 10

Namespace

Drupal\commerce_log

interface LogTemplateManagerInterface extends PluginManagerInterface {

  /**
   * Gets the log template labels grouped by category.
   *
   * @param string $entity_type_id
   *   (optional) The entity type ID to filter by. If provided, only
   *   log templates that belong to categories with the specified entity
   *   type will be returned.
   *
   * @return array
   *   Keys are category labels, and values are arrays of which the keys are
   *   log template IDs and the values are log template labels.
   */
  public function getLabelsByCategory($entity_type_id = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
DiscoveryInterface::getDefinition	public	function	Gets a specific plugin definition.	4
DiscoveryInterface::getDefinitions	public	function	Gets the definition of all plugins for this type.	3
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
FactoryInterface::createInstance	public	function	Creates a pre-configured instance of a plugin.	7
LogTemplateManagerInterface::getLabelsByCategory	public	function	Gets the log template labels grouped by category.	1
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	4