class EntityRestrictedField in Organic groups 8

A test field that can be attached only to the node entity.

Plugin annotation

@OgFields(
 id = "entity_restricted",
 type = "group",
 description = @Translation("A test field that can be attached only to the node entity.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\og\OgFieldBase implements OgFieldsInterface
      • class \Drupal\og_test\Plugin\OgFields\EntityRestrictedField implements OgFieldsInterface

File

tests/modules/og_test/src/Plugin/OgFields/EntityRestrictedField.php, line 19

Namespace

Drupal\og_test\Plugin\OgFields

class EntityRestrictedField extends OgFieldBase implements OgFieldsInterface {

  /**
   * {@inheritdoc}
   */
  public function getFieldStorageBaseDefinition(array $values = []) {
    $values = [
      // Restrict the allowed entities.
      'entity' => [
        'node',
      ],
      'type' => 'list_integer',
    ];
    return parent::getFieldStorageBaseDefinition($values);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormDisplayDefinition(array $values = []) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getViewDisplayDefinition(array $values = []) {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityRestrictedField::getFieldStorageBaseDefinition	public	function	Get the field storage config base definition. Overrides OgFieldBase::getFieldStorageBaseDefinition
EntityRestrictedField::getFormDisplayDefinition	public	function	Get the field's form display definition. Overrides OgFieldsInterface::getFormDisplayDefinition
EntityRestrictedField::getViewDisplayDefinition	public	function	Get the field's view modes definition. Overrides OgFieldsInterface::getViewDisplayDefinition
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OgFieldBase::$bundle	protected	property	The entity bundle.
OgFieldBase::$entityType	protected	property	The entity type.
OgFieldBase::$fieldName	protected	property	The field name.
OgFieldBase::getBundle	public	function	Get the bundle name. Overrides OgFieldsInterface::getBundle
OgFieldBase::getEntityType	public	function	Get the entity type name. Overrides OgFieldsInterface::getEntityType
OgFieldBase::getFieldBaseDefinition	public	function	Get the field config base definition. Overrides OgFieldsInterface::getFieldBaseDefinition	2
OgFieldBase::getFieldName	public	function	Get the field name. Overrides OgFieldsInterface::getFieldName
OgFieldBase::setBundle	public	function	Set the bundle. Overrides OgFieldsInterface::setBundle
OgFieldBase::setEntityType	public	function	Set the entity type. Overrides OgFieldsInterface::setEntityType
OgFieldBase::setFieldName	public	function	Set the field name. Overrides OgFieldsInterface::setFieldName
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.