class DsFieldTemplateSource in UI Patterns 8

Defines Display Suite field template source plugin.

Plugin annotation

@UiPatternsSource(
  id = "ds_field_template",
  label = @Translation("Field template"),
  provider = "ds",
  tags = {
    "ds_field_template"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\ui_patterns\Plugin\PatternSourceBase implements ConfigurableInterface, PluginInspectionInterface, PatternSourceInterface uses StringTranslationTrait
    • class \Drupal\ui_patterns_ds\Plugin\UiPatterns\Source\DsFieldTemplateSource implements ContainerFactoryPluginInterface

File

modules/ui_patterns_ds/src/Plugin/UiPatterns/Source/DsFieldTemplateSource.php, line 22

Namespace

Drupal\ui_patterns_ds\Plugin\UiPatterns\Source

class DsFieldTemplateSource extends PatternSourceBase implements ContainerFactoryPluginInterface {

  /**
   * Entity field manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManager
   */
  protected $fieldManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityFieldManager $field_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->fieldManager = $field_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getSourceFields() {
    $sources = [];
    $field_name = $this
      ->getContextProperty('field_name');
    $entity_type = $this
      ->getContextProperty('entity_type');
    $bundle = $this
      ->getContextProperty('bundle');

    /** @var \Drupal\field\Entity\FieldConfig $field */
    $field = $this->fieldManager
      ->getFieldDefinitions($entity_type, $bundle)[$field_name];
    $label = $field
      ->getLabel();
    $sources[] = $this
      ->getSourceField($field_name, $label);
    foreach ($field
      ->getFieldStorageDefinition()
      ->getColumns() as $column_name => $column) {
      $sources[] = $this
        ->getSourceField($field_name . '__' . $column_name, $label . ': ' . $column_name);
    }
    return $sources;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DsFieldTemplateSource::$fieldManager	protected	property	Entity field manager service.
DsFieldTemplateSource::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DsFieldTemplateSource::getSourceFields	public	function	Return list of source fields. Overrides PatternSourceInterface::getSourceFields
DsFieldTemplateSource::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
PatternSourceBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
PatternSourceBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PatternSourceBase::getContextProperty	public	function	Get context property value, if any. Overrides PatternSourceInterface::getContextProperty
PatternSourceBase::getSourceField	public	function	Source field factory method. Overrides PatternSourceInterface::getSourceField
PatternSourceBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
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.
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.