class FieldPropertiesSource in UI Patterns Field Formatters 8

Defines Field values source plugin.

Plugin annotation

@UiPatternsSource(
  id = "field_properties",
  label = @Translation("Field properties"),
  tags = {
    "field_properties"
  }
)

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_field_formatters\Plugin\UiPatterns\Source\FieldPropertiesSource

File

src/Plugin/UiPatterns/Source/FieldPropertiesSource.php, line 18

Namespace

Drupal\ui_patterns_field_formatters\Plugin\UiPatterns\Source

class FieldPropertiesSource extends PatternSourceBase {

  /**
   * {@inheritdoc}
   */
  public function getSourceFields() {
    $sources = [];
    $storageDefinition = $this
      ->getContextProperty('storageDefinition');
    $fields = $storageDefinition
      ->getPropertyNames();
    foreach ($fields as $field) {
      if (!$this
        ->getContextProperty('limit')) {
        $sources[] = $this
          ->getSourceField($field, $storageDefinition
          ->getPropertyDefinition($field)
          ->getLabel());
      }
      elseif (in_array($field, $this
        ->getContextProperty('limit'))) {
        $sources[] = $this
          ->getSourceField($field, $storageDefinition
          ->getPropertyDefinition($field)
          ->getLabel());
      }
    }
    return $sources;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FieldPropertiesSource::getSourceFields	public	function	Return list of source fields. Overrides PatternSourceInterface::getSourceFields
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.