class PatternFormatter in UI Patterns 8

Plugin implementation of the 'paragraph' formatter.

Plugin annotation


@FieldGroupFormatter(
  id = "pattern_formatter",
  label = @Translation("Pattern"),
  description = @Translation("Wrap fields as a pattern."),
  supported_contexts = {
    "view",
  }
)

Hierarchy

class \Drupal\ui_patterns_field_group\Plugin\field_group\FieldGroupFormatter\PatternFormatter extends \Drupal\field_group\FieldGroupFormatterBase implements ContainerFactoryPluginInterface uses PatternDisplayFormTrait

Expanded class hierarchy of PatternFormatter

File

modules/ui_patterns_field_group/src/Plugin/field_group/FieldGroupFormatter/PatternFormatter.php, line 26

Namespace

Drupal\ui_patterns_field_group\Plugin\field_group\FieldGroupFormatter

View source

class PatternFormatter extends FieldGroupFormatterBase implements ContainerFactoryPluginInterface {
  use PatternDisplayFormTrait;

  /**
   * Module Handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler = NULL;

  /**
   * UI Patterns manager.
   *
   * @var \Drupal\ui_patterns\UiPatternsManager
   */
  protected $patternsManager;

  /**
   * UI Patterns manager.
   *
   * @var \Drupal\ui_patterns\UiPatternsSourceManager
   */
  protected $sourceManager;

  /**
   * Entity finder utility.
   *
   * @var \Drupal\ui_patterns_field_group\Utility\EntityFinder
   */
  protected $entityFinder;

  /**
   * Constructs a Drupal\Component\Plugin\PluginBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\ui_patterns\UiPatternsManager $patterns_manager
   *   UI Patterns manager.
   * @param \Drupal\ui_patterns\UiPatternsSourceManager $source_manager
   *   UI Patterns source manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   Module handler.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, UiPatternsManager $patterns_manager, UiPatternsSourceManager $source_manager, ModuleHandlerInterface $module_handler) {
    parent::__construct($plugin_id, $plugin_definition, $configuration['group'], $configuration['settings'], $configuration['label']);
    $this->configuration = $configuration;
    $this->patternsManager = $patterns_manager;
    $this->sourceManager = $source_manager;
    $this->entityFinder = new EntityFinder();
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.ui_patterns'), $container
      ->get('plugin.manager.ui_patterns_source'), $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function preRender(&$element, $rendering_object) {
    $fields = [];
    $mapping = $this
      ->getSetting('pattern_mapping');
    foreach ($mapping as $field) {
      $fields[$field['destination']][] = $element[$field['source']];
    }
    $element['#type'] = 'pattern';
    $element['#id'] = $this
      ->getSetting('pattern');
    $element['#fields'] = $fields;
    $element['#multiple_sources'] = TRUE;
    $element['#variant'] = $this
      ->getSetting('pattern_variant');

    // Allow default context values to not override those exposed elsewhere.
    $element['#context']['type'] = 'field_group';
    $element['#context']['group_name'] = $this->configuration['group']->group_name;
    $element['#context']['entity_type'] = $this->configuration['group']->entity_type;
    $element['#context']['bundle'] = $this->configuration['group']->bundle;
    $element['#context']['view_mode'] = $this->configuration['group']->mode;

    // Pass current entity to pattern context, if any.
    $element['#context']['entity'] = $this->entityFinder
      ->findEntityFromFields($element['#fields']);
  }

  /**
   * Get field group name.
   *
   * @return string
   *   Field group name.
   */
  protected function getFieldGroupName() {
    return $this->configuration['group']->group_name;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm() {
    $form = parent::settingsForm();
    unset($form['id']);
    unset($form['classes']);
    if (isset($this->configuration['group']->children) && !empty($this->configuration['group']->children)) {
      $context = [
        'entity_type' => $this->configuration['group']->entity_type,
        'entity_bundle' => $this->configuration['group']->bundle,
        'limit' => $this->configuration['group']->children,
      ];
      $this
        ->buildPatternDisplayForm($form, 'entity_display', $context, $this->configuration['settings']);
    }
    else {
      $form['message'] = [
        '#markup' => $this
          ->t('<b>Attention:</b> you have to add fields to this field group and save the whole entity display before being able to to access the pattern display configuration.'),
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $label = $this
      ->t('None');
    if (!empty($this
      ->getSetting('pattern'))) {
      $label = $this->patternsManager
        ->getDefinition($this
        ->getSetting('pattern'))
        ->getLabel();
    }
    return [
      $this
        ->t('Pattern: @pattern', [
        '@pattern' => $label,
      ]),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultContextSettings($context) {
    return [
      'pattern' => '',
      'pattern_mapping' => [],
      'pattern_variant' => '',
    ] + parent::defaultContextSettings($context);
  }

}

Members

Name	Modifiers	Type	Description
PatternDisplayFormTrait::buildPatternDisplayForm	public	function	Build pattern display form.
PatternDisplayFormTrait::getDefaultValue	protected	function	Helper function: get default value.
PatternDisplayFormTrait::getMappingDestination	public	function	Helper function: return mapping destination given plugin id and field name.
PatternDisplayFormTrait::getMappingForm	public	function	Get mapping form.
PatternDisplayFormTrait::hasMappingDestination	public	function	Helper function: check if given source field has mapping destination.
PatternDisplayFormTrait::processFormStateValues	public static	function	Normalize settings coming from a form submission.
PatternFormatter::$entityFinder	protected	property	Entity finder utility.
PatternFormatter::$moduleHandler	protected	property	Module Handler.
PatternFormatter::$patternsManager	protected	property	UI Patterns manager.
PatternFormatter::$sourceManager	protected	property	UI Patterns manager.
PatternFormatter::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PatternFormatter::defaultContextSettings	public static	function
PatternFormatter::getFieldGroupName	protected	function	Get field group name.
PatternFormatter::preRender	public	function
PatternFormatter::settingsForm	public	function
PatternFormatter::settingsSummary	public	function
PatternFormatter::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.

You are here

class PatternFormatter in UI Patterns 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation